Home TOTVS Varejo Supermercados

Árvore de páginas

Objetivo

A finalidade deste método é possibilitar inserir um associado a rede.

Chamada

POST [URLAPI]/IntegradorAssociadosAPI/api/v1/Associados

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)
NomeNome do AssociadoStringNão há.
UrlAcessoURLbase para acesso à APIStringNão há.
UsuarioAcessoUsuário para geração do token para comunicação com as APIsStringNão há.
SenhaAcessoSenha para geração do token para comunicação com as APIsStringNão há.
NroEmpresaNúmero da empresa a ser autenticada utilizada para geração do token para comunicação com as APIsinteger($int64)Não há.
StatusStatus do associado, (A) - Ativo e (I) - Inativo.StringNão há.
{
  "nome": "string",
  "urlAcesso": "string",
  "usuarioAcesso": "string",
  "senhaAcesso": "string",
  "nroEmpresa": 999999,
  "status": "string"
}

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

{
  "idAssociado": 0,
  "nome": "string",
  "urlAcesso": "string",
  "usuarioAcesso": "string",
  "senhaAcesso": "string",
  "nroEmpresa": 0,
  "dtaHrInclusao": "2024-07-02T16:39:51.963Z",
  "usuarioInclusao": "string",
  "status": "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
    }
  ]
}