Histórico da Página
...
- Visão Geral
- Exemplo de utilização
- Autorizações
- Dados da Autorização
- Eventos da Autorização
- Tela Autorizações do Beneficiário
- Outras Ações / Ações relacionadas
- Outras Ações / Ações relacionadas
- Tela Autorizações do Beneficiário
- Principais Campos e Parâmetros
- Principais Campos e Parâmetros
- Tabelas utilizadas
01. VISÃO GERAL
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).
- /totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/authorizations
- /totvsHealthPlans/v1/beneficiaryPosition/authorizations/{authorizationId}
- /totvsHealthPlans/v1/beneficiaryPosition/authorizations/{authorizationId}/events
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
02. EXEMPLO DE UTILIZAÇÃO
Autorizações
Retorna uma coleção com as autorizações do beneficiário
Endpoint
https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/authorizations |
Parâmetros
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) |
...
Request
Não possui body!
...
Operação realizada com sucesso (200)
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 |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"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": []
}
]
} |
Dados Inválidos (404)
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. |
Bloco de código | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
{
"code": "E001",
"message": "Beneficiário não encontrado.",
"detailedMessage": "Não foi encontrado nenhum Beneficiário com a matricula 00011008000027012"
} |
Tabela de Código de Erros
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} |
03. TELA XXXXX
Outras Ações / Ações relacionadas
...