Árvore de páginas

Versões comparadas

Chave

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

...

Authorization (header)

Cabeçalho usado para autorização das requisições*required

Content-Type (header)

'application/json' é o formato do conteúdo*required
SubscriberId (path)

Número da carteirinha do beneficiário*required
status (query)

Filtro dos títulos pelo status, sendo:

  • A = Títulos em aberto
  • P = Títulos com baixa parcial
  • B = Títulos baixados
  • D = Demais Títulos, todos os status, inclusive títulos que não são de origem SIGAPLS

allTitles (query)

Demais Títulos, inclusive títulos que não são de origem SIGAPLS

  • 0 = Não (Default)
  • 1 = Sim

initialDate (query)

Data inicial dos títulos: 'AAAA-MM-DD'
finalDate (query)

Data final dos títulos: 'AAAA-MM-DD'
page (query)

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

Quantidade de Itens por Página
order (query)

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

Filtro de campos dos registros
filter (query)

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

...

CampoDescrição
BA1_CODINT, BA1_CODEMP, BA1_MATRIC, BA1_TIPREG, BA1_DIGITOCarteirinha do beneficiário
E1_PREFIXO, E1_NUM, E1_PARCELA, E1_TIPOChave identificar do título (titleId)
MV_PLSEXTPTipos cujos títulos de títulos que não tem origem do PLS que devem ser exibidos no filtro do status D (Demais Títulos(query param allTitles igual a 1)
MV_PLTITABTipos de títulos que devem ser ocultados no filtro do query param status A (Títulos em Abertos) e P (Títulos baixados parcialmente)
MV_PLTITBXTipos de títulos que devem ser ocultados no filtro do query param status B (Títulos baixados)

...