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 Rede.

Chamada

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

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

Parâmetros URI (URI Parameters)

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á.

Informações para Resposta (Response Information)

Códigos do Recurso (Response Codes)

Formatos de Resposta (Response Formats)

application/json, text/json

CODE 201 - CREATED

{
  "idAssociado": 0,
  "idLoja": 0,
  "nroEmpresa": 0,
  "idPessoa": 0,
  "nomeReduzido": "string",
  "indAssocMatriz": "string",
  "areaLoja": 0,
  "dtaHrInclusao": "2023-01-05T14:17:45.382Z",
  "usuarioInclusao": "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
    }
  ]
}