Histórico da Página
...
- 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 API professionals/{professionalCode}/cbos tem como objetivo trabalhar com ações relacionadas aos CBOS vinculadas a um profissional.
...
Através do verbo GET, informamos o código do profissional como queryParam pathParam e os CBOS vinculados a ele são devolvidos. Também tem a possibilidade de realizar um filtro na busca.
...
Seguem os verbos disponíveis na API:
Verbo | Path | Descrição |
|---|---|---|
| GET | professionals/{professionalCode}/cbos | CBOS vinculados ao profissional |
04. USO DA API
GET - CBOS VINCULADOS A UM PROFISSIONAL
Queryparams:
Atributo | Tipo | Regra | Descrição |
|---|---|---|---|
| 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
...
06. ATRIBUTOS DE RESPOSTA
Chamada GET
Atributo | Campo | Tipo |
|---|---|---|
| code | BTQ_CDTERM | Caracter |
| description | BTQ_DESTER | Caracter |
07. EXEMPLOS DE JSON DE RESPOSTA
...
| Bloco de código | ||||
|---|---|---|---|---|
| ||||
{
"code": 400,
"message": "PrestadorProfissional informado nao encontrado",
"detailedMessage": "Entre em contato com o Suporte"
} |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas