Árvore de páginas

Versões comparadas

Chave

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

...

Painel
titleColorOrange
borderStylesolid
titleUtilizationStatement/base64 - Retorna o pdf do extrato de utilização do beneficiário

Retorna o pdf do Extrato de Utilização do beneficiário informado em base 64.

/totvsHealthPlans/familyContract/v1/beneficiaries/{subscriberId}/utilizationStatement/base64

GET

Nota
Expandir
titleParameters
Authorization (header)

string

Cabeçalho usado para autorização das requisições (Bearer token)*required

Content-Type (header)

string

'application/json' é o formato do conteúdo*required
subscriberId (path)stringMatricula do beneficiário (BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO)*required
dateOf (query)DateDe Ano /Mês/Dia de referência da declaração

*required

Se o semester não for informado

untilDate (query)DateAté Ano /Mês/Dia de referência da declaração

*required

Se o semester não for informado

semester (query)string

Busca pelo semetre semestre do ano informado.

Deve ser informado o seguinte formado S/YYYY. onde S pode ser 1 (primeiro semetresemestre) e 2 (segundo semestre) e YYYY corresponde ao ano. Exemplo: 2/2023


Dica
Expandir
titleRequest

Body


Não possui body!

Dica
Expandir
title(200) - Operação realizada com sucesso
fileNamestringNome do arquivo em PDF
*required
filestringString do arquivo em base 64
*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "fileName": "plsr022_20230616_183833.pdf",
	"file" : "JVBERi0xLjMKJbe+raoKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9L..."
}
Aviso
Expandir
title(406) - Parâmetros obrigatórios
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E001",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001B-406",
            "message": "Campo subscriberId obrigatório",
            "detailedMessage": "Não foi informado valor do campo subscriberId."
        },
        {
            "code": "E001E-406",
            "message": "Tamanho inválido para o campo subscriberId",
            "detailedMessage": "O valor do campo subscriberId deve ter o tamanho 17."
        }
    ]
}
Aviso
Expandir
title(406) - Parâmetros obrigatórios
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.*required
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E001",
    "message": "Os campos do json no body estão inválidos",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001A-406",
            "message": "Campo date-of não informado",
            "detailedMessage": "Não foi informado o campo date-of."
        },
        {
            "code": "E001A-406",
            "message": "Campo until-date não informado",
            "detailedMessage": "Não foi informado o campo unilt-date."
        }
    ]
}
Aviso
Expandir
title(400) - Extrato não disponível
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E002",
    "message": "Extrato não disponível",
    "detailedMessage": "Não foi possível realizar a impressão do Extrato de Utilização. Verificar o período informado."
}
Aviso
Expandir
title(404) - Beneficiário não encontrado
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E003",
    "message": "Usuário não encontrado",
    "detailedMessage": "Não foi possível retornar os dados do beneficiário através da matrícula informada."
}
Aviso
Expandir
title(400) - Período informado não permitido
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E004",
    "message": "Período informado não permitido.",
    "detailedMessage": "Período permitido somente para o mesmo ano. EX: dE 01/01/2023 A 31/12/2023."
}
Aviso
Expandir
title(400) - Intervalo de dias não permitido
codestringCódigo identificador do erro.*required
messagestringLiteral no idioma da requisição descrevendo o erro para o usuário.*required
detailedMessagestringMensagem técnica e mais detalhada do erro.*required
detailsarrayLista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.
Bloco de código
languagec#
themeEmacs
titleExemplo
linenumberstrue
{
    "code": "E005",
    "message": "Intervalo de dias não permitido.",
    "detailedMessage": "Permitido somente intervalo de no máximo 180 dia(s)."
}

...