Histórico da Página
...
- Visão Geral
- Configurações INI
- Verbos
- Exemplo de Chamada da API
- Atributos de Resposta
- Exemplos de JSON de Resposta
01. VISÃO GERAL
A API authorizationBatch tem como objetivo alterar o número do código do lote do Portal Autorizador (BEA_LOTHAT) na tabela BEA da guia ou lote informado. O verbo disponibilizado é o PUT.
02. CONFIGURAÇÕES INI
0Para 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 |
|---|---|---|
| PUT | https://<url>:porta>/rest/totvsHealthPlans/v1/authorizationBatch | Altera o número do código do lote do Portal Autorizador (BEA_LOTHAT) |
04. USO DA API
PUT - ALTERA O NÚMERO DO CÓDIGO DO LOTE DO PORTAL AUTORIZADOR (BEA_LOTHAT)
Queryparams:
Atributo | Tipo | Regra | Descrição |
|---|---|---|---|
| batchCode | Caracter | Obrigatório | Caso o queryParam idOnHealthInsurer não seja informado, o batchCode se torna obrigatório |
| idOnHealthInsurer | Caracter | Obrigatório | Caso o queryParam batchCode não seja informado, o idOnHealthInsurer se torna obrigatório |
action | Caracter | Obrigatório | Se action = DELETE, o campo BEA_LOTHAT do lote (batchCode) ou da guia (idOnHealthInsurer) será limpo Se action = CREATE, o campo BEA_LOTHAT do lote da guia (idOnHealthInsurer) será preenchido com o valor (batchCode) |
04. EXEMPLO DE CHAMADA DA API
...
| QueryParams | Descrição | Tipo |
|---|---|---|
| action | DELETE | Caracter |
| idOnHealthInsurer | Número da Guia | Caracter |
Chamada PUT - Alterando BEA_LOTHAT com a action DELETE informando batchCode
...
| QueryParams | Descrição | Tipo |
|---|---|---|
| action | DELETE | Caracter |
| batchCode | Código do lote do Portal Autorizador | Caracter |
Chamada PUT - Alterando BEA_LOTHAT com a action CREATE informando idOnHealthInsurer e batchCode
...
http://localhost:8080/rest/totvshealthplans/v1/authorizationBatch?action=CREATE&idOnHealthInsurer='000120240200000103', '000120240200000105'&batchCode=00003282
| Atributo | Descrição | Tipo |
|---|---|---|
| action | CREATE | Caracter |
| idOnHealthInsurer | Números das Guias | Caracter |
| batchCode | Código do lote do Portal Autorizador | Caracter |
05. ATRIBUTOS DE RESPOSTA
...
CHAMADA PUT - Em caso de erro
| Atributo | Valor | Tipo |
|---|---|---|
| code | 400 | Caracter |
| message | Mensagem genérica de erro | Caracter |
| detailMessage | Mensagem explicativa do erro | Caracter |
06. EXEMPLOS DE JSON DE RESPOSTA
| Bloco de código | |||||
|---|---|---|---|---|---|
| |||||
{
"code": 400,
"message": "Erro na requisição!",
"detailedMessage": "Campo obrigatório não informado: 'action'"
} |
07. CRIAÇÃO DO CAMPO BEA_LOTHAT
X3_ARQUIVO | X3_ORDEM | X3_CAMPO | X3_TIPO | X3_TAMANHO | X3_DECIMAL | X3_TITULO | X3_TITSPA | X3_TITENG | X3_DESCRIC | X3_DESCSPA | X3_DESCENG | X3_PICTURE | X3_USADO | X3_NIVEL | X3_RESERV | X3_PROPRI | X3_BROWSE | X3_VISUAL | X3_CONTEXT | X3_OBRIGAT | X3_CBOX | X3_VALID |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| BEA | EZ | BEA_LOTHAT | Caractere | 8 | 0 | LOTE HAT | LOTE HAT | LOTE HAT | CODIGO LOTE HAT | CODIGO LOTE HAT | CODIGO LOTE HAT | @! | Sim | 1 | Sim | Visualizar | Real | Não |
Visão Geral
Import HTML Content
Conteúdo das Ferramentas
Tarefas