Incluir Pessoa - POST

Objetivo

Realizar a inclusão de Pessoa.

Atenção antes de realizar um cadastro de pessoa através da API é necessário que o endereço completo esteja cadastrado, ou seja, cidade, bairro, logradouro devem estar previamente cadastrados no banco. 

Chamada

POST [URLAPI]/CadastrosEstruturaisAPI/api/v1/Pessoa

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)

Não há.

Parâmetros do Corpo (Body Parameters)

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

• Success (201)
• BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 200 - SUCCESS

{
    "status": "string",
    "nomeRazaoSocial": "string",
    "versao": 0,
    "fantasia": "string",
    "tipo": "string",
    "sexo": "string",
    "idCidade": 0,
    "nomeCidade": "string",
    "ufCidade": "string",
    "paisCidade": "string",
    "idBairro": 0,
    "nomeBairro": "string",
    "idLogradouro": 0,
    "descricaoLogradouro": "string",
    "numeroLogradouro": "string",
    "complementoLogradouro": "string",
    "cep": "string",
    "telefoneDDD1": "string",
    "telefoneNumero1": "string",
    "telefoneComplemento1": "string",
    "numeroCPFCNPJ": "string",
    "digitoCPFCNPJ": "string",
    "email": "string",
    "homePage": "string",
    "contribuinteICMS": "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
    }
  ]
}