Histórico da Página

...

Esses endpoints serão utilizados na nova tela de posição Gestão do beneficiárioBeneficiário, desenvolvida em PO UI. (Biblioteca de componentes baseado em Angular)

...

Bloco de código

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

{
  "items": [
    {
      "bd5_codldp": "9999",
      "bd5_codpeg": "00000499",
      "bd5_numero": "00000001",
      "bd5_datpro": "2022-11-1",
      "bd5_codrda": "000004",
      "bd5_nomrda": "HOSPITAL BOM CLIMA",
      "bd5_tipgui": "01",
      "bd5_fase": "3",
      "bd5_situac": "1",
      "bcl_descri": "GUIA DE CONSULTA",
      "authorizationid": "BD5-000199990000049900000001"
    },
    {
      "bd5_codldp": "9999",
      "bd5_codpeg": "00000500",
      "bd5_numero": "00000001",
      "bd5_datpro": "2022-11-1",
      "bd5_codrda": "000004",
      "bd5_nomrda": "HOSPITAL BOM CLIMA",
      "bd5_tipgui": "02",
      "bd5_fase": "3",
      "bd5_situac": "1",
      "bcl_descri": "GUIA DE SP_SADT",
      "authorizationid": "BEA-000199990000050000000001"
    },
    {
      "bd5_codldp": "9999",
      "bd5_codpeg": "00000501",
      "bd5_numero": "00000001",
      "bd5_datpro": "2022-11-1",
      "bd5_codrda": "000004",
      "bd5_nomrda": "HOSPITAL BOM CLIMA",
      "bd5_tipgui": "03",
      "bd5_fase": "1",
      "bd5_situac": "1",
      "bcl_descri": "GUIA DE SOL. INTERNACAO",
      "authorizationid": "BE4-000199990000050100000001"
    }
  ],
  "hasNext": false,
  "remainingRecords": 0,
  "struct": [
    {
      "field": "BD5_CODLDP",
      "type": "C",
      "title": "Cd.Local Dig",
      "description": "Codigo Local Digitacao",
      "picture": "@!",
      "size": 4,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BD5_CODPEG",
      "type": "C",
      "title": "Código PEG",
      "description": "Codigo PEG",
      "picture": "@!",
      "size": 8,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BD5_NUMERO",
      "type": "C",
      "title": "Número",
      "description": "Numero da Movimentacao",
      "picture": "@!",
      "size": 8,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BD5_DATPRO",
      "type": "D",
      "title": "Data Evento",
      "description": "Data Evento",
      "picture": "",
      "size": 8,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BD5_CODRDA",
      "type": "C",
      "title": "Cd.Cred/Coop",
      "description": "Cod. Credenc",
      "picture": "@!",
      "size": 6,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BD5_NOMRDA",
      "type": "C",
      "title": "Nm.Cred/Coop",
      "description": "credenciado",
      "picture": "@!",
      "size": 40,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BD5_TIPGUI",
      "type": "C",
      "title": "Tp. Guia",
      "description": "Tipo de Guia",
      "picture": "@!",
      "size": 2,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BD5_FASE",
      "type": "C",
      "title": "Fase",
      "description": "Fase",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Digitacao"
        },
        {
          "value": "2",
          "description": "Conferencia"
        },
        {
          "value": "3",
          "description": "Pronta"
        },
        {
          "value": "4",
          "description": "Faturada"
        },
        {
          "value": "5",
          "description": "Processando"
        }
      ]
    },
    {
      "field": "BD5_SITUAC",
      "type": "C",
      "title": "Situação",
      "description": "Situacao",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Ativa"
        },
        {
          "value": "2",
          "description": "Cancelada"
        },
        {
          "value": "3",
          "description": "Bloqueada"
        }
      ]
    },
    {
      "field": "BCL_DESCRI",
      "type": "C",
      "title": "Descricao",
      "description": "Descricao",
      "picture": "@!",
      "size": 30,
      "decimals": 0,
      "cbox": []
    }
  ]
}

...

Mensagens de Erros

code		Código identificador do erro. (Tabela de Erros)
message		Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage		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"
}

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:

DT PE Filtrar as Autorizações do Beneficiário - Gestão do Beneficiário (PO UI)

Dados da Autorização

Retorna os dados da autorização

