Este documento tem como objetivo demonstrar a utilização dos endpoints de autorizações do beneficiário, que faz parte da api beneficiaryPosition do Produto TOTVS Saúde Planos Linha Protheus (totvsHealthPlans).
Esses endpoints serão utilizados na nova tela de posiçã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 as autorizações do beneficiário
| https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/authorizations |
|
| Authorization (header) |
| Cabeçalho usado para autorização das requisições | *required |
Content-Type (header) |
| 'application/json' é o formato do conteúdo | *required |
| SubscriberId (path) |
| Número da carteirinha do beneficiário | *required |
| phases (query) |
| Fases das autorizações, sendo:
| |
| formTypes (query) |
| Tipos de autorizações, sendo:
Guias de acordo com o cadastro da tabela BCL | |
| initialDate (query) |
| Data inicial das autorizações: 'AAAA-MM-DD' | |
| finalDate (query) |
| Data final das autorizações: 'AAAA-MM-DD' | |
| page (query) |
| Paginação da Coleção | |
| pageSize (query) |
| Quantidade de Itens por Página | |
| order (query) |
| Ordenação da Coleção | |
| fields (query) |
| Filtro de campos dos registros | |
| filter (query) |
| Indica o filtro querystring recebido (pode se utilizar um filtro oData) |
Não possui body!
| items |
| Autorizações do Beneficiário |
| items.{campo do SX3} |
| Os campos retornados da tabela SE1:
|
items.authorizationid |
| Chave identificador da autorização para ser utilizado nos endpoints:
Campo: ALIAS+BD5_CODOPE+BD5_CODLDP+BD5_CODPEG+BD5_NUMERO |
| struct |
| Estrutura dos fields de acordo com o dicionário de dados (SX3) |
| hasNext |
| Indica se ainda existem registros a serem retornados |
| remainingRecords |
| Quantidade de registros ainda existem para retorno |
{
"items": [
{
"bd5_codldp": "9999",
"bd5_codpeg": "00000499",
"bd5_numero": "00000001",
"bd5_datpro": "2022-11-1",
"bd5_codrda": "000004",
"bd5_nomrda": "HOSPITAL BOM CLIMA",
"bd5_tipgui": "01",
"bd5_fase": "3",
"bd5_situac": "1",
"bcl_descri": "GUIA DE CONSULTA",
"authorizationid": "BD5-000199990000049900000001"
},
{
"bd5_codldp": "9999",
"bd5_codpeg": "00000500",
"bd5_numero": "00000001",
"bd5_datpro": "2022-11-1",
"bd5_codrda": "000004",
"bd5_nomrda": "HOSPITAL BOM CLIMA",
"bd5_tipgui": "02",
"bd5_fase": "3",
"bd5_situac": "1",
"bcl_descri": "GUIA DE SP_SADT",
"authorizationid": "BEA-000199990000050000000001"
},
{
"bd5_codldp": "9999",
"bd5_codpeg": "00000501",
"bd5_numero": "00000001",
"bd5_datpro": "2022-11-1",
"bd5_codrda": "000004",
"bd5_nomrda": "HOSPITAL BOM CLIMA",
"bd5_tipgui": "03",
"bd5_fase": "1",
"bd5_situac": "1",
"bcl_descri": "GUIA DE SOL. INTERNACAO",
"authorizationid": "BE4-000199990000050100000001"
}
],
"hasNext": false,
"remainingRecords": 0,
"struct": [
{
"field": "BD5_CODLDP",
"type": "C",
"title": "Cd.Local Dig",
"description": "Codigo Local Digitacao",
"picture": "@!",
"size": 4,
"decimals": 0,
"cbox": []
},
{
"field": "BD5_CODPEG",
"type": "C",
"title": "Código PEG",
"description": "Codigo PEG",
"picture": "@!",
"size": 8,
"decimals": 0,
"cbox": []
},
{
"field": "BD5_NUMERO",
"type": "C",
"title": "Número",
"description": "Numero da Movimentacao",
"picture": "@!",
"size": 8,
"decimals": 0,
"cbox": []
},
{
"field": "BD5_DATPRO",
"type": "D",
"title": "Data Evento",
"description": "Data Evento",
"picture": "",
"size": 8,
"decimals": 0,
"cbox": []
},
{
"field": "BD5_CODRDA",
"type": "C",
"title": "Cd.Cred/Coop",
"description": "Cod. Credenc",
"picture": "@!",
"size": 6,
"decimals": 0,
"cbox": []
},
{
"field": "BD5_NOMRDA",
"type": "C",
"title": "Nm.Cred/Coop",
"description": "credenciado",
"picture": "@!",
"size": 40,
"decimals": 0,
"cbox": []
},
{
"field": "BD5_TIPGUI",
"type": "C",
"title": "Tp. Guia",
"description": "Tipo de Guia",
"picture": "@!",
"size": 2,
"decimals": 0,
"cbox": []
},
{
"field": "BD5_FASE",
"type": "C",
"title": "Fase",
"description": "Fase",
"picture": "@!",
"size": 1,
"decimals": 0,
"cbox": [
{
"value": "1",
"description": "Digitacao"
},
{
"value": "2",
"description": "Conferencia"
},
{
"value": "3",
"description": "Pronta"
},
{
"value": "4",
"description": "Faturada"
},
{
"value": "5",
"description": "Processando"
}
]
},
{
"field": "BD5_SITUAC",
"type": "C",
"title": "Situação",
"description": "Situacao",
"picture": "@!",
"size": 1,
"decimals": 0,
"cbox": [
{
"value": "1",
"description": "Ativa"
},
{
"value": "2",
"description": "Cancelada"
},
{
"value": "3",
"description": "Bloqueada"
}
]
},
{
"field": "BCL_DESCRI",
"type": "C",
"title": "Descricao",
"description": "Descricao",
"picture": "@!",
"size": 30,
"decimals": 0,
"cbox": []
}
]
} |
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 (404):
Code | message | detailedMessage |
|---|---|---|
| E001 | Beneficiário não encontrado. | Não foi encontrado nenhum Beneficiário com a matricula {subscriberId} |
| E002 | Autorização não encontrada. | Autorização informada não encontrada na base de dados. |
| E003 | Autorização informada invalida. | Dados da autorização informada estão invalidos. |
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 |
| ALIAS+BD5_CODOPE+BD5_CODLDP+BD5_CODPEG+BD5_NUMERO | Chave de identificação da autorização |
