01. VISÃO GERAL
A API dentalTreatment/{matriculaDoBeneficiario} tem como objetivo retornar as liberações odontológicas de um beneficiário. O verbo disponibilizado é o GET.
02. CONFIGURAÇÕES INI
Para iniciar a instalação do processo, devemos configurar seu INI Protheus com a funcionalidade REST para habilitar o acesso as API´s. Documentos auxiliares:
03. VERBOS
Seguem os verbos disponíveis na API:
Verbo | URL | Descrição |
---|---|---|
GET | https://<url>:porta>/rest/totvsHealthPlans/v1/dentalTreatment/{matriculaDoBeneficiario} | Retorna as liberações odontológicas de um beneficiário |
04. USO DA API
GET
Dados do pathparam da requisição:
Tipo | Descrição |
---|---|
Caracter | Matrícula do Beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO) |
Dados do queryparam de envio:
Atributo | Tipo | Descrição | Obrigatoriedade |
---|---|---|---|
healthProviderCode | Caracter | Código da RDA | Obrigatório |
page | Caracter | Controle de número de paginas da aplicação | Opcional |
pageSize | Caracter | Controle de quantidade de itens que serão retornados. | Opcional |
expand | Caracter | Indica os expandables que serão retornados no json. | Opcional |
05. ATRIBUTOS DE RESPOSTA
Exemplo de chamada para validação:
http://localhost:8080/rest/totvshealthplans/v1/dentalTreatment/00010013000009012?healthProviderCode=000004&pageSize=5&page=1&expand=procedures,professional,cbos
GET - JSON de resposta - Sucesso
GET - JSON de resposta - Erro "Beneficiário não encontrado"