Cadastrar/Editar Convênio
Para cadastrar ou editar um registro de CONVÊNIO, utilize este endpoint. Um registro de CONVÊNIO nunca é excluído do banco de dados, para removê-lo das opções faça um POST do registro com status = "I".
URL: /convenios
Método: POST
| Campo | Tipo | Descrição |
|---|
| token | String | Token de acesso |
Body
| Campo | Tipo | Descrição |
|---|
| id | String | Identificador do convênio |
| desc | String | Descrição do convênio |
| sigla | String | Sigla do convênio |
| status | String | A - Ativo ou I - Inativo |
| planos | Array de Objetos | Lista de planos |
{
"convenio": {
"id": "63",
"desc": "SAUDE BRADESCO",
"sigla": "BRADESCO",
"status": "A",
"planos": [
{
"desc": "PRIVATIVO",
"status": "A"
}
]
}
}
Resposta em caso de sucesso
| Código HTTP | Mensagem |
|---|
| 201 | Convênio cadastrado com sucesso |
| 201 | Convênio editado com sucesso |
{
"msg": "Convênio cadastrado com sucesso."
}
Respostas em caso de falha
| Código HTTP | Mensagem |
|---|
| 401 | Token de acesso obrigatório |
| 401 | Falha ao autenticar com o token informado |
| 422 | Mensagem informando quais paramêtros da request precisam ser corrigidos. |
{
"msg": "Desc do Convênio obrigatória."
}