Histórico da Página

...

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Falha
linenumbers	true
collapse	true

{
  "code": "E001",
  "message": "Beneficiário não encontrado.",
  "detailedMessage": "Não foi encontrado nenhum Beneficiário com a matricula 00011008000027012"
}

Informações

title	Pontos de Entrada

A rotina antiga da Posição do Beneficiário possuía alguns pontos de entrada para customizar a busca das autorizações, portanto foi criado o seguinte ponto de entrada:

Dados da Autorização

Retorna os dados da autorização

...

Retorna uma coleção com os eventos da autorização

Endpoint

https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/authorizations/{authorizationId}/events

Image Modified

Parâmetros

Authorization (header)	Image Modified	Cabeçalho usado para autorização das requisições	*required
Content-Type (header)	Image Modified	'application/json' é o formato do conteúdo	*required
authorizationId (path)	Image Modified	Chave de Identificação da Autorização	*required
fields (query)	Image Modified	Filtro de campos dos registros

...

Request

Não possui body!

...

Operação realizada com sucesso (200)

items	Image Modified	Eventos da Autorização
items.{campo do SX3}	Image Modified	Os campos retornados da autorização Tabela BD6 (Autorizações do Proc. Contas): bd6_codpad bd6_codpro bd6_despro bd6_qtdpro bd6_datpro bd6_status bd6_vlrbpr bd6_vlrapr bd6_vlracb bd6_vlrman bd6_vlrglo bd6_vlrpag bd6_vltxpg bd6_vlrbpf bd6_vlrpf bd6_vlrpf bd6_percop bd6_vlrtad bd6_pertad bd6_vlrtpf bd6_valor bd6_prprrl bd6_vrprda Tabela BEA (Autorizações de origem HAT - Portal Autorizador): be2_codpad be2_codpro be2_despro be2_qtdpro be2_datpro be2_status be2_vlrapr be2_prprrl be2_vlcomp Tabela BEJ (Solic. de Internação): bej_codpad bej_codpro bej_despro bej_qtdpro bej_datpro bej_status bej_vlrapr bej_valori
struct	Image Modified	Estrutura dos fields de acordo com o dicionário de dados (SX3)
hasNext	Image Modified	Indica se ainda existem registros a serem retornados
remainingRecords	Image Modified	Quantidade de registros ainda existem para retorno

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Sucesso
linenumbers	true
collapse	true

{
  "items": [
    {
      "bd6_codpad": "01",
      "bd6_codpro": "10101012",
      "bd6_despro": "CONSULTA EM CONSULTORIO",
      "bd6_qtdpro": 1,
      "bd6_vlrbpr": 76.4,
      "bd6_vlrapr": 0,
      "bd6_vlracb": 0,
      "bd6_vlrman": 77.12,
      "bd6_vlrglo": 0,
      "bd6_vlrpag": 77.12,
      "bd6_vltxpg": 0,
      "bd6_vlrbpf": 76.4,
      "bd6_vlrpf": 15.28,
      "bd6_percop": 20,
      "bd6_vlrtad": 0,
      "bd6_pertad": 0,
      "bd6_vlrtpf": 15.28,
      "bd6_datpro": "2022-11-1",
      "bd6_status": "1",
      "bd6_valor": 0,
      "bd6_prprrl": 0,
      "bd6_vrprda": 0
    }
  ],
  "hasNext": false,
  "remainingRecords": 0,
  "struct": [
    {
      "field": "BD6_CODPAD",
      "type": "C",
      "title": "Cd.Tp.Tabela",
      "description": "Cod Tipo Tabela",
      "picture": "@!",
      "size": 2,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BD6_CODPRO",
      "type": "C",
      "title": "Cd.Proc.",
      "description": "Cod Proc.",
      "picture": "@!",
      "size": 16,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BD6_DESPRO",
      "type": "C",
      "title": "Desc. Proc.",
      "description": "Desc Proc.",
      "picture": "@!",
      "size": 80,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BD6_QTDPRO",
      "type": "N",
      "title": "Qtd Realizad",
      "description": "Quantidade Realizada",
      "picture": "9999.99",
      "size": 9,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_VLRBPR",
      "type": "N",
      "title": "Vlr.Contr.",
      "description": "Valor Contrato Prestador",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_VLRAPR",
      "type": "N",
      "title": "Vlr.Apr.Pag.",
      "description": "Vlr Apresentado Pagamento",
      "picture": "@E 999,999,999.9999",
      "size": 17,
      "decimals": 4,
      "cbox": []
    },
    {
      "field": "BD6_VLRACB",
      "type": "N",
      "title": "Vlr.Apr.Cob.",
      "description": "Vlr Apresentado Cobranca",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_VLRMAN",
      "type": "N",
      "title": "Vlr.Bs.Pagto",
      "description": "Valor Base Pagto",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_VLRGLO",
      "type": "N",
      "title": "Vlr.Glosas",
      "description": "Valor Glosas",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_VLRPAG",
      "type": "N",
      "title": "Vlr.Pagto",
      "description": "Valor PAGTO",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_VLTXPG",
      "type": "N",
      "title": "Vlr.Taxa Pg.",
      "description": "Valor Taxa Adm. Pagto",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_VLRBPF",
      "type": "N",
      "title": "Vlr.Base PF",
      "description": "Valor Base PF",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_VLRPF",
      "type": "N",
      "title": "Vlr.Co-Par",
      "description": "Valor Co-Participacao",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_PERCOP",
      "type": "N",
      "title": "% Co-Part.",
      "description": "% Co-Participacao",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_VLRTAD",
      "type": "N",
      "title": "Vlr.Taxa.Adm",
      "description": "Valor Taxa Administracao",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_PERTAD",
      "type": "N",
      "title": "% Taxa Adm.",
      "description": "% Taxa Administracao",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_VLRTPF",
      "type": "N",
      "title": "Vlr.Total PF",
      "description": "Valor Total PF",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_DATPRO",
      "type": "D",
      "title": "Dt.Proced.",
      "description": "Data Proced.",
      "picture": "@D",
      "size": 8,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BD6_STATUS",
      "type": "C",
      "title": "Status",
      "description": "Status",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Autorizada"
        },
        {
          "value": "0",
          "description": "Nao Autorizada"
        }
      ]
    },
    {
      "field": "BD6_VALOR",
      "type": "N",
      "title": "Vlr. Compra",
      "description": "Valor da Compra",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_PRPRRL",
      "type": "N",
      "title": "Percentual",
      "description": "Percentual",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BD6_VRPRDA",
      "type": "N",
      "title": "Vlr.Pag.Rda",
      "description": "Valor Pagto Direto aRDA?",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    }
  ]
}

Dados Inválidos (404)

code	Image Modified	Código identificador do erro. (Tabela de Erros)
message	Image Modified	Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage	Image Modified	Mensagem técnica e mais detalhada do erro.

Bloco de código

language	c#
theme	Midnight
title	Exemplo de retorno - Falha
linenumbers	true
collapse	true

{
  "code": "E001",
  "message": "Beneficiário não encontrado.",
  "detailedMessage": "Não foi encontrado nenhum Beneficiário com a matricula 00011008000027012"
}

...

Árvore de páginas

Versões comparadas

Versão antiga 5

Nova versão 6

Chave

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Dados Inválidos (404)