Endpoint

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

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

fields

Image Removed

Image Added

Autorizações do Beneficiário

items

fields.{campo do SX3}

Image Modified

Os campos retornados da tabela

SE1

de autorização:

Tabela BD5 (Autorizações do Proc. Contas):

bd5_codope
bd5_codldp
bd5_codpeg
bd5_numero
bd5_situac
bd5_fase
bd5_tipadm
bd5_desadm
bd5_datpro
bd5_codrda
bd5_nomrda
bd5_

tipgui

regsol
bd5_

fase

nomsol
bd5_

situac

tipate

bcl

bd5_

descri

items.authorizationid

Image Removed

Chave identificador da autorização para ser utilizado nos endpoints:

/totvsHealthPlans/v1/beneficiaryPosition/authorizations/{authorizationId}
/totvsHealthPlans/v1/beneficiaryPosition/authorizations/{authorizationId}/events

Campo: ALIAS+BD5_CODOPE+BD5_CODLDP+BD5_CODPEG+BD5_NUMERO

struct

Image Removed

Estrutura dos fields de acordo com o dicionário de dados (SX3)

hasNext

Image Removed

Indica se ainda existem registros a serem retornadosremainingRecords

Image Removed

Quantidade de registros ainda existem para retorno

cid
bd5_descid
bd5_datsol
bd5_horsol
bd5_aterna
bd5_indaci
bd5_tipcon
bd5_indcli
bd5_indcl2
bd5_cidsec
bd5_cid3
bd5_cid4
bd5_cid5
bd5_valor
bd5_vlrbpr
bd5_vlrman
bd5_vlrglo
bd5_vlrpag
bd5_vlrbpf
bd5_vlrpf
bd5_vlrtad
bd5_vlrtpf

Tabela BEA (Autorizações de origem HAT - Portal Autorizador):

bea_opemov
bea_codldp
bea_codpeg
bea_numgui
bea_datpro
bea_tipadm
bea_datpro
bea_codrda
bea_nomrda
bea_regsol
bea_nomsol
bea_tipate
bea_cid
bea_descid
bea_cancel
bea_datsol
bea_horsol
bea_aterna
bea_indaci
bea_tipcon
bea_indcli
bea_indcl2
bea_cidsec
bea_cid3
bea_cid4
bea_cid5
bea_vlrpac
bea_valor

Tabela BE4 (Solic. de Internação):

be4_codope
be4_codldp
be4_codpeg
be4_numero
be4_situac
be4_fase
be4_tipadm
be4_desadm
be4_dtdigi
be4_codrda
be4_nomrda
be4_regsol
be4_nomsol
be4_cid
be4_descid
be4_cancel
be4_aterna
be4_indaci
be4_tipcon
be4_indcli
be4_indcl2
be4_prvint
be4_horpro
be4_datpro
be4_dtalta
be4_hralta
be4_tipalt
be4_desalt
be4_tipint
be4_destip
be4_regint
be4_tpodoe
be4_tipdoe
be4_cidsec
be4_cid3
be4_cid4
be4_cid5
be4_padint
be4_despad
be4_prequi
be4_preope
be4_vlrapr
be4_vlrbpf
be4_vlrbpr
be4_vlrglo
be4_vlrman
be4_vlrpag
be4_vlrpf
be4_vlrpac
be4_vlrtad
be4_vlrtpf

struct

Image Added

Estrutura dos fields de acordo com o dicionário de dados (SX3)

folders

Image Added

Pastas do fields (Abas) de acordo com o dicionário de dados (SXA)

Bloco de código

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

