Árvore de páginas

Versões comparadas

Chave

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

...

Esses endpoints sã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
languagec#
themeMidnight
titleExemplo de retorno - Sucesso
linenumberstrue
collapsetrue
{
  "items": [
    {
      "bf3_coddoe": "14.0",
      "bf3_desdoe": "GlossiteExcluir: glossite atrofica(K14.42)",
      "bf3_pagagr": "0",
      "bf3_valagr": 0,
      "bf3_peragr": 0,
      "bf3_mesagr": 1,
      "bf3_unagr": "1",
      "bf3_datcpt": "2022-1-1"
    },
    {
      "bf3_coddoe": "14.1",
      "bf3_desdoe": "Glossite romboide mediana",
      "bf3_pagagr": "0",
      "bf3_valagr": 0,
      "bf3_peragr": 0,
      "bf3_mesagr": 2,
      "bf3_unagr": "2",
      "bf3_datcpt": "2022-1-1"
    },
    {
      "bf3_coddoe": "14.3",
      "bf3_desdoe": "Hipertrofia das papilas linguais",
      "bf3_pagagr": "0",
      "bf3_valagr": 0,
      "bf3_peragr": 0,
      "bf3_mesagr": 3,
      "bf3_unagr": "3",
      "bf3_datcpt": "2022-1-1"
    },
    {
      "bf3_coddoe": "14.5",
      "bf3_desdoe": "Lingua escrotal, Fissurada, Gretada Lingua, Sulcada Exclui: lingua Fissurada, congenita (Q38.33)",
      "bf3_pagagr": "0",
      "bf3_valagr": 0,
      "bf3_peragr": 0,
      "bf3_mesagr": 4,
      "bf3_unagr": "4",
      "bf3_datcpt": "2022-1-1"
    }
  ],
  "hasNext": false,
  "remainingRecords": 0,
  "struct": [
    {
      "field": "BF3_CODDOE",
      "type": "C",
      "title": "C.I.D.",
      "description": "Cod.Doenca",
      "picture": "@!",
      "size": 8,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BF3_DESDOE",
      "type": "C",
      "title": "Descricao",
      "description": "Descricao",
      "picture": "@!",
      "size": 25,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BF3_PAGAGR",
      "type": "C",
      "title": "Pg. Agr./CPT",
      "description": "Paga o Agravo/CPT ?",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Sim"
        },
        {
          "value": "0",
          "description": "Nao"
        }
      ]
    },
    {
      "field": "BF3_VALAGR",
      "type": "N",
      "title": "Vlr. Agravo",
      "description": "Valor do Agravo",
      "picture": "@E 99,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BF3_PERAGR",
      "type": "N",
      "title": "Per.Mensalid",
      "description": "Percentual da Mensalidade",
      "picture": "@E 99,999,999.99",
      "size": 17,
      "decimals": 2,
      "cbox": []
    },
    {
      "field": "BF3_MESAGR",
      "type": "N",
      "title": "T.Agravo/CPT",
      "description": "Tempo Meses do Agravo/CPT",
      "picture": "999",
      "size": 3,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BF3_UNAGR",
      "type": "C",
      "title": "Unidade",
      "description": "Unidade",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Horas"
        },
        {
          "value": "2",
          "description": "Dias"
        },
        {
          "value": "3",
          "description": "Meses"
        },
        {
          "value": "4",
          "description": "Anos"
        }
      ]
    },
    {
      "field": "BF3_DATCPT",
      "type": "D",
      "title": "Dt. Base CPT",
      "description": "Data Base CPT",
      "picture": "@D",
      "size": 8,
      "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
languagec#
themeMidnight
titleExemplo de retorno - Sucesso
linenumberstrue
collapsetrue
{
  "items": [
    {
      "byy_codpro": "10101012",
      "byy_despro": "CONSULTA EM CONSULTORIO",
      "byy_carenc": 1,
      "byy_unidad": "1"
    },
    {
      "byy_codpro": "40303136",
      "byy_despro": "SANGUE OCULTO, PESQUISA NAS FEZES",
      "byy_carenc": 2,
      "byy_unidad": "2"
    }
  ],
  "hasNext": false,
  "remainingRecords": 0,
  "struct": [
    {
      "field": "BYY_CODPRO",
      "type": "C",
      "title": "Cod Proced.",
      "description": "Codigo Procedimento",
      "picture": "@!",
      "size": 16,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BYY_DESPRO",
      "type": "C",
      "title": "Descricao",
      "description": "Descricao",
      "picture": "@!",
      "size": 30,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BYY_CARENC",
      "type": "N",
      "title": "Carencia",
      "description": "Carencia",
      "picture": "9999",
      "size": 4,
      "decimals": 0,
      "cbox": []
    },
    {
      "field": "BYY_UNIDAD",
      "type": "C",
      "title": "Unidade",
      "description": "Unidade",
      "picture": "@!",
      "size": 1,
      "decimals": 0,
      "cbox": [
        {
          "value": "1",
          "description": "Horas"
        },
        {
          "value": "2",
          "description": "Dias"
        },
        {
          "value": "3",
          "description": "Meses"
        },
        {
          "value": "4",
          "description": "Anos"
        }
      ]
    }
  ]
}

...


...

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.

...

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

CodemessagedetailedMessageStatus Code
E001

Beneficiário não encontrado.

Não foi encontrado nenhum Beneficiário com a matricula {subscriberId}

404

03. TELA DOENÇAS PREEXISTENTES

...