API

<back to all web services

i2cCNS2

CNS FULL [Ministerio da Saude]

The following routes are available for this service:
All Verbs/i2c/Saude/CNS2
All Verbs/i2c100088
Parameters:
NameParameterData TypeRequiredDescription
ModepathTextYesOrigem da informacao online/offline (on/off)
TipopathTextNoTipo da pesquisa (identica ou fonetica)
CPFpathNumberYesCPF
CNSpathTextYesNumero de Registro
NomepathTextYesNome
NomeMaepathTextYesNome da Mae
DataNascimentopathTextYesData de Nascimento (DD/MM/AAAA)
MunicipioNascimentopathTextYesMunicipio de Nascimento
UFNascimentopathTextYesUF de Nascimento

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /jsv/reply/i2cCNS2 HTTP/1.1 
Host: api.xdata.com.br 
Content-Type: text/jsv
Content-Length: length

{
	Mode: String,
	Tipo: String,
	CPF: String,
	CNS: String,
	Nome: String,
	NomeMae: String,
	DataNascimento: String,
	MunicipioNascimento: String,
	UFNascimento: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Response: 
	{
		Status: 
		{
			Protocol: 00000000000000000000000000000000,
			DateTime: 0001-01-01,
			Code: 0,
			Message: String,
			Detail: String,
			Mode: String,
			Type: String,
			Source: String,
			HTML: String,
			URL: String,
			Cookie: String
		},
		Input: 
		[
			{
				Key: String,
				Value: String
			}
		],
		Output: 
		[
			{
				CNS: String,
				CPF: String,
				Nome: String,
				NomeMae: String,
				NomePai: String,
				Sexo: String,
				RacaCorDescricao: String,
				EtniaIndigena: String,
				TipoSanguineo: String,
				DataNascimento: String,
				Vivo: String,
				DataObito: String,
				MotivoDeclaracaoObito: String,
				Nacionalidade: String,
				PaisNascimento: String,
				MunicipioNascimento: String,
				EmailPrincipal: String,
				EmailAlternativo: String,
				EnderecoTipoLogradouro: String,
				EnderecoLogradouro: String,
				EnderecoNumero: String,
				EnderecoComplemento: String,
				EnderecoBairro: String,
				EnderecoCep: String,
				EnderecoMunicipio: String,
				Telefones: 
				[
					{
						DDD: String,
						Numero: String,
						Tipo: String,
						Operadora: String
					}
				],
				RG: String,
				RGOrgaoEmissorDescricao: String,
				RGUF: String,
				RGDataEmissao: String,
				TituloEleitor: String,
				TituloEleitorZona: String,
				TituloEleitorSecao: String,
				CTPS: String,
				CTPSSerie: String,
				CTPSDataEmissao: String,
				Certidoes: 
				[
					{
						Tipo: String,
						Modelo: String,
						Cartorio: String,
						Livro: String,
						Folha: String,
						Termo: String,
						DataEmissao: String
					}
				]
			}
		],
		Error: 
		{
			ErrorCode: String,
			Message: String,
			StackTrace: String,
			Errors: 
			[
				{
					ErrorCode: String,
					FieldName: String,
					Message: String
				}
			]
		}
	}
}