{
  "fields": {
    "bd5_codope": "0001",
    "bd5_codldp": "9999",
    "bd5_codpeg": "00000499",
    "bd5_numero": "00000001",
    "bd5_datpro": "2022-11-01",
    "bd5_codrda": "000004",
    "bd5_nomrda": "HOSPITAL BOM CLIMA",
    "bd5_cid": "Z000",
    "bd5_descid": "EXAME MEDICO GERAL",
    "bd5_cidsec": "",
    "bd5_regsol": "280384",
    "bd5_nomsol": "ALINE MARGON PERINI",
    "bd5_tipcon": "1",
    "bd5_valor": 0,
    "bd5_vlrbpr": 76.4,
    "bd5_vlrman": 77.12,
    "bd5_vlrglo": 0,
    "bd5_vlrpag": 77.12,
    "bd5_vlrbpf": 76.4,
    "bd5_vlrpf": 15.28,
    "bd5_fase": "3",
    "bd5_situac": "1",
    "bd5_aterna": "0",
    "bd5_cid3": "",
    "bd5_cid4": "",
    "bd5_cid5": "",
    "bd5_vlrtad": 0,
    "bd5_vlrtpf": 15.28,
    "bd5_indaci": "",
    "bd5_datsol": "2022-11-01",
    "bd5_horsol": "1904",
    "bd5_indcli": "",
    "bd5_indcl2": "",
    "bd5_tipate": "07",
    "bd5_tipadm": "6",
    "bd5_desadm": "ELETIVA / PROGRAMADA / ROTINA"
  },
  "struct": [
    {
      "field": "BD5_CODOPE",
      "type": "C",
      "title": "Operadora",
      "description": "Operadora",
      "picture": "@!",
      "size": 4,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "03"
    },
    {
      "field": "BD5_CODLDP",
      "type": "C",
      "title": "Cd.Local Dig",
      "description": "Codigo Local Digitacao",
      "picture": "@!",
      "size": 4,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "10"
    },
    {
      "field": "BD5_CODPEG",
      "type": "C",
      "title": "Código PEG",
      "description": "Codigo PEG",
      "picture": "@!",
      "size": 8,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "11"
    },
    {
      "field": "BD5_NUMERO",
      "type": "C",
      "title": "Número",
      "description": "Numero da Movimentacao",
      "picture": "@!",
      "size": 8,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "12"
    },
    {
      "field": "BD5_DATPRO",
      "type": "D",
      "title": "Data Evento",
      "description": "Data Evento",
      "picture": "",
      "size": 8,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "14"
    },
    {
      "field": "BD5_CODRDA",
      "type": "C",
      "title": "Cd.Cred/Coop",
      "description": "Cod. Credenc",
      "picture": "@!",
      "size": 6,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "20"
    },
    {
      "field": "BD5_NOMRDA",
      "type": "C",
      "title": "Nm.Cred/Coop",
      "description": "credenciado",
      "picture": "@!",
      "size": 40,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "24"
    },
    {
      "field": "BD5_CID",
      "type": "C",
      "title": "CID",
      "description": "CID",
      "picture": "@!",
      "size": 8,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "31"
    },
    {
      "field": "BD5_DESCID",
      "type": "C",
      "title": "Desc. CID",
      "description": "Desc CID",
      "picture": "@!",
      "size": 50,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "32"
    },
    {
      "field": "BD5_REGSOL",
      "type": "C",
      "title": "C.R. Solic.",
      "description": "C.R Solicita",
      "picture": "@R !!!!!!!!!!",
      "size": 15,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "38"
    },
    {
      "field": "BD5_NOMSOL",
      "type": "C",
      "title": "Solicitante",
      "description": "Solicitante",
      "picture": "@!",
      "size": 30,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "39"
    },
    {
      "field": "BD5_TIPCON",
      "type": "C",
      "title": "Tp. Consulta",
      "description": "Tp Consulta",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Primeira"
        },
        {
          "value": "2",
          "description": "Retorno "
        },
        {
          "value": "3",
          "description": "Pre-Natal"
        },
        {
          "value": "4",
          "description": "Por Encaminhamento"
        }
      ],
      "folder": "1",
      "order": "40"
    },
    {
      "field": "BD5_ATERNA",
      "type": "C",
      "title": "Atdo.Rec.Na?",
      "description": "Atendimento Recem Nascido",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Sim"
        },
        {
          "value": "0",
          "description": "Nao"
        }
      ],
      "folder": "1",
      "order": "73"
    },
    {
      "field": "BD5_INDACI",
      "type": "C",
      "title": "Indic Aciden",
      "description": "Indicação de Acidente",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "0",
          "description": "Trabalho"
        },
        {
          "value": "1",
          "description": "Trânsito"
        },
        {
          "value": "2",
          "description": "Outros"
        },
        {
          "value": "9",
          "description": "Nao Acidente"
        }
      ],
      "folder": "1",
      "order": "AN"
    },
    {
      "field": "BD5_DATSOL",
      "type": "D",
      "title": "Data Solicit",
      "description": "Data Solicitação",
      "picture": "@D",
      "size": 8,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "AQ"
    },
    {
      "field": "BD5_HORSOL",
      "type": "C",
      "title": "Hora Solicit",
      "description": "Hora Solicitação",
      "picture": "@R !!:!!",
      "size": 4,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "AR"
    },
    {
      "field": "BD5_INDCLI",
      "type": "C",
      "title": "Indic Clínic",
      "description": "Indicação Clínica",
      "picture": "@S70",
      "size": 250,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "AS"
    },
    {
      "field": "BD5_INDCL2",
      "type": "C",
      "title": "Cont. IndClí",
      "description": "Indicação Clínica",
      "picture": "@S70",
      "size": 250,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "AT"
    },
    {
      "field": "BD5_TIPATE",
      "type": "C",
      "title": "Tipo Atendim",
      "description": "Tipo Atendimento",
      "picture": "@!",
      "size": 2,
      "decimals": 0,
      "cbox": [
        {
          "value": "01",
          "description": "Remoção"
        },
        {
          "value": "02",
          "description": "Pequena Cirurgia"
        },
        {
          "value": "03",
          "description": "Outras Terapias"
        },
        {
          "value": "04",
          "description": "Consulta"
        },
        {
          "value": "05",
          "description": "Exame Ambulatorial"
        },
        {
          "value": "06",
          "description": "Atendimento Domiciliar"
        },
        {
          "value": "07",
          "description": "Internação"
        },
        {
          "value": "08",
          "description": "Quimioterapia"
        },
        {
          "value": "09",
          "description": "Radioterapia"
        },
        {
          "value": "10",
          "description": "Terapia Renal Substitutiva (TRS)"
        },
        {
          "value": "11",
          "description": "Pronto Socorro"
        },
        {
          "value": "13",
          "description": "Pequeno atendimento (sutura, gesso e outros)"
        },
        {
          "value": "14",
          "description": "Saúde Ocupacional - Admissional"
        },
        {
          "value": "15",
          "description": "Saúde Ocupacional - Demissional"
        },
        {
          "value": "16",
          "description": "Saúde Ocupacional - Periódico"
        },
        {
          "value": "17",
          "description": "Saúde Ocupacional - Retorno ao trabalho"
        },
        {
          "value": "18",
          "description": "Saúde Ocupacional - Mudança de função"
        },
        {
          "value": "19",
          "description": "Saúde Ocupacional - Promoção a saúde"
        },
        {
          "value": "20",
          "description": "Saúde Ocupacional - Beneficiário novo"
        },
        {
          "value": "21",
          "description": "Saúde Ocupacional - Assistência a demitidos"
        },
        {
          "value": "22",
          "description": "TELESSAÚDE"
        },
        {
          "value": "23",
          "description": "Exame"
        }
      ],
      "folder": "1",
      "order": "AV"
    },
    {
      "field": "BD5_TIPADM",
      "type": "C",
      "title": "Tp. Admissao",
      "description": "Tp. Admissao",
      "picture": "@!",
      "size": 6,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "BI"
    },
    {
      "field": "BD5_DESADM",
      "type": "C",
      "title": "Descricao",
      "description": "Descricao",
      "picture": "@C",
      "size": 30,
      "decimals": 0,
      "cbox": [],
      "folder": "1",
      "order": "BJ"
    },
    {
      "field": "BD5_VALOR",
      "type": "N",
      "title": "Vlr.Compra",
      "description": "Valor Guia Comprada",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": [],
      "folder": "5",
      "order": "51"
    },
    {
      "field": "BD5_VLRBPR",
      "type": "N",
      "title": "Vlr.Contr.",
      "description": "Valor Contrato Prestador",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": [],
      "folder": "5",
      "order": "52"
    },
    {
      "field": "BD5_VLRMAN",
      "type": "N",
      "title": "Vlr.Bs.Pagto",
      "description": "Valor Procedimento",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": [],
      "folder": "5",
      "order": "53"
    },
    {
      "field": "BD5_VLRGLO",
      "type": "N",
      "title": "Vlr.Glosas",
      "description": "Valor Glosas",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": [],
      "folder": "5",
      "order": "54"
    },
    {
      "field": "BD5_VLRPAG",
      "type": "N",
      "title": "Vlr.Pagto",
      "description": "Valor Pagto Prestador",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": [],
      "folder": "5",
      "order": "55"
    },
    {
      "field": "BD5_VLRBPF",
      "type": "N",
      "title": "Vlr.Base PF",
      "description": "Valor Base Part. Financ.",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": [],
      "folder": "5",
      "order": "56"
    },
    {
      "field": "BD5_VLRPF",
      "type": "N",
      "title": "Vlr.Co-Par",
      "description": "Valor Co-Participacao",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": [],
      "folder": "5",
      "order": "57"
    },
    {
      "field": "BD5_VLRTAD",
      "type": "N",
      "title": "Vlr.Taxa.Adm",
      "description": "Valor Taxa Administracao",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": [],
      "folder": "5",
      "order": "91"
    },
    {
      "field": "BD5_VLRTPF",
      "type": "N",
      "title": "Vlr.Total PF",
      "description": "Valor Total PF",
      "picture": "@E 999,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": [],
      "folder": "5",
      "order": "92"
    },
    {
      "field": "BD5_CIDSEC",
      "type": "C",
      "title": "CID Secund.",
      "description": "CID Secundario",
      "picture": "@!",
      "size": 8,
      "decimals": 0,
      "cbox": [],
      "folder": "8",
      "order": "34"
    },
    {
      "field": "BD5_FASE",
      "type": "C",
      "title": "Fase",
      "description": "Fase",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Digitacao"
        },
        {
          "value": "2",
          "description": "Conferencia"
        },
        {
          "value": "3",
          "description": "Pronta"
        },
        {
          "value": "4",
          "description": "Faturada"
        },
        {
          "value": "5",
          "description": "Processando"
        }
      ],
      "folder": "8",
      "order": "59"
    },
    {
      "field": "BD5_SITUAC",
      "type": "C",
      "title": "Situação",
      "description": "Situacao",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Ativa"
        },
        {
          "value": "2",
          "description": "Cancelada"
        },
        {
          "value": "3",
          "description": "Bloqueada"
        }
      ],
      "folder": "8",
      "order": "60"
    },
    {
      "field": "BD5_CID3",
      "type": "C",
      "title": "CID 3",
      "description": "CID 3",
      "picture": "@!",
      "size": 8,
      "decimals": 0,
      "cbox": [],
      "folder": "8",
      "order": "78"
    },
    {
      "field": "BD5_CID4",
      "type": "C",
      "title": "CID 4",
      "description": "CID 4",
      "picture": "@!",
      "size": 8,
      "decimals": 0,
      "cbox": [],
      "folder": "8",
      "order": "80"
    },
    {
      "field": "BD5_CID5",
      "type": "C",
      "title": "CID 5",
      "description": "CID 5",
      "picture": "@!",
      "size": 8,
      "decimals": 0,
      "cbox": [],
      "folder": "8",
      "order": "82"
    }
  ],
  "folders": [
    {
      "id": "1",
      "title": "Dados Principais"
    },
    {
      "id": "2",
      "title": "Rede Atendimento"
    },
    {
      "id": "3",
      "title": "Usuario"
    },
    {
      "id": "4",
      "title": "Solicitante"
    },
    {
      "id": "5",
      "title": "Financeiro"
    },
    {
      "id": "6",
      "title": "Procedimento"
    },
    {
      "id": "7",
      "title": "ANS"
    },
    {
      "id": "8",
      "title": "Outros"
    },
    {
      "id": "9",
      "title": "Produtividade"
    },
    {
      "id": "A",
      "title": "Proc em Serie"
    }
  ]
}

