Documentação API EST

Buscar Convênio por ID

Buscar CONVÊNIO pelo ID.

URL: /convenios/:id

Método: GET

CampoTipoDescrição
tokenStringToken de acesso

Parâmetros

CampoTipoDescrição
idStringID do convênio

exemplo: /convenios/63

Resposta em caso de sucesso

Código HTTP: 200

{
  "convenio": {
    "id": "63",
    "desc": "SAUDE BRADESCO",
    "sigla": "BRADESCO",
    "status": "A",
    "planos": [
      {
        "desc": "PRIVATIVO",
        "status": "A"
      }
    ]
  }
}

Resposta em caso de falha

Código HTTPMensagem
401Token de acesso obrigatório
401Falha ao autenticar com o token informado
422É obrigatório informar um ID para buscar
422Registro com este ID não encontrado
{
  "msg": "Registro com este ID não encontrado."
}