Este documento tem como objetivo demonstrar a utilização do endpoint de coberturas do beneficiário, que faz parte da api beneficiaryPosition do Produto TOTVS Saúde Planos Linha Protheus (totvsHealthPlans).
Essee endpoint será utilizado na nova tela de Gestão do Beneficiário, desenvolvida em PO UI. (Biblioteca de componentes baseado em Angular)
Clique aqui para detalhes sobre como habilitar o serviço de APIs
Retorna uma coleção com os grupos de coberturas do beneficiário.
| https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/coverageGroup |
|
| SubscriberId (path) |
| Número da carteirinha do beneficiário | *required |
| Authorization (header) |
| Cabeçalho usado para autorização das requisições | *required |
Content-Type (header) |
| 'application/json' é o formato do conteúdo | *required |
Não possui body!
| items |
| Grupos de cobertura do beneficiário |
| items.groupCode |
| Código do grupo de cobertura Campo: BG7_CODGRU |
items.coverageGroup |
| Descrição do grupo de cobertura Campo: BG7_DESCRI |
| items.level |
| Nível sendo: Usuario, Familia, Empresa e Produto |
| hasNext |
| Indica se ainda existem registros a serem retornados |
| remainingRecords |
| Quantidade de registros ainda existem para retorno |
{
"items": [
{
"groupCode": "004",
"coverageGroup": "AMBULATORIAL",
"level": "Produto"
},
{
"groupCode": "007",
"coverageGroup": "Z",
"level": "Produto"
}
],
"hasNext": false,
"remainingRecords": 0
} |
code |
| Código identificador do erro. (Tabela de Erros) |
message |
| Literal no idioma da requisição descrevendo o erro para o usuário. |
detailedMessage |
| Mensagem técnica e mais detalhada do erro. |
{
"code": "E001",
"message": "Beneficiário não encontrado.",
"detailedMessage": "Não foi encontrado nenhum Beneficiário com a matricula 00011008000027012"
} |
Código de erros informado no Json de retorno com falha:
Code | message | detailedMessage | Status Code |
|---|---|---|---|
| E001 | Beneficiário não encontrado. | Não foi encontrado nenhum Beneficiário com a matricula {subscriberId} | 404 |
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|---|
| Não se aplica. | Não se aplica. |
Principais Campos e Parâmetros
| Campo | Descrição |
|---|---|
| BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITO | Carteirinha do beneficiário |
