Documentação Web Service CNCA
Documentação do Web Service do CNCA
Sumário
Web Service CNCA .............................................................................................................3
Descrição dos métodos disponíveis ....................................................................................4
salvarGuiaAcolhimento(listaGuia) ....................................................................................4
salvarAcolhido(listaAcolhido) ...........................................................................................4
salvarEntidade (listaEntidade)..........................................................................................4
salvarInexistencia (listaInexistencia) ................................................................................4
Salvarguiadesligamento (listaGuia)..................................................................................5
Recomendações do uso do Web Service ............................................................................5
Credenciais de acesso ao Web Service ..............................................................................5
Reportar problemas encontrados, dúvidas e solicitação de credencial ...............................5
Guia de Acolhimento............................................................................................................6
Acolhido .............................................................................................................................10
Entidade de acolhimento ...................................................................................................14
Inexistência........................................................................................................................17
Guia de desligamento ........................................................................................................17
2
Documentação do Web Service do CNCA
Web Service CNCA
Documentação referente ao Web Service para atualização das guias de
acolhimento e cadastro de acolhidos na base de dados do Cadastro Nacional de Crianças
Acolhidas – CNCA.
O web service utilizará como parâmetros um xml contendo em cada nó os dados
que serão atualizados.
WSDL:
http://201.49.148.183/cnca/ws/cnca.wsdl
salvarGuiaAcolhimento(listaGuia)
salvarAcolhido (listaAcolhido)
Protocolo: SOAP
Argumentos
listaGuia - XML
Retorno
XML – contendo os seguintes nós:
Id_guia – Número da guia gerada
ou atualizada.
Nome – Nome da criança
Id_criança – Código da criança que
foi inserida ou atualizada.
Argumentos
listaAcolhido – XML
Retorno
XML – contendo os seguintes nós:
Id_guia – Número da guia do
acolhido.
Nome – Nome da criança
Id_criança – Código da criança
que foi inserida ou atualizada.
Argumentos
listaAcolhido
– XML
Retorno
salvarEntidade (listaEntidade)
XML – contendo os seguintes nós:
Id_abrigo – Código da entidade
cadastrada ou atualizada
razao_social – Razão social da
entidade.
Argumentos
listaAcolhido
– XML
Retorno
salvarInexistencia (listaInexistencia)
XML – contendo os seguintes nós:
Id_inexistencia – Número da
inexistência
cadastrada
ou
atualizada.
seq_orgao – Código do órgão que
3
Documentação do Web Service do CNCA
informou a inexistência
Argumentos
listaAcolhido
XML
Retorno
salvarGuiaDesligamento (listaGuia)
XML – contendo os seguintes nós:
Id_guia – Número da guia do
acolhido.
Nome – Nome da criança
Id_criança – Código da criança
que foi desligada ou atualizada.
Descrição dos métodos disponíveis
Cada método é responsável por obter os dados do XML e atualizar os registros.
Caso exista algum erro o mesmo irá disparar um exception informando qual campo está
com o valor incorreto, faltante ou algum erro ocorrido.
salvarGuiaAcolhimento(listaGuia)
Esse método é responsável pela atualização ou criação dos registros das guias de
acolhimento e atualização dos dados básicos do acolhido. Se não existir o cadastro do
acolhido o mesmo será criado.
salvarAcolhido(listaAcolhido)
Método responsável pela atualização dos dados dos acolhidos, o mesmo nunca irá
criar um novo acolhido, pois esse cadastro só poderá ser realizado mediante a uma guia
de acolhimento.
salvarEntidade (listaEntidade)
Método responsável pela atualização ou criação dos cadastros das entidades de
acolhimento.
salvarInexistencia (listaInexistencia)
Método responsável por atualizar ou cadastrar a inexistência de crianças e
entidades de acolhimento. Antes de realizar o cadastro o método irá verificar se existem
crianças e/ou entidades de acolhimento para a vara que está realizando o cadastro.
4
Documentação do Web Service do CNCA
Salvarguiadesligamento (listaGuia)
Esse método é responsável pela atualização ou criação dos registros das guias de
desligamento. O cadastro do acolhido é atualizado e o recebe o status de desacolhido,
saindo da listagem de crianças acolhidas.
Recomendações do uso do Web Service
O padrão de envio do XML deve estar de acordo com o padrão acordado para
importação de dados. Caso seja enviado algum XML fora do padrão recomendando o
Web Service retornará um exception do tipo SoapFault informando o problema
encontrado.
Observações:
•
A codificação do XML enviado deve ser UTF-8, caso contrário problemas com
acentuação e caracteres especiais pode ocorrer;
• É recomendado que os estados implementem um sistema de log próprio que
mantenha as ocorrências de inserções problemáticas para que estes dados sejam
corrigidos e enviados futuramente;
Credenciais de acesso ao Web Service
Será fornecida uma credencial de acesso ao Web Service para cada estado. Esta
credencial é composta por:
Usuário – Um nome de usuário que por convenção será a sigla do estado.
Senha – Uma senha alfa numérica que será utilizada pelo estado.
Esta credencial será utilizada no método de autenticação.
Reportar problemas encontrados, dúvidas e solicitação de credencial
Para reportar algum tipo de problema encontrado durante a implementação, sanar
alguma dúvida ou solicitar credencial, favor entrar em contato através dos dados abaixo:
CNCA
[email protected]
Edson Pereira de Andrade
[email protected]
Guilherme Carvalho da Silva
[email protected]
Telefone: (61) 2326-5320
5
Documentação do Web Service do CNCA
Guia de Acolhimento
Guia de Acolhimento
Atributo
Descrição
nome_crianca
Id único da guia de acolhimento, numeração que
compõem os 5 últimos números da guia.
Caso o número da guia não possuía 5 dígitos, é
completado com 0 à esquerda.
Campo referente ao nome do acolhido.
sexo_crianca
Campo referente ao sexo da Criança.
dtnasc_crianca
Data de nascimento da criança
seq_guia_acolhimento
Tipo de dados
Exemplo de preenchimento
"Pedro da Silva"
Obrigatório
Somente se a guia já
existir é obrigatório
informar essa
numeração.
SIM
"M" ou "F"
SIM
12345
00123
inteiro
string
string com apenas
um caráter
12/12/2000
string
idadepresumida_crianca
Número que representa a idade presumida da
criança
idadepresumida_crianca_periodo
Período referente à idade presumida da criança
mae_crianca
pai_crianca
responsavel_crianca
end_responsavel_crianca
rua_responsavel
num_rua_responsavel
cep_responsavel
bairro_responsavel
Nome da mãe do acolhido
Nome do pai do acolhido
Nome do responsável do acolhido
Endereço do responsável do acolhido
Complemento do campo endereço, o campo rua
Complemento do campo endereço, o número da rua
Complemento do campo endereço, o campo cep
Complemento do campo endereço, o campo bairro
Complemento do campo endereço, campo ponto de
referência
Telefone do responsável
Celular do responsável
Nome da entidade de acolhimento que acolheu a
criança
Data de acolhimento da criança
ref_responsavel
fone_responsavel
cel_responsavel
local_acolhimento
data_acolhimento
Inteiro de dois
dígitos
99
"Marlene da silva"
"José da Silva"
"Pedro da Silva"
"Quadra x conj y casa z"
"MACHADO"
"12"
"72.302-404"
"CENTRO"
Se não existir data de
nascimento o campo é
obrigatório.
SIM
NÃO
NÃO
NÃO
NÃO
NÃO
NÃO
NÃO
"Mercearia do seu José"
NÃO
(61) 3357-2569
(61) 8156-6895
NÃO
NÃO
Casa menino José
SIM
12/12/2000
SIM
"ano(s)" ou "mês(es)"
string
string
string
string
string
string
string
string
string
string
string
string
string
string
Se não existir idade
presumida o campo é
obrigatório.
Se não existir data de
nascimento o campo é
obrigatório.
6
Documentação do Web Service do CNCA
hora_acolhimento
Hora do acolhimento
intre_grup_irmao
A criança possui irmãos?
qtos_irmaos
algum_irmao_acolhido
locais_acolhimento_irmaos
recebido_por
possui_documentacao
Caso a resposta anterior seja sim, quantos irmãos o
acolhido possui?
Caso a criança possuir irmão, informa se existe
algum irmão acolhido também.
Se possuir um irmão acolhido, informar qual a
entidade que o irmão está abrigado.
Nome da pessoa que recebeu as crianças na
entidade de acolhimento
Informa se a criança possui algum tipo de
documentação
dnv
Declaração de nascido vivo
cert_nasc
bo
cart_ident
cart_vacina
atend_medico
creche
escola
Certidão de nascimento
Boletim de ocorrência
Carteira de identidade
Cartão de vacina
Atendimento médico
Documento de alguma creche
Documento de alguma escola
Outros documentos que não foram listados
anteriormente.
outros
faz_uso_medicamentos
A criança faz usos de algum medicamento?
quais_medicamentos
Se possuir uso de medicamento, quais
medicamentos são esses?
motivo_acolhimento
Motivo da retirada ou da não reintegração ao
convívio familiar
nome_solicitante
funcao_solicitante
Nome do solicitante do acolhimento institucional ou
familiar
Função do solicitante do acolhimento institucional
ou familiar
string
"15:00"
NÃO
string com apenas
um caráter
inteiro com dois
caracteres
string com apenas
1 caráter
"S", "N" ou "I"
SIM
99
NÃO
"S" ou "N"
NÃO
"Casa menino machado"
NÃO
Maria de Paula
NÃO
"S" ou "N"
NÃO
string
string
string com apenas
1 caráter
string
string
string
string
string
string
string
string
string
string com apenas
1 caráter
string
string
string
string
Nascido com 295gr no hospital
XXX as XX:XX
00-56
548
2.365.698
36584
Cardiologia
mat. 2006478
histórico escolar
outro documento
NÃO
NÃO
NÃO
NÃO
NÃO
NÃO
NÃO
NÃO
NÃO
"S" ou "N"
"ibuprofeno"
NÃO
"FURTO DE PESSOAS DA
COMUNIDADE E RISCO DE
VIDA"
SIM
"José da Silva"
SIM
"Atendente"
SIM
7
Documentação do Web Service do CNCA
relatorios_anexos_documentos
Telefone do solicitante do acolhimento institucional
ou familiar
Celular do solicitante do acolhimento institucional ou
familiar
Possui documentos e / ou documentos anexados?
anexos_num_folhas
Números de folhas anexadas
tel_solicitante
cel_solicitante
parecer_tecnico
string
string
string
string com até
cinco dígitos
Parecer técnico
"(99) 9999-9999"
SIM
"(99) 9999-9999"
NÃO
"S" ou "N"
SIM
99999
NÃO
"AVALIÇÃO DO CONSELHO
TUTELAR SOBRE A IDA DA
CRIANÇA PARA O CONVIVIO
JUNTO AO GENITOR NO
MUNICÍPIO DE CAMPOS"
Se possuir parecer, o
campo é obrigatório
string
responsavel_tecnico
Responsável pelo parecer
mat_tecnico
relatorios_anexos_tecnico
Matricula do técnico
Possui relatórios e/ou documentos anexados?
tecnico_num_folhas
Números de folhas anexadas
parecer_juiz
string
string
string
inteiro com até
cinco dígitos
Despacho do juiz
99
"S" ou "N"
Se possuir parecer, o
campo é obrigatório
NÃO
SIM
99999
NÃO
"CONSIDERANDO A
NECESSIDADE DE ABRIGAR
O INFANTE BEM COMO
APLICAR OUTRAS MEDIDAS
PROTETIVAS DETERMINO:
REGISTRE-SE E AUTUE-SE
COMO PROCEDIMENTO DE
OFICIO- ART 153 ECA"
SIM
99
SIM
999
SIM
999
SIM
1 ou 0
SIM
Se não existir a criança,
o sistema gera
automaticamente.
"José da Silva"
string
possui_parecer
Código do tribunal conforme documentação de
códigos para geração das tabelas "De" "Para"
Código da comarca conforme documentação de
códigos para geração das tabelas "De" "Para"
Código da vara conforme documentação de códigos
para geração das tabelas "De" "Para"
Possui parecer técnico?
id_pessoa
Código único da criança no sistema.
seq_tribunal
seq_comarca
seq_vara
inteiro
inteiro
inteiro
inteiro
999
inteiro
8
Documentação do Web Service do CNCA
id_estado
id_cidade
num_processo
medidas_crianca
medidas_familia
observacao
Código do estado conforme documentação de
códigos para geração das tabelas "De" "Para"
Código da cidade conforme documentação de
códigos para geração das tabelas "De" "Para"
Número do processo
Array com os id_medida conforme documentação
de códigos para geração das tabelas "De" "Para"
Array com os id_medida conforme documentação
de códigos para geração das tabelas "De" "Para"
Campo para se adicionar alguma informação na
guia.
inteiro
inteiro
string
array
array
Text
99
SIM
9999
SIM
NÃO
000-2
(5, 4, 39)
NÃO
(5, 4, 39)
NÃO
‘Criança foi alterado de
entidade’
"nome_interessado" =>
"Fulano",
NÃO
"rua_interessado"
=> "Rua 32",
"numero_end_interessado" =>
"casa 6",
"bairro_interessado"
=> "centro",
interessados
Array contendo os dados referentes aos
interessados em adoção. Cada índice do array
compõem um campo que será armazenado.
array
"apto_interessado"
=> "101",
NÃO
"edf_interessado"
=> "Marrogany",
"ref_interessado"
=> "Padaria do seu zé",
"fone_interessado"
=> "(61)3216-5454",
"cel_interessado"
=> "(61)3695-6598"
9
Documentação do Web Service do CNCA
Acolhido
Acolhido
Atributo
id_pessoa
nome
sexo
id_estado_localizacao
num_guia_abrigamento
id_cor
id_nacionalidade
id_estado
certidao
ocorrência_cartorio_orgao
num_registro
livro
folha
pai_situacao
pai_situacao
irmaos
Descrição
id único do cadastro do acolhido
Campo referente ao nome do acolhido.
Campo referente ao sexo da Criança.
Código do estado onde o acolhido se encontra, conforme
documentação de códigos para geração das tabelas “De” “Para”
Número da última guia de acolhimento do acolhido
Código da cor do acolhido, conforme documentação de códigos
para a geração das tabelas “De” “Para”
Código da nacionalidade do acolhido, conforme documentação
de códigos para a geração das tabelas “De” “Para”
Código do estado, conforme documentação de códigos para
geração das tabelas “De” “Para”
Campo referente se o acolhido possui ou não certidado de
nascimento
Nome da circunscrição responsável
Número do registro da certidão de nascimento
Número do livro da certidão de nascimento
Número da folha da certidão de nascimento
Situação em que o pai se encontra, as opções são
Desconhecido ou Falecido
Situação em que a mãe se encontra, as opções são
Desconhecido ou Falecido
Campo que informa se o acolhido possui irmãos.
Tipo de dados
inteiro
String
Exemplo de preenchimento
12345
“Pedro da Silva”
Obrigatório
SIM
SIM
String com apenas um
caráter
“M” ou “F”
SIM
inteiro
string
25
“140041200001”
SIM
SIM
inteiro
5
NÃO
inteiro
5
NÃO
inteiro
5
NÃO
string
string
string
string
string
“S” ou “N”
“Guará”
“1”
“2”
“12”
NÃO
NÃO
NÃO
NÃO
NÃO
string
“D” ou “F”
NÃO
string
String
“D” ou “F”
“S” ou “N”
NÃO
NÃO
10
Documentação do Web Service do CNCA
id_escolaridade
Campo que informa se o acolhido corrênci a escola, as opções
são Sim, Não ou Desconhecido
Caso o acolhido não corrênci a escola, informa a data que
corrência pela última vez
Código da escolaridade, conforme documentação de códigos
para geração das tabelas “De” “Para”
Educacao_especial
Campo que informa se o acolhido necessita de alguma
educação especial
string com apenas um
caráter
“S” ou “N”
NÃO
necessidade_especial
Campo que informa se o acolhido possui alguma necessidade
especial
string com apenas um
caráter
“S” ou “N”
NÃO
necessidade
Campo que informa quais as necessidades o acolhido possui,
conforme documentação de códigos para geração das tabelas
“De” “Para”
array
(4,3,5)
NÃO
tratamento_especial
Campo que informa se o acolhido necessita de algum
tratamento especial
string com apenas um
caráter
“S” ou “N”
NÃO
String com apenas um
caráter
string
“P” ou “T”
“Vive com os pais”
NÃO
NÃO
array
(4,3,5)
NÃO
outras_doencas
Campo que informa qual o tipo de tratamento, caso o acolhido
possua algum. As opções são Permanente ou Temporário.
Informa a situação sócio familiar do acolhido
Campo que informa quais as doenças que o acolhido possui,
conforme documentação de códigos para geração das tabelas
“De” “Para”
Informa se o acolhido possui alguma outra doença que não
esteja previamente cadastrada.
String
“gripe”
NÃO
Irmaos_abrigados
gemeos
oculto
Informa se o acolhido possui algum irmão já abrigado.
Informa se o acolhido possui algum irmão gêmeo.
Informa se o acolhido está sob ameaça de morte
String com apenas 1
caráter
String
string
“S” ou “N”
“S” ou “N”
“S” ou “N”
NÃO
NÃO
NÃO
inteiro
2
NÃO
inteiro
2
NÃO
freq_escola
não_frequenta_escola_tempo
tipo_tratamento_especial
situacao_socio_familiar
doenca
id_situacao_adocao
id_juizado
Campo que informa a situação quanto adoção do acolhido
possui, conforme documentação de códigos para geração das
tabelas “De” “Para”
Campo que informa o id do juizado responsável pelo acolhido,
conforme documentação de códigos para geração das tabelas
“De” “Para”
string
“S”, “N” ou “D”
NÃO
string
25/12/1986
NÃO
inteiro
1
NÃO
11
Documentação do Web Service do CNCA
id_historico
Campo que informa o id da promotoria responsável pelo
acolhido, conforme documentação de códigos para geração das
tabelas “De” “Para”
Campo que informa o id do transito julgado, conforme
documentação de códigos para geração das tabelas “De” “Para”
Array contendo vários array referentes aos abrigamento do
acolhido. Cada índice do array compõe um campo que será
armazenado.
Data do acolhimento ou desligamento
Informa um histórico previamente cadastro para que seja
realizado sua alteração, caso não exista um novo registro será
inserido
id_abrigo
Campo que informa o id do abrigo no qual o acolhido está
acolhido, conforme documentação de códigos para geração das
tabelas “De” “Para”
id_promotoria
id_tipo_transito_julgado
historicoAbrigamento
data
id_orgao_responsavel
guia
medida
ultimo
id_motivo_abrigamento
referenciaFamiliar
Campo que informa o id do órgão responsável pelo
acolhimento, conforme documentação de códigos para geração
das tabelas “De” “Para”
Número da guia do acolhido
Informa o tipo de acolhimento, pode ser Acolhimento ou
Desligamento
Array contendo os id dos motivos pra realizar aquele histórico
Array contendo vários array referentes as referência familiar.
Cada índice do array compõe um campo que será armazenado.
Informa uma referencia familiar previamente cadastro para que
seja realizado sua alteração, caso não exista um novo registro
id_referencia_familiar
será inserido
id_pessoa_relacionamento
Código da pessoa que será relacionada com o acolhido
Campo que informa o id do tipo de relacionamento familiar,
conforme documentação de códigos para geração das tabelas
id_tipo_relacionamento_familiar “De” “Para”
Informa se a referencia familiar é um representante legal da
representante_legal
criança.
visita
Informa se a referencia familiar visita o acolhido.
Campo que informa o id da freqüência da visita, conforme
id_frequencia_visita
documentação de códigos para geração das tabelas “De” “Para”
data_ultima_visita
Informa a data que a referencia familiar visitou o acolhido
inteiro
2
NÃO
inteiro
1
NÃO
Array
string
25/12/2000
NÃO
NÃO
inteiro
52
NÃO
inteiro
25
NÃO
inteiro
string
45
321569874125’
NÃO
NÃO
string
A ou D
NÃO
array
(1,2,3)
NÃO
Array
NÃO
inteiro
inteiro
5236
99999
NÃO
NÃO
inteiro
256
NÃO
Inteiro
String
0 ou 1
“S” ou “N”
NÃO
NÃO
inteiro
string
2
12/12/2000
NÃO
NÃO
12
Documentação do Web Service do CNCA
obs.
medidaCrianca
data
id_tipo_medida
tipo_orgao
obs.
medidaFamilia
data
id_tipo_medida
tipo_orgao
obs.
processo
id_pessoa
num_processo
id_tipo_processo
liminar
sentenca
obs.
ocorrencia
id_ocorrencia
id_pessoa
data
obs.
Informa alguma observação
Array contendo vários array referentes medidas relativas a
criança. Cada índice do array compõe um campo que será
armazenado.
Informa a data que a medida foi aplicada a criança.
Campo que informa o id da medida, conforme documentação de
códigos para geração das tabelas “De” “Para”
Informa o tipo de órgão responsável pela medida. Os tipos
aceitos são Juiz de direito e Conselho tutelar
Alguma observação sobre a medida
Array contendo vários array referentes medidas relativas a
família. Cada índice do array compõe um campo que será
armazenado.
Informa a data que a medida foi aplicada a família.
Campo que informa o id da medida, conforme documentação de
códigos para geração das tabelas “De” “Para”
Informa o tipo de órgão responsável pela medida. Os tipos
aceitos são Juiz de direito e Conselho tutelar
Alguma observação sobre a medida
Array contendo vários array referentes aos processos do
acolhido. Cada índice do array compõe um campo que será
armazenado.
Código do acolhido
Número do processo a ser gravado
Campo que informa o id do processo, conforme documentação
de códigos para geração das tabelas “De” “Para”
Informa se o processo possui liminar
Data que a sentença foi marcada
Observação sobre o processo.
Array contendo vários array referentes as corrência do
acolhido. Cada índice do array compõe um campo que será
armazenado.
Código da ocorrência
Código do acolhido
Data da ocorrência
Observação da ocorrência
string
“Pai está viajando”
NÃO
Array
String
12/12/2000
NÃO
NÃO
inteiro
2
NÃO
inteiro
“J” ou “C”
NÃO
string
“Medida aplicada a criança”
NÃO
Array
String
12/12/2000
NÃO
NÃO
inteiro
2
NÃO
inteiro
“J” ou “C”
NÃO
string
“Medida aplicada a criança”
NÃO
Array
inteiro
string
56
5896512
NÃO
NÃO
NÃO
inteiro
string
string
String
2
“S” ou “N”
12/12/2000
“O processo está ativo”
NÃO
NÃO
NÃO
NÃO
Array
inteiro
inteiro
string
string
2563
256
12/12/2000
“Observação da corrência”
NÃO
NÃO
NÃO
NÃO
NÃO
13
Documentação do Web Service do CNCA
Entidade de acolhimento
Entidade de Acolhimento
Atributo
id_abrigo
Descrição
Código único da entidade de acolhimento
Tipo de dados
inteiro
Exemplo de preenchimento
12345
Obrigatório
NÃO
Campo referente à razão social da entidade
string
"Casa de abrigo Menino Jesus"
SIM
nome_fantasia
Campo referente ao nome fantasia da entidade
string
"Casa de abrigo Menino Jesus"
SIM
cnpj_cpf
registro_cmdca
telefone
CNPJ da entidade ou CPF da família acolhedora.
Número do registro CMDCA da entidade
Telefone da entidade
Código que informa o tipo de entidade que está se
cadastrando
Código que informa a classificação da entidade
string
string
string
"27.381.348/0001-22"
00231548'
"(61)3654-6985
NÃO
NÃO
NÃO
inteiro
inteiro
5
5
NÃO
NÃO
id_estado
Campo que informa o id do estado no qual a entidade se
encontra, conforme documentação de códigos para geração
das tabelas "De" "Para"
inteiro
52
NÃO
id_cidade
Campo que informa o id da cidade no qual a entidade se
encontra, conforme documentação de códigos para geração
das tabelas "De" "Para"
inteiro
25
NÃO
inteiro
45
NÃO
inteiro
string
string
2
"Guará"
"1"
NÃO
NÃO
NÃO
string
string
"2"
"72302404"
NÃO
NÃO
razao_social
id_tipo_abrigo
id_classificacao
id_bairro
id_tipo_logradouro
logradouro
numero
complemento
cep
Campo que informa o id da cidade no qual a entidade se
encontra, conforme documentação de códigos para geração
das tabelas "De" "Para"
Campo referente ao tipo de logradouro do endereço da
entidade
Descrição do endereço da entidade
Número relativo ao endereço da entidade.
Alguma informação que possa complementar o endereço da
entidade de acolhimento
CEP da entidade
14
Documentação do Web Service do CNCA
Algum ponto de referência que possa facilitar a busca pelo
endereço da entidade.
A quantidade de acolhidos que a entidade suporta.
Qual o sexo que a entidade acolhe, Masculino, Feminino ou
sexo
Ambos
Idade mínima de crianças do sexo masculino que a entidade
de_masculino
acolhe
Idade máxima de crianças do sexo masculino que a entidade
ate_masculino
acolhe
Idade mínima de crianças do sexo feminino que a entidade
de_feminino
acolhe
Idade máxima de crianças do sexo feminino que a entidade
ate_feminino
acolhe
portador_deficiencia
Informa se a entidade aceita crianças portadoras de deficiência
Informa se a entidade aceita crianças com dependência
dependencia_quimica
química
Informa se a entidade aceita apenas crianças com
quimica_exclusivo
dependência química
Informa se a entidade aceita apenas crianças portadores de
deficiência
deficiencia_exclusivo
HIV
Informa se a entidade aceita crianças portadoras do vírus HIV
Informa se a entidade aceita apenas crianças portadores do
hiv_exclusivo
vírus HIV
equipe_tecnica
Informa se a entidade possui alguma equipe técnica
verbas_publicas
Informa se a entidade recebe alguma verba pública
Campo destinado para alguma informação complementar que
informacao_complementar
se deseja adicionar
Para a entidade receber alguma doação a mesma pode
informar uma conta para que sejam realizados os depósitos
diretamente. Esse campo se destina a informar o nome do
titular da conta
nome_titular_conta
Campo para se informar o nome do banco pra realizar a
banco
doação
agencia
Campo para se informar a agência pra realizar a doação
Campo para se informar o número da conta pra realizar a
doação
numero_conta
Campo destinado para relatar quais os itens desejados para
itens_doacao
que sejam realizadas doações.
referencia
capacidade
string
string
"D" ou "F"
"30"
NÃO
NÃO
string
"M", "F" ou "A"
NÃO
string
1
NÃO
string
10
NÃO
string
1
NÃO
string
string
10
S ou "N"
NÃO
NÃO
string
S ou "N"
NÃO
string
S ou "N"
NÃO
string
string
S ou "N"
S ou "N"
NÃO
NÃO
string
string
string
"S" ou "N"
"S" ou "N"
"S" ou "N"
NÃO
NÃO
NÃO
string
"A entidade de acolhimento..."
NÃO
string
"José da silva"
NÃO
string
string
"Banco do Brasil"
5236-9
NÃO
NÃO
string
23654-9
NÃO
string
"Arroz, feijão..."
NÃO
15
Documentação do Web Service do CNCA
seq_orgao
necessidade
contato
id_contato
id_pessoa_relacionamento
id_abrigo
Campo que informa o id da vara responsável pela vara da
entidade, conforme documentação de códigos para geração
das tabelas "De" "Para"
Campo que informa quais as necessidades especiais que a
entidade pode acolher, conforme documentação de códigos
para geração das tabelas "De" "Para"
Informa o tipo de acolhimento, pode ser Acolhimento ou
Desligamento
Código único do contato, caso não exista deixe em branco
para que se gere um novo registro
Código da pessoa do contato
Código do abrigo ao qual está vinculado o contato
string
321569874125'
NÃO
array
(1,2,3)
NÃO
array
inteiro
inteiro
inteiro
NÃO
236
NÃO
2
2
Se informar
algum contato é
obrigatório
NÃO
(61)3354-9856
Se informar
algum contato é
obrigatório
NÃO
id_tipo_referencia
contato
Campo que informa quais os tipos de referência existentes
para o contato, conforme documentação de códigos para
geração das tabelas "De" "Para"
Telefone para que possa entrar em contato
id_tipo_forma_contato
Campo que informa quais as formas de contato existentes
para o contato, conforme documentação de códigos para
geração das tabelas "De" "Para"
inteiro
2
Se informar
algum contato é
obrigatório
Campo destinado a incluir alguma observação extra sobre o
contato cadastrado para a entidade.
string
"Horário disponível das 14h às 18h'
NÃO
obs
string
16
Documentação do Web Service do CNCA
Inexistência
Inexistência
Atributo
id_inexistencia
Descrição
Código único da inexistência
Tipo de dados
inteiro
Exemplo de preenchimento
12345
Obrigatório
NÃO
tipo_inexistencia
Campo que informa qual o tipo de inexistência irá se informar,
conforme documentação de códigos para geração das tabelas
"De" "Para"
inteiro
1
SIM
seq_orgao
ativo
Campo que informa qual a vara que está informando a
inexistência, conforme documentação de códigos para geração
das tabelas "De" "Para"
Campo que informa se a inexistência está ativa ou não
inteiro
string
2
0 ou 1
SIM
NÃO
Guia de desligamento
Guia de Desligamento
Atributo
Descrição
seq_guia_desligamento
Id único da guia de desligamento, numeração que compõem
os 5 últimos números da guia
nome_crianca
Campo referente ao nome do acolhido.
sexo_crianca
Campo referente ao sexo da Criança.
dtnasc_crianca
Data de nascimento da criança
idadepresumida_crianca
Número que representa a idade presumida da criança
Tipo de dados
Exemplo de
preenchimento
"Pedro da Silva"
Obrigatório
Somente se a guia já existir é
obrigatório informar essa
numeração.
SIM
"M" ou "F"
SIM
12/12/2000
Se não existir idade presumida
o campo é obrigatório.
99
Se não existir data de
nascimento o campo é
obrigatório.
12345
inteiro
string
string com apenas
um caractere
string
Inteiro de dois
dígitos
17
Documentação do Web Service do CNCA
mae_crianca
pai_crianca
responsavel_crianca
end_responsavel_crianca
rua_responsavel
num_rua_responsavel
cep_responsavel
bairro_responsavel
ref_responsavel
fone_responsavel
cel_responsavel
local_desligamento
data_desligamento
hora_desligamento
desligado_por
motivo_desligamento
motivo_descritivo
despacho_juiz
seq_guia_acolhimento
seq_tribunal
seq_vara
justificativa
status
id_pessoa
num_processo
Nome da mãe do acolhido
Nome do pai do acolhido
Nome do responsável do acolhido
Endereço do responsável do acolhido
Complemento do campo endereço, o campo rua
Complemento do campo endereço, o número da rua
Complemento do campo endereço, o campo CEP
Complemento do campo endereço, o campo bairro
Complemento do campo endereço, campo ponto de
referência
Telefone do responsável
Celular do responsável
Nome da entidade de desligamento do qual a criança está
sendo desligada.
Data de desligamento da criança
Hora do desligamento
Responsável pelo desligamento da criança
Campo que informa o motivo do desligamento, conforme
documentação de códigos para geração das tabelas "De"
"Para"
Campo que informa o motivo do desligamento
detalhadamente.
Campo que informa o despacho realizado pelo juiz
Número da guia de acolhimento da criança
Código do tribunal conforme documentação de códigos para
geração das tabelas "De" "Para"
Código da vara conforme documentação de códigos para
geração das tabelas "De" "Para"
Caso a guia esteja com o status 0 que significa que a
mesma está inativa, deverá ter uma justificativa com o
motivo que a colocou nesse estado.
Campo que informa se a guia está ou não ativa
Código único que vincula a guia a uma criança
Número do processo que responsável pelo acolhimento da
criança
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
"Marlene da silva"
"José da Silva"
"Pedro da Silva"
"Quadra x conj y casa z"
"MACHADO"
"12"
"72.302-404"
"CENTRO"
SIM
NÃO
NÃO
NÃO
NÃO
NÃO
NÃO
NÃO
"Mercearia do seu José"
NÃO
(61) 3357-2569
(61) 8156-6895
NÃO
NÃO
Casa menino José
SIM
12/12/2000
"15:00"
"José da Silva"
SIM
NÃO
NÃO
"OUTROS"
SIM
Menor atingiu a maioridade'
NÃO
"Criança foi transferida"
200147859632'
NÃO
SIM
"S" ou "N"
NÃO
Nascido com 295gr no
hospital XXX as XX:XX
NÃO
Duplicidade da guia'
Só é obrigatório caso o status
da guia seja 0
1
25
NÃO
SIM
02154-968
NÃO
string
string
string
string
string com apenas
1 caractere
string
string
string
inteiro
string
18