Histórico da Página
...
Com o INI Protheus configurado, a nomenclatura das API´s ficará no formato: <url + Porta + chave rest definidos no INI Protheus> + /totvsHealthPlans/v1/userUsage. Exemplo:
Logo, a minha URL será: http://spon019400235:8080/rest/totvsHealthPlans/v1/userUsage
...
Lista de query params não obrigatórios:
Campo | Descrição |
---|---|
fields | Indica os campos que serão retornados na consulta. |
order | Indica uma lista de atributos para realizar a ordenação dos registros. Indicando o caracter – no início, indica que será realizado uma ordenação decrescente. Lista de atributos que são passíveis de ordenação: procedureCode, procedureName, |
pageSize | Indica quantos registros serão retornados na requisição. O padrão do sistema são 20 registros. Caso ainda existam registros para serem exibidos, o atributo hasNext será retornado com true. |
page | Indica a página de ordenação que os registros serão apresentados. Se atentar ao controle booleano hasNext |
procedureCode, executionDate, healthProviderCode, healthProviderDocument, cid, procedureName, healthProviderName, quantity, toothRegion, face | Indicando um desses atributos e um valor, a API realizará um filtro adicional com o atributo e valor informado. |
05. ATRIBUTOS DE RESPOSTA
Atributo | Campo | Tipo | Descrição |
---|---|---|---|
procedureCode | BD6_CODPRO | String | Código do procedimento |
procedureName | BD6_DESPRO | String | Descrição do procedimento |
executionDate | BD6_DATPRO | String | Data do evento no formato yyyy-mm-dd |
subscribername | BD6_NOMUSR | String | Nome do beneficiário |
healthProviderCode | BD6_CODRDA | String | Código da rede de atendimento |
healthProviderName | BD6_NOMRDA | String | Nome da rede de atendimento |
serviceType | BR8_CLASSE | String | Código da classe de procedimento |
serviceTypeDescription | BJE_DESCRI | String | Descrição da classe de procedimento |
quantity | BD6_QTDPRO | Number | Quantidade do evento |
healthProviderDocument | BD6_CPFRDA | String | CPF/CNPJ da rede de atendimento |
cid | BD6_CID | String | CID principal do atendimento |
toothRegion | BD6_DENREG | String | Região do dente |
face | BD6_FADENT | String | Face do dente |
paidValue | BD6_VLRPAG | Number | Valor pago |
disallowanceValue | BD6_VLRGLO | Number | Valor de glosa |
coPaymentValue | BD6_VLRTPF | Number | Valor de co-participação |
subscriberId | BD6_OPEUSR+BD6_CODEMP+BD6_MATRIC+BD6_TIPREG+BD6_DIGITO | String | Matrícula do beneficiário |
05. EXEMPLO DE JSON DE RESPOSTA
...