Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

Listar pessoas já cadastrados, para a vincular a loja vinculada ao associado.

Chamada

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

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

Parâmetros URI (URI Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
NomeRazaoNome razão socialstringNão há.
NomeFantasiaNome fantasia

string

Não há.

Id

Identificador da pessoainteger($int32)Não há.
FilterFiltro de buscastringNão há.
ExpandOpção de expandir.stringNão há.
FieldsCampos.stringNão há.
OrderOrdenação dos campos.stringNão há.
PagePáginasinteger($int32)Não há.
PageSizeTamanho das páginasinteger($int64)Não há.

Parâmetros do Corpo (Body Parameters)

Não há.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

  • OK (201)
  • BadRequest (400)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 201 - CREATED

{
  "hasNext": true,
  "items": [
    {
      "idPessoa": 0,
      "fantasia": "string",
      "razao": "string",
      "pessoa": "string",
      "nroCgcCpf": "string",
      "digCgcCpf": "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
    }
  ]
}