Linha Microsiga Protheus

Árvore de páginas

Versões comparadas

Versão antiga 2

changes.mady.by.user Nicole Duarte Luna

Gravado em

comparado com

Nova versão 3

changes.mady.by.user Nicole Duarte Luna

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

  1. Visão Geral
  2. Configurações INI
  3. Verbos
  4. Exemplo de Chamada da API
  5. Atributos de Resposta
  6. 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

PUThttps://<url>:porta>/rest/totvsHealthPlans/v1/authorizationBatchAltera 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

batchCodeCaracterObrigatório

Caso o queryParam idOnHealthInsurer não seja informado, o batchCode se torna obrigatório 

idOnHealthInsurerCaracterObrigatório

Caso o queryParam batchCode não seja informado, o idOnHealthInsurer se torna obrigatório

action

CaracterObrigató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

...

http://localhost:8080/rest/totvsHealthPlans/v1/authorizationBatch?action=DELETE&idOnHealthInsurer='000120240200000103'


QueryParamsDescriçãoTipo
actionDELETECaracter
 idOnHealthInsurer Número da GuiaCaracter



Chamada PUT - Alterando BEA_LOTHAT com a action DELETE informando batchCode

...

http://10.171.80.125:3269/rest/totvshealthplans/v1/authorizationBatch?action=DELETE&batchCode=00003282


QueryParamsDescriçãoTipo
actionDELETECaracter
batchCodeCódigo do lote do Portal AutorizadorCaracter


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


AtributoDescriçãoTipo
actionCREATECaracter
idOnHealthInsurer Números das GuiasCaracter
batchCodeCódigo do lote do Portal AutorizadorCaracter


05. ATRIBUTOS DE RESPOSTA

...

CHAMADA PUT - Em caso de erro

AtributoValorTipo
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
titleSucesso 202 - Guia encontradaErro
collapsetrue
{
    "code": 400,
    "message": "Erro na requisição!",
    "detailedMessage": "Campo obrigatório não informado: 'action'"
}

...