Home TOTVS Varejo Supermercados

Árvore de páginas

Versões comparadas

Versão antiga 4

changes.mady.by.user Usuário desconhecido (delciney.oliveira)

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Gleydson Guedes Morais

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Método de consulta que retorna informações de uma lista de pessoas.

Chamada

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

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

...

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

Id

Identificador da pessoa

integer($int32)

Não há.

Status

Status da pessoa

string

A - Ativo I - Inativo.

NomeRazaoSocial

Nome razão social

string

Não há.
NomeFantasiaNome fantasiastringNão há.

NumeroCPFCNPJ

Número do CFP/CNPJ sem dígitointeger($int32)stringNão háSomente números.
DigitoCPFCNPJDigito do CFP/CNPJinteger($int32)Somente números.
TipoTipo de cadastrostringF - Física J - Jurídica.
PagePáginas

integer($int32)

Não há.
PageSizeTamanho das páginas

integer($int32)

Não há.

...

application/json, text/json

CODE 200 - SUCCESS

{

{
  

  "hasNext": true,
  "items": [
    {
      "expandables":
[
    
 [
        "string"

  ],
  

      ],
      "idPessoa":
0,
  "versao": 0,
  "nomeRazaoSocial": "string",
  "fantasia": "string",
  "tipo": "string",
  "sexo": "string",
  "status": "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",
  "telefoneDDD3": "string",
  "telefoneNumero3": "string",
  "telefoneComplemento3": "string",
  "numeroCPFCNPJ": 0,
  "digitoCPFCNPJ": 0,
  "inscricaoEstadualRG": "string",
  "email": "string",
  "homePage": "string",
  "estadoCivil": "string",
  "contribuinteICMS": "string",
  "inscricaoProdutorRural": "string",
  "numeroCNPJProdutorRural": 0,
  "digitoCNPJProdutorRural": 0,
  "numeroCPFProdutorRural": 0,
  "digitoCPFProdutorRural": 0
}
 0,
      "numeroCPFCNPJ": "string",
      "digitoCPFCNPJ": 0,
      "cpfcnpj": "string",
      "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
    }
  ]
}