interface: interessados
https://api.kaits.com.br/interessados/
envio via método POST
formato JSON
parâmetros
- constante = "cadastro"
- API token da escola
- JSON contendo, na seguinte estrutura, apenas os campos a serem gravados ou alterados:
- nome do interessado
- e-mail do interessado (válido)
- RG do interessado
- órgão emissor do RG do interessado
- CPF do interessado (válido)
- CNH (carteira nacional de habilitação) do interessado
- categoria da CNH do interessado (será ignorada se não for informada a CNH)
- data de nascimento do interessado (dd/mm/aaaa)
- observação do cadastro do interessado
- telefone pessoal do interessado
- telefone celular do interessado
- endereço: nome da rua
- endereço: número
- endereço: complemento
- endereço: nome do bairro
- endereço: nome da cidade (se não existir ainda, será criada no Sistema KAITS)
- endereço: estado (UF) com dois dígitos (se não for informado, a cidade não será considerada)
- endereço: CEP
- nacionalidade do interessado
- ID (numérico) do estado civil:
1. solteiro
2. casado ou em união estável
3. divorciado ou separado
4. viúvo
- ID (numérico) de "formas de nos conhecer" em "tabelas auxiliares" no Sistema KAITS (recuperado pela acao "comoConheceu" descrita abaixo)
- ID (numérico) se já tiver o ID da turma (buscada pela API de cursos) não serão considerados o nome do curso, do estágio e da turma
- nome do curso de interesse (se não existir ainda, será criado no Sistema KAITS)
- nome do estágio de interesse (se não existir ainda, será criado no Sistema KAITS)
- nome da turma de interesse (se não existir ainda, será criada no Sistema KAITS)
- texto com os períodos e/ou horários de interesse
- ID (numérico) de "localidades de interesse" em "tabelas auxiliares" no Sistema KAITS (recuperado pela acao "localidades" descrita abaixo)
- ID (numérico) de "tipo de interesse" em "tabelas auxiliares" no Sistema KAITS (recuperado pela acao "tipos" descrita abaixo)
- string com os dias de interesse separados por vírgula, sendo 1 para domingo, 2 para segunda e assim por diante até 7 para sábado
- ID (numérico) de idioma no qual a escola tenha curso cadastrado no Sistema KAITS (recuperado pela acao "idiomas" descrita abaixo)
- texto com a observação sobre o interesse
- objeto com os dados do responsável do interessado
- nome do responsável (obrigatório)
- email do responsável
- DDI do telefone
- DDD do telefone
- telefone celular do responsável
retorno
- sucesso da gravação (bit: "0" ou "1")
- mensagem de erro (se sucesso = 0)
- identificador do interessado no Sistema KAITS
teste
retorno original
retorno objeto
parâmetros
- constante = "buscaInteressados"
- API token da escola
- um objeto com os filtros opcionais abaixo:
- parte do nome, codinome ou registro do interessado
- número do CPF do interessado
- número do RG do interessado
- parte do e-mail do interessado
retorno
- sucesso da consulta (bit: "0" ou "1")
- mensagem de erro (se sucesso = 0)
- uma lista com os interessados de acordo com os filtros com os seguintes campos:
- identificador do interessados no Sistema KAITS
- nome do interessado
- codinome (nome social) do interessado
- registro do interessado
- CPF do interessado
- RG do interessado
- e-mail do interessado
teste
retorno original
retorno objeto
parâmetros
- constante = "comoConheceu"
- API token da escola
retorno
- sucesso da consulta (bit: "0" ou "1")
- mensagem de erro (se sucesso = 0)
- uma lista ordenada com as possíveis formas de "como nos conheceu" da escola. Cada forma contém as chaves:
- identificador da forma (para ser enviado no cadastro)
- texto a ser exibido ao usuário
teste
retorno original
retorno objeto
parâmetros
- constante = "localidades"
- API token da escola
retorno
- sucesso da consulta (bit: "0" ou "1")
- mensagem de erro (se sucesso = 0)
- uma lista ordenada com as localidades cadastradas pela escola. Cada localidade contém as chaves:
- identificador da localidade (para ser enviado no cadastro)
- nome atualizado da localidade cadastrada pela escola
teste
retorno original
retorno objeto
parâmetros
- constante = "tipos"
- API token da escola
retorno
- sucesso da consulta (bit: "0" ou "1")
- mensagem de erro (se sucesso = 0)
- uma lista ordenada com os tipos de interesse cadastrados pela escola. Cada tipo contém as chaves:
- identificador do tipo (para ser enviado no cadastro)
- nome atualizado do tipo cadastrado pela escola
teste
retorno original
retorno objeto
parâmetros
- constante = "idiomas"
- API token da escola
retorno
- sucesso da consulta (bit: "0" ou "1")
- mensagem de erro (se sucesso = 0)
- uma lista ordenada com os idiomas nos quais a escola tenha cursos cadastrados. Cada idioma contém as chaves:
- identificador do idioma (para ser enviado no cadastro)
- nome atualizado do idioma cadastrado pela escola
teste
retorno original
retorno objeto
parâmetros
- constante = "cidades"
- API token da escola
- filtro de parte do nome da cidade (opcional)
retorno
- sucesso da consulta (bit: "0" ou "1")
- mensagem de erro (se sucesso = 0)
- uma lista ordenada com as cidades cadastradas pela escola. Cada cidade contém as chaves:
- identificador da cidade (para ser enviado nos endereços)
- nome da cidade
- UF (estado) da cidade
- país da cidade
- código da cidade no IBGE (se existir)
teste
retorno original
retorno objeto
parâmetros
- constante = "ibge"
- API token da escola
- sigla do estado para a busca de cidades (obrigatório)
- filtro de parte do nome da cidade (opcional)
retorno
- sucesso da consulta (bit: "0" ou "1")
- mensagem de erro (se sucesso = 0)
- uma lista ordenada com as cidades informadas pelo IBGE. Cada cidade contém as chaves:
- nome da cidade
- código da cidade no IBGE
teste
retorno original
retorno objeto
parâmetros
- constante = "novaCidade"
- API token da escola
- código da cidade no IBGE (obrigatório)
retorno
- sucesso da inclusão (bit: "0" ou "1")
- mensagem de erro (se sucesso = 0)
- identificador da cidade (para ser enviado nos endereços)
- nome da cidade
- UF (estado) da cidade
- país da cidade
- código da cidade no IBGE
- retorna TRUE se a cidade já estava cadastrada na escola anteriormente
(neste caso não é duplicada a cidade, mas retorna a anteriormente cadastrada)
teste
retorno original
retorno objeto