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.
VERBO GET
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 |
06. EXEMPLOS DE JSON DE RESPOSTA
Solicitação GET
{
"attendanceLocation": [
{
"address": "MARIANA UBALDINA DO ESPIRITO SANTO",
"locationCode": "001",
"specialities": [
{
"specialtyDescription": "Medico clinico",
"specialtyCode": "001"
},
{
"specialtyDescription": "Geneticista",
"specialtyCode": "002"
},
{
"specialtyDescription": "Pesquisador em biologia de microorganismos e paras",
"specialtyCode": "003"
},
{
"specialtyDescription": "Fisico medico",
"specialtyCode": "004"
},
{
"specialtyDescription": "Biologo",
"specialtyCode": "005"
},
{
"specialtyDescription": "Cirurgiao dentista - auditor",
"specialtyCode": "006"
},
{
"specialtyDescription": "Cirurgiao dentista - clinico geral",
"specialtyCode": "007"
},
{
"specialtyDescription": "Cirurgiao dentista - endodontista",
"specialtyCode": "008"
},
{
"specialtyDescription": "Cirurgiao dentista - epidemiologista",
"specialtyCode": "009"
},
{
"specialtyDescription": "Cirurgiao dentista - estomatologista",
"specialtyCode": "010"
},
{
"specialtyDescription": "Cirurgiao dentista - implantodontista",
"specialtyCode": "011"
},
{
"specialtyDescription": "Cirurgiao dentista - odontogeriatra",
"specialtyCode": "012"
},
{
"specialtyDescription": "Cirurgiao dentista - odontologista legal",
"specialtyCode": "013"
},
{
"specialtyDescription": "Cirurgiao dentista - odontopediatra",
"specialtyCode": "014"
},
{
"specialtyDescription": "Cirurgiao dentista - ortopedista e ortodontista",
"specialtyCode": "015"
},
{
"specialtyDescription": "Cirurgiao dentista - patologista bucal",
"specialtyCode": "016"
},
{
"specialtyDescription": "Cirurgiao dentista - periodontista",
"specialtyCode": "017"
},
{
"specialtyDescription": "Cirurgiao dentista - radiologista",
"specialtyCode": "020"
},
{
"specialtyDescription": "Cirurgiao dentista - odontologia para pacientes co",
"specialtyCode": "027"
},
{
"specialtyDescription": "Cirurgiao-dentista da estrategia de saude da famil",
"specialtyCode": "028"
},
{
"specialtyDescription": "Enfermeiro",
"specialtyCode": "029"
},
{
"specialtyDescription": "Medico infectologista",
"specialtyCode": "035"
},
{
"specialtyDescription": "Medico nutrologista",
"specialtyCode": "042"
},
{
"specialtyDescription": "Medico em medicina de trafego",
"specialtyCode": "055"
},
{
"specialtyDescription": "Medico em radiologia e diagnostico por imagem",
"specialtyCode": "088"
}
]
},
{
"address": "RUA COPACABANA PALACE",
"locationCode": "002",
"specialities": []
},
{
"address": "SEN. TEOTÔNIO VILELA",
"locationCode": "003",
"specialities": []
}
],
"healthProviderId": "000004",
"name": "HOSPITAL BOM CLIMA"
}
{
"code": 400,
"message": "Prestador informado nao encontrado",
"detailedMessage": "Entre em contato com o Suporte",
"helpUrl": "",
"details": [
{
"code": "",
"message": "",
"detailedMessage": "",
"helpUrl": ""
}
]
}
