Objetivo

Método de consulta que retorna informações de pessoa.

Chamada

GET [URLAPI]/CadastrosEstruturaisAPI/api/v1/Pessoa/Id

Permissionamento

Antes de prosseguir, certifique-se de que o usuário, utilizado para autenticação de uso na API, está com as devidas permissões no Sistema/Módulo/Aplicações e na empresa desejada.

Para isso, acesse o módulo SegurançaWeb > Permissões > Associação de Permissão Usuário / Grupo >  Sistemas/Módulo/Aplicações > Comercial Web > API Cadastros Estruturais > API Cadastros Estruturais 


Imagem 01 - Configurações de Sistemas/Módulos/Aplicações

Assuntos Relacionados

Para saber mais sobre permissionamentos acesse Permissões - Segurança Web.

Informações para Requisição (Request Information)

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)

Id

Identificador da pessoa

integer($int32)

Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
  "idPessoa": 0,
  "numeroCPFCNPJ": 0,
  "digitoCPFCNPJ": 0,
  "status": "string",
  "nomeRazaoSocial": "string",
  "fantasia": "string",
  "tipo": "string",
  "nomeCidade": "string",
  "ufCidade": "string",
  "paisCidade": "string",
  "nomeBairro": "string",
  "descricaoLogradouro": "string",
  "numeroLogradouro": "string",
  "complementoLogradouro": "string",
  "cep": "string",
  "telefoneDDD1": "string",
  "telefoneNumero1": "string",
  "telefoneComplemento1": "string",
  "telefoneDDD2": "string",
  "telefoneNumero2": "string",
  "telefoneComplemento2": "string",
  "inscricaoEstadualRG": "string",
  "contribuinteICMS": "string",
  "email": "string",
  "homePage": "string",
  "sexo": "string",
  "estadoCivil": "string",
  "inscricaoProdutorRural": "string",
  "microEmpresa": "string",
  "cnae": "string"
}

application/json, text/json

CODE 400 - BAD

{
  "code": "string",
  "message": "string",
  "detailedMessage": "string",
  "helpUrl": "string",
  "details": [
    {
      "guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationType": 0,
      "code": "string",
      "message": "string",
      "detailedMessage": "string",
      "status": 0
    }
  ]
}