Histórico da Página
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) |
|---|---|---|---|
| Nome | Nome do Associado | String | Não há. |
| UrlAcesso | URLbase para acesso à API | String | Não há. |
| UsuarioAcesso | Usuário para geração do token para comunicação com as APIs | String | Não há. |
| SenhaAcesso | Senha para geração do token para comunicação com as APIs | String | Não há. |
| NroEmpresa | Número da empresa a ser autenticada utilizada para geração do token para comunicação com as APIs | integer($int64) | Não há. |
| Status | Status do associado, (A) - Ativo e (I) - Inativo. | String | Não há. |
| Bloco de código |
|---|
{
"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
| Bloco de código |
|---|
{
"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
| Bloco de código |
|---|
{
"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
}
]
} |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas