Histórico da Página
CONTEÚDO
- Visão Geral
- Configuração INI
- Verbos
- Exemplo de Chamada da API
- Atributos de Resposta
- Exemplos de JSON de Resposta
01. VISÃO GERAL
A API healthProviders tem como objetivo, trabalhar com ações relacionadas aos dados de uma Rede de Atendimento, trazendo seus locais de atendimento e especialidades.
...
Através do verbo GET, informamos a Rede de Atendimento através de PathParam.
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:
1. Configuração do REST do Protheus
Com o INI Protheus configurado, a nomenclatura das API´s ficará no formato: <url + Porta + chave rest definidos no INI Protheus> + /totvsHealthPlans/v1/authorizations/<guia>. Exemplo:
Logo, a minha URL será: http://localhost:8080/rest/healthProviders
03. VERBOS
Seguem os verbos disponíveis na API:
Verbo | Path | PathParam | Descrição |
---|---|---|---|
GET | healthProviders/{healthProviderCode} | healthProviderCode | Código da RDA |
04. EXEMPLO DE CHAMADA DA API
Chamada GET
Exemplo solicitando dados da RDA 000004:
http://spon019400235:8080/rest/totvshealthplans/v1/healthProviders/000004
...
04. ATRIBUTOS DE RESPOSTA
Chamada GET
Cabeçalho
Atributo | Campo | Tipo |
---|---|---|
healthProviderId | BAU_CODIGO | Caracter |
name | BAU_NOME | Caracter |
attendanceLocation | Array |
Atributo attendanceLocation
Atributo | Campo | Tipo |
---|---|---|
address | BB8_END | Caracter |
locationCode | BB8_CODLOC | Caracter |
specialities | Array |
Atributo attendanceLocation
Atributo | Campo | Tipo |
---|---|---|
specialtyCode | BAX_CODESP | Caracter |
specialtyDescription | BAQ_DESCRI | Caracter |