Mensagens de Erros

code	Image Added	Código identificador do erro. (Tabela de Erros)
message	Image Added	Literal no idioma da requisição descrevendo o erro para o usuário.
detailedMessage	Image Added	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"
}

Informações

title	Pontos de Entrada

A rotina antiga da Posição do Beneficiário possuía alguns parâmetros para customizar os campos que serão apresentados no cabeçalho da autorização, portanto foi criado o seguinte ponto de entrada:

DT PE Adicionar Novos Campos no Cabeçalho da Autorização - Gestão do Beneficiário (PO UI)

Eventos 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 Added

Parâmetros

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

...

Request

Não possui body!

...

Operação realizada com sucesso (200)

items	Image Added	Eventos da Autorização
items.{campo do SX3}	Image Added	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 Added	Estrutura dos fields de acordo com o dicionário de dados (SX3)
hasNext	Image Added	Indica se ainda existem registros a serem retornados
remainingRecords	Image Added	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

Bloco de código

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

{
  "items": [
    {
      "bd5_codldp": "9999",
      "bd5_codpegpicture": "00000499@E 999,999,999.9999",
      "bd5_numerosize": 17,
      "00000001decimals": 4,
      "bd5_datprocbox": "2022-11-1", []
    },
    {
      "bd5_codrdafield": "000004BD6_VLRACB",
      "bd5_nomrdatype": "HOSPITAL BOM CLIMAN",
      "bd5_tipguititle": "01Vlr.Apr.Cob.",
      "bd5_fasedescription": "3Vlr Apresentado Cobranca",
      "bd5_situacpicture": "1@E 999,999,999.99",
      "bcl_descrisize": "GUIA DE CONSULTA" 17,
      "decimals": 2,
      "authorizationidcbox": "BD5-000199990000049900000001"[]
    },
    {
      "bd5_codldpfield": "9999BD6_VLRMAN",
      "bd5_codpegtype": "00000500N",
      "bd5_numerotitle": "00000001Vlr.Bs.Pagto",
      "bd5_datprodescription": "2022-11-1",
      "bd5_codrda": "000004Valor Base Pagto",
      "bd5_nomrdapicture": "HOSPITAL BOM CLIMA@E 999,999,999.99",
      "bd5_tipguisize": "02"17,
      "bd5_fasedecimals": "3"2,
      "bd5_situaccbox": "1" []
    },
    {
  "bcl_descri    "field": "GUIA DE SP_SADTBD6_VLRGLO",
      "authorizationidtype": "BEA-000199990000050000000001N",
    },
    {"title": "Vlr.Glosas",
      "bd5_codldpdescription": "9999Valor Glosas",
      "bd5_codpeg": "00000501"picture": "@E 999,999,999.99",
      "bd5_numerosize": "00000001"17,
      "bd5_datprodecimals": "2022-11-1"2,
      "bd5_codrdacbox": "000004",[]
      "bd5_nomrda": "HOSPITAL BOM CLIMA",},
    {
      "bd5_tipguifield": "03BD6_VLRPAG",
      "bd5_fasetype": "1N",
      "bd5_situactitle": "1Vlr.Pagto",
      "bcl_descridescription": "GUIA DE SOL. INTERNACAOValor PAGTO",
      "authorizationidpicture": "BE4-000199990000050100000001"
    }
  ],
@E 999,999,999.99",
      "hasNextsize": false17,
      "remainingRecordsdecimals": 02,
      "structcbox": []
    },
    {
      "field": "BD5BD6_CODLDPVLTXPG",
      "type": "CN",
      "title": "CdVlr.LocalTaxa DigPg.",
      "description": "Codigo Local DigitacaoValor Taxa Adm. Pagto",
      "picture": "@!@E 999,999,999.99",
      "size": 417,
      "decimals": 02,
      "cbox": []
    },
    {
      "field": "BD5BD6_CODPEGVLRBPF",
      "type": "CN",
      "title": "CódigoVlr.Base PEGPF",
      "description": "CodigoValor Base PEGPF",
      "picture": "@!@E 999,999,999.99",
      "size": 817,
      "decimals": 02,
      "cbox": []
    },
    {
      "field": "BD5BD6_NUMEROVLRPF",
      "type": "CN",
      "title": "NúmeroVlr.Co-Par",
      "description": "Numero da MovimentacaoValor Co-Participacao",
      "picture": "@!@E 999,999,999.99",
      "size": 817,
      "decimals": 02,
      "cbox": []
    },
    {
      "field": "BD5BD6_DATPROPERCOP",
      "type": "DN",
      "title": "Data Evento% Co-Part.",
      "description": "Data% EventoCo-Participacao",
      "picture": "@E 999,999,999.99",
      "size": 817,
      "decimals": 02,
      "cbox": []
    },
    {
      "field": "BD5BD6_CODRDAVLRTAD",
      "type": "CN",
      "title": "Cd.Cred/CoopVlr.Taxa.Adm",
      "description": "Cod. CredencValor Taxa Administracao",
      "picture": "@!@E 999,999,999.99",
      "size": 617,
      "decimals": 02,
      "cbox": []
    },
    {
      "field": "BD5BD6_NOMRDAPERTAD",
      "type": "CN",
      "title": "Nm.Cred/Coop% Taxa Adm.",
      "description": "credenciado% Taxa Administracao",
      "picture": "@!@E 999,999,999.99",
      "size": 4017,
      "decimals": 02,
      "cbox": []
    },
    {
      "field": "BD5BD6_TIPGUIVLRTPF",
      "type": "CN",
      "title": "TpVlr.Total GuiaPF",
      "description": "TipoValor deTotal GuiaPF",
      "picture": "@!@E 999,999,999.99",
      "size": 217,
      "decimals": 02,
      "cbox": []
    },
    {
      "field": "BD5BD6_FASEDATPRO",
      "type": "CD",
      "title": "FaseDt.Proced.",
      "description": "FaseData Proced.",
      "picture": "@!@D",
      "size": 18,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Digitacao"
    ]
    },
        {
          "valuefield": "2BD6_STATUS",
          "descriptiontype": "ConferenciaC",
        }"title": "Status",
        {
   "description": "Status",
       "valuepicture": "3@!",
      "size": 1,
      "descriptiondecimals": "Pronta"0,
        },"cbox": [
        {
          "value": "41",
          "description": "FaturadaAutorizada"
        },
        {
          "value": "50",
          "description": "ProcessandoNao Autorizada"
        }
      ]
    },
    {
      "field": "BD5BD6_SITUACVALOR",
      "type": "CN",
      "title": "SituaçãoVlr. Compra",
      "description": "SituacaoValor da Compra",
      "picture": "@!@E 999,999,999.99",
      "size": 117,
      "decimals": 02,
      "cbox": []
    },
    {
          "valuefield": "1BD6_PRPRRL",
          "descriptiontype": "Ativa"
        },
        {
    N",
      "valuetitle": "2Percentual",
          "description": "Cancelada"
        },
        {
    Percentual",
      "valuepicture": "3@E 999,999,999.99",
          "descriptionsize": "Bloqueada"17,
        }"decimals": 2,
      "cbox": []
    },
    {
      "field": "BCLBD6_DESCRIVRPRDA",
      "type": "CN",
      "title": "DescricaoVlr.Pag.Rda",
      "description": "DescricaoValor Pagto Direto aRDA?",
      "picture": "@!@E 999,999,999.99",
      "size": 3017,
      "decimals": 02,
      "cbox": []
    }
  ]
}

