Histórico da Página

CONTEÚDO

Visão Geral
Configuração INI
Verbos
Uso da API
Exemplo de Chamada da API
Atributos de Resposta
Exemplos de JSON de Resposta

01. VISÃO GERAL

A API cbos tem como objetivo trabalhar com ações relacionadas aos CBOS de uma rede de atendimento.

VERBO GET

Através do verbo GET, informamos a rede e local de atendimento como queryParam e os CBOS correspondendo são devolvidos. Também tem a possibilidade de realizar um filtro na busca.

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/cbos. Exemplo:

Logo, a minha URL será: http://localhost:8080/rest/totvshealthplans/v1/cbos.

03. VERBOS

Seguem os verbos disponíveis na API:

Verbo	Path	Descrição
GET	cbos	CBOS da RDA

04. USO DA API

GET - CBOS DE UMA REDE E LOCAL DE ATENDIMENTO

Queryparams:

Atributo	Tipo	Regra	Descrição
healthProviderId	Caracter	Obrigatório	Código da RDA
locationCode	Caracter	Obrigatório	Código do Local de Atendimento da RDA
filter	Caracter	Opcional	Filtro que será aplicado aos CBOS. Pode ser tanto o código ou a descrição do CBOS.
pageSize	Caracter	Opcional	Controle de quantidade de itens que serão retornados.
page	Caracter	Opcional	Controle de paginação

05. EXEMPLO DE CHAMADA DA API

Chamada GET

Exemplo solicitando dados CBOS da RDA 000004 e local de atendimento 001, com o filtro "cardio":

http://spon019400235:8080/rest/totvshealthplans/v1/cbos?healthProviderId=000004&locationCode=001&filter=cardio

06. ATRIBUTOS DE RESPOSTA

Chamada GET

Atributo	Campo	Tipo
code	BTQ_CDTERM	Caracter
description	BTQ_DESTER	Caracter

07. EXEMPLOS DE JSON DE RESPOSTA

Solicitação GET

Bloco de código

title	Sucesso 200
collapse	true

{
    "items": [
        {
            "code": "225105",
            "description": "Médico acupunturista"
        },
        {
            "code": "225125",
            "description": "Médico clínico"
        },
        {
            "code": "201115",
            "description": "Geneticista"
        },
        {
            "code": "201115",
            "description": "Geneticista"
        },
        {
            "code": "203015",
            "description": "Pesquisador em biologia de microorganismos e parasitas"
        },
        {
            "code": "223208",
            "description": "Cirurgião dentista - clínico geral"
        },
        {
            "code": "223445",
            "description": "Farmacêutico hospitalar e clínico"
        },
        {
            "code": "225105",
            "description": "Médico acupunturista"
        },
        {
            "code": "225118",
            "description": "Médico nutrologista"
        },
        {
            "code": "225120",
            "description": "Médico cardiologista"
        },
        {
            "code": "225121",
            "description": "Médico oncologista clínico"
        },
        {
            "code": "225125",
            "description": "Médico clínico"
        },
        {
            "code": "225335",
            "description": "Médico patologista clínico / medicina laboratorial"
        }
    ],
    "hasNext": false
}

Bloco de código

title	Falha 400
collapse	true

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

Árvore de páginas

Versões comparadas

Versão antiga 2

Nova versão Atual

Chave