API Accreditations

CONTEÚDO

Visão Geral
Configurações INI
Verbos
Uso da API - POST
Atributos de Resposta
Tabelas utilizadas

01. VISÃO GERAL

A API accreditations tem como objetivo retornar os dados de acreditação do prestador informado. O verbo disponibilizado é o GET.

02. CONFIGURAÇÕES IN

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/accreditations	Retorna as acreditações do prestador.

04. USO DA API - GET

Dados do queryparam de envio:

Atributo	Tipo	Descrição
healthProviderCode	Caracter	Código da RDA
locationCode	Caracter	(Opcional) Código do local de atendimento

Caso o local de atendimento seja enviado, o mesmo será utilizado no filtro e será retornado apenas as acreditações vinculadas ao local.

05. ATRIBUTOS DE RESPOSTA

JSON de resposta para acreditações não encontradas.

Erro 400

{
    "code": 400,
    "message": "Nenhum registro localizado",
    "detailedMessage": "O prestador não possui acreditações cadastradas, entre em contato com a operadora para realizar o cadastro.",
    "helpUrl": "",
    "details": [
        {
            "code": "",
            "message": "",
            "detailedMessage": "",
            "helpUrl": ""
        }
    ]
}

06. TABELAS UTILIZADAS

Os profissionais serão cadastrados na tabela B7P - Acreditações.

Árvore de páginas