Árvore de páginas

Versões comparadas

Chave

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

...

Retorna os procedimentos (Eventos) vinculado a doença preexistente (CID) do beneficiário.

Endpoint

https://<url>:porta>/rest/totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/cid/{cid}/procedures

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
subscriberId (path)

Image Modified

Número da carteirinha do beneficiário*required
cid (path)

Image Modified

Doença Preexistente (CID) retornado no endpoint: /totvsHealthPlans/v1/beneficiaryPosition/{subscriberId}/cid

Atributo: bf3_coddoe

*required
page (query)

Image Modified

Paginação da Coleção
pageSize (query)

Image Modified

Quantidade de Itens por Página
order (query)

Image Modified

Ordenação da Coleção
fields (query)

Image Modified

Filtro de campos dos registros
filter (query)

Image Modified

Indica o filtro querystring recebido (pode se utilizar um filtro oData)


...

Request

Não possui body!

...

Operação realizada com sucesso (200)

items

Image Modified

Procedimentos vinculado a doença preexistente do beneficiário

items.{campo do SX3}

Image Modified

Os campos retornados da tabela BYY:

  • byy_codpro
  • byy_despro
  • byy_carenc
  • byy_unidad
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
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"
        }
      ]
    }
  ]
}


...

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
languagec#
themeMidnight
titleExemplo de retorno - Falha
linenumberstrue
collapsetrue
{
  "code": "E001",
  "message": "Beneficiário não encontrado.",
  "detailedMessage": "Não foi encontrado nenhum beneficiário com a matricula 00011008000026010"
}

...