Árvore de páginas

Versões comparadas

Chave

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

...

03. VERBOS

Seguem os verbos disponíveis na API:

Verbo

URL

Descrição

POSThttps://<url>:porta>/rest/totvsHealthPlans/v1/pegTransferRealiza a transferência de guias entre as PEG´s


04. USO DA API - POST

A API não tem QueryParams específicos, ela recebe um JSON no body com o seguintes conteúdo:


AtributoTipoDescrição
batchNumberCaracterCódigo do lote gerado no Portal Autorizador
authTypeCaracter

Tipo do lote gerado. Valores válidos:

  • 1 - Consulta
  • 2 - SADT
  • 9 - Odonto
idOnHealthInsurerArrayArray com as guias que serão transferidas
Bloco de código
titleExemplo JSON de Envio
linenumberstrue
collapsetrue
{
    "batchNumber": "123456",
    "authType": "2",
    "idOnHealthInsurer":[
        "000120221100000032",
        "000120221100000033"
    ]
}


05

...

. ATRIBUTOS DE RESPOSTA

O JSON de resposta retorna o número do lote gerado no sistema de gestão SIGAPLS, valor do lote e quantidade de guias:

AtributoTipoDescrição
batchNumberCaracterCódigo do lote gerado sistema de gestão SIGAPLS.
valueNumber

Valor do lote gerado.

formQuantityNumberQuantidade de guias transferidas
Bloco de código
titleExemplo JSON de Resposta
linenumberstrue
{
    "batchNumber": "00000850",
    "value": 4.48,
    "formQuantity": 2
}