CONTEÚDO

1. Visão Geral
2. Configuração INI
3. Verbos
   
4. Uso da API
5. Exemplo de Chamada da API
6. Atributos de Resposta
7. Exemplos de JSON de Resposta

01. VISÃO GERAL

     A API professionals/{professionalCode}/professionalSpecialities tem como objetivo trabalhar com ações relacionadas as especialidades vinculadas a um profissional. 

     VERBO GET

     Através do verbo GET, informamos o código do profissional como pathParam e as especialidades vinculados a ele são devolvidos. 

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/professionals/{professionalCode}/professionalSpecialities. Exemplo:

Logo, a minha URL será: http://localhost:8080/rest/totvshealthplans/v1/professionals/{professionalCode}/professionalSpecialities.

03. VERBOS

Seguem os verbos disponíveis na API:

04. USO DA API

GET - ESPECIALIDADES VINCULADAS A UM PROFISSIONAL

Queryparams:

05. EXEMPLO DE CHAMADA DA API

Chamada GET

Exemplo solicitando dados de especialidades vinculadas ao profissional 0000026:

http://spon019400235:8080/rest/totvshealthplans/v1/professionals/000026/professionalSpecialities?page=1&pageSize=30

06. ATRIBUTOS DE RESPOSTA

Chamada GET

07. EXEMPLOS DE JSON DE RESPOSTA

Solicitação GET

{
    "items": [
        {
            "code": "225105",
            "description": "Médico acupunturista",
            "specialtyDescription": "Medico clinico",
            "specialtyCode": "001"
        },
        {
            "code": "225125",
            "description": "Médico clínico",
            "specialtyDescription": "Medico clinico",
            "specialtyCode": "001"
        }
    ],
    "hasNext": true
}

{
    "code": 400,
    "message": "Profissional informado nao encontrado",
    "detailedMessage": "Entre em contato com o Suporte"
}