...
| Dica |
|---|
| title | Autenticação das APIs |
|---|
|
API para obtenção do token de acesso às API’s REST no Protheus De posse então do access_token obtido na api token, basta fazer a requisição à API desejada incluindo no cabeçalho o parâmetro Authorization com o valor Bearer mais o token de acesso. |
| Informações |
|---|
| title | Nomenclatura das APIs |
|---|
|
Para nome composto, as APIs utilizam o padrão camelCase e quando a houver paginação será utilizado o padrão tudo minúsculo separado por hífen para os campos dentro do array items |
02. EXEMPLO DE UTILIZAÇÃO
...
02. EXEMPLO DE UTILIZAÇÃO
| Âncora |
|---|
| RegionalCouncils |
|---|
| RegionalCouncils |
|---|
|
| Painel |
|---|
| titleColor | Orange |
|---|
| borderStyle | solid |
|---|
| title | RegionalCouncils - Retorna os conselhos regionais |
|---|
|
Retorna os conselhos regionais cadastrados no sistema. | /totvsHealthPlans/attendanceNetwork/v1/regionalCouncils | |
| Nota |
|---|
| Expandir |
|---|
| | Authorization (header) | | Cabeçalho usado para autorização das requisições (Bearer token) | *required | Content-Type (header) | | 'application/json' é o formato do conteúdo | *required | | code (query) | string | Filtro de conselhos regionais pelo código (BAH_CODIGO) |
| | description (query) | string | Filtro de conselhos regionais pela descrição (BAH_DESCRI) |
| | codeTiss (query) | string | Filtro de conselhos regionais pelo código TISS (BTU_CDTERM) (Quando houver vinculo TISS) |
| | descriptionTiss (query) | string | Filtro de conselhos regionais pela descrição TISS (BTQ_DESTER) (Quando houver vinculo TISS) |
| | page (query) | | Valor numérico (maior que zero) representando a página solicitada |
| | pageSize (query) | | Valor numérico (maior que zero) representando o total de registros retornados na consulta |
| | order (query) | | Lista de campos para ordenação, separada por virgula (,). |
| | fields (query) | | Lista com o nome das propriedades JSON que serão retornadas. |
| | filter (query) | | Filtros seguindo o padrão ODATA |
|
|
|
| Dica |
|---|
| Expandir |
|---|
| Body
Não possui body! |
|
| Dica |
|---|
| Expandir |
|---|
| title | (200) - Operação realizada com sucesso |
|---|
| | hasNext | boolean | Indica se ainda existem registros a serem retornados |
| *required | | remainingRecords | numeric (integer) | Quantidade de registros ainda existem para retorno |
| *required | | items | array | Lista de conselhos regionais |
|
| | items.code | string | Código do conselho regional | BAH_CODIGO | *required | | items.description | string | Descrição do conselho regional | BAH_DESCRI |
| items.code_tiss | string | Código TISS do conselho regional | BTU_CDTERM |
| | items.description_tiss | string | Descrição TISS do conselho regional | BTQ_DESTER |
|
| Bloco de código |
|---|
| language | c# |
|---|
| theme | Emacs |
|---|
| title | Exemplo |
|---|
| linenumbers | true |
|---|
| {
"items": [
{
"code": "COREN",
"description": "CONSELHO REGIONAL DE ENFERMAGEM",
"code_tiss": "",
"description_tiss": ""
},
{
"code": "CRFA",
"description": "CONSELHO REGIONAL DE FONOAUDIOLOGIA",
"code_tiss": "",
"description_tiss": ""
},
{
"code": "CRFITO",
"description": "CONSELHO REGIONAL DE FISIOTERAPIA OCUPACIONAL",
"code_tiss": "",
"description_tiss": ""
},
{
"code": "CRM",
"description": "CONSELHO REGIONAL DE MEDICINA",
"code_tiss": "06",
"description_tiss": "Conselho Regional de Medicina (CRM)"
},
{
"code": "CRN",
"description": "CONSELHO REGIONAL DE NUTRICAO",
"code_tiss": "",
"description_tiss": ""
}
],
"hasNext": true,
"remainingRecords": 2
} |
|
|
|
03. TELA REGIONALCOUNCILS
Outras Ações / Ações relacionadas
| Ação | Descrição |
|---|
| Não se aplica | Não se aplica |
04.
...
TELA REGIONALCOUNCILS
Principais Campos e Parâmetros
| Card documentos |
|---|
| Informacao | Use esse box para destacar informações relevantes e/ou de destaque. |
|---|
| Titulo | IMPORTANTE! |
|---|
|
| BAH_CODIGO | Código do Conselho Regional |
| BAH_DESCRI | Descrição do Conselho Regional |
05. TABELAS UTILIZADAS
- Siglas de Conselhos Regionais (BAH)
- Relação TISS x Protheus (BTU)
- Detalhe das Terminologias TISS (BTQ)
