Árvore de páginas

Versões comparadas

Chave

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

Objetivo

Realizar o vínculo entre as lojas e os associados já cadastrados, para a busca de dados que serão utilizados nas negociações da RedeA finalidade deste método é possibilitar o vinculo de uma loja a um associado da rede.

Chamada

POST [URLAPI]/IntegradorAssociadosAPI/api/v1/Associados/vincular-associado

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

Parâmetros URI (

...

Query Parameters)

...

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
SeqAssociadoCódigo do Associado

integer($int64)

Não há.

Parâmetros do Corpo (Body Parameters)

Nome (Name)Descrição (Description)Tipo (Type)Informações Adicionais (Adittional Information)
IdAssociadoCódigo do associado já previamente cadastrado que terá as lojas vinculadas.

integer($int64)

Não há.
IdLojaCódigo sequencial por loja para cadastro das lojas.

integer($int64)

Não há.
NroEmpresaNúmero da empresa que será cadastrada as lojas e os associados.

integer($int64)

Não há.
IdPessoaCódigo cadastrado na GE_PESSOA que será vinculada a loja cadastrada.

integer($int64)

Não há.
NomeReduzidoNome reduzido da loja cadastrada.StringNão há.
IndAssocMatrizIndica se a loja cadastrada é matriz ou não. String'S' - loja é matriz / 'N' - loja não é matriz.
AreaLojaÁrea (metro quadrado) da loja a ser cadastrada.

integer($int64)

Não há.
UsuarioInclusaoUsuário que realizou a inclusão dos dadosStringNão há.
Bloco de código
{
  "nroEmpresa": 999999,
  "idPessoa": 0,
  "nomeReduzido": "string",
  "indAssocMatriz": "string",
  "areaLoja": 0
}

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
{
  "idAssociado": 0,
  "idLoja": 0,
  "nroEmpresa": 0,
  "idPessoa": 0,
  "nomeReduzido": "string",
  "indAssocMatriz": "string",
  "areaLoja": 0,
  "dtaHrInclusao": "20232024-0107-05T1402T16:1746:4554.382Z693Z",
  "usuarioInclusao": "string"
}

...