Árvore de páginas

Versões comparadas

Chave

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

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)
NomeRazao
Descrição do nome do Associado
Nome razão socialstringNão há.
NomeFantasia
Nome fantasia

string

Não há.

Id

Identificador da pessoa
Páginas
integer(
$int64FilterExpandFieldsOrderPage
$int32)Não há.

Id

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

Bloco de código
{
  "hasNext": true,
  "items": [
    {
      "seqAssociadoidPessoa": 0,
      "nomeAssociadofantasia": "string",
      "urlAcessoServidorrazao": "string",
      "usuarioAcessoServidorpessoa": "string",
      "senhaAcessoServidornroCgcCpf": "string",
      "nroEmpresaAut": 0,
      "dtaHrInclusao": "2023-01-12T17:45:36.430Z",
      "usuarioInclusao": "string",
      "dtaHrAlteracao": "2023-01-12T17:45:36.430Z",
      "usuarioAlteracao": "string",
      "status": "string",
      "qtdLojas": 0,       
      "associadoLojas": [
        {
          "seqAssociado": 0,
          "seqLoja": 0,
          "nroEmpresa": 0,
          "seqPessoa": 0,
          "nomeReduzido": "string",
          "indAssocMatriz": "string",
          "areaLoja": 0,
          "dtaInclusao": "2023-01-12T17:45:36.430Z",
          "usuInclusao": "string",
          "dtaAlteracao": "2023-01-12T17:45:36.430Z",
          "usuAlteracao": "string"
        }
      ]digCgcCpf": "string"
    }
  ]
}

application/json, text/json

...