...

Mensagens de Erros

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"
} "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 parâmetros para customizar os campos que serão apresentados no cabeçalho da autorização, portanto foi criado o seguinte ponto de entrada:

DT PE Adicionar Novos Campos nos Eventos da Autorização - Gestão do Beneficiário (PO UI)

Tabela de Código de Erros

Código de erros informado no Json de retorno com falha (404):

Code	message	detailedMessage	Status code
E001	Beneficiário não encontrado.	Não foi encontrado nenhum Beneficiário com a matricula {subscriberId}	404
E002	Autorização não encontrada.	Autorização informada não encontrada na base de dados.	404
E003	Autorização informada invalida.	Dados da autorização informada estão

invalidos

inválidos.

400

03. TELA AUTORIZAÇÕES DO BENEFICIÁRIO

...

05. TABELAS UTILIZADAS

BA1 - Beneficiários
BD5 - Processamento de Contas
BD6 - Eventos Processamentos Contas
BE2 - Autorização e Procedimentos
BE4 - Internações
BEA - Complementos Movimentações
BEJ - Itens Autorização Internação

Árvore de páginas

Versões comparadas

Versão antiga 4

Nova versão Atual

Chave

Mensagens de Erros

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Mensagens de Erros

Endpoint

Parâmetros

Request

Operação realizada com sucesso (200)

Mensagens de Erros

Tabela de Código de Erros

03. TELA AUTORIZAÇÕES DO BENEFICIÁRIO

05. TABELAS UTILIZADAS