Histórico da Página

...

Painel

titleColor	Orange
borderStyle	solid
title	Beneficiaries - Retorna os beneficiários da operadora de saúde

Retorna os beneficiários cadastrados na operadora de saúde.

/totvsHealthPlans/familyContract/v1/beneficiaries

GET

Nota

Expandir

title	Parameters

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
healthInsurerCode (query)	string	Código da operadora (BA1_CODINT)	*required
login-user (query)	string	Filtro de beneficiários pelo usuário de login do portal (BSW_LOGUSR)
allFamily (query)	string	Define se será retornado todos os beneficiários do login, quando utilizado o query param loginUser, sendo: 0 - Não 1 - Sim
companyCode (query)	string	Filtro de beneficiários por empresa (BA1_CODEMP)
contractcode (query)	string	Filtro de beneficiários por contrato (BA1_CONEMP)
contractVersionCode (query)	string	Filtro de beneficiários por versão do contrato (BA1_VERCON)
subcontractCode (query)	string	Filtro de beneficiários por subcontrato (BA1_SUBCON)
subcontractVersioncode (query)	string	Filtro de beneficiários por versão do subcontrato (BA1_VERSUB)
familycode (query)	string	Filtro de beneficiários por código da família (BA1_MATRIC)
name (query)	string	Filtro de beneficiários por nome
socialName (query)	string	Filtro de beneficiários por nome social
beneficiaryType (query)	string	Filtro de beneficiários por tipo (BA1_TIPUSU), sendo: T - Titular D - Dependente A - Agregado
situation (query)	string	Filtro de beneficiários por situação, sendo: 1 - Ativo 2 - Inclusão futura 3 - Bloqueio futuro 4 - Bloqueado
subscriberId (query)	string	Filtro de beneficiários pela carteirinha (BA1_CODINT+BA1_CODEMP+BA1_TIPREG+BA1_DIGITO)
subscriberIdOrCpf	string	Filtro de beneficiários pela carteirinha ou cpf
page (query)	string	Valor numérico (maior que zero) representando a página solicitada
pageSize (query)	string	Valor numérico (maior que zero) representando o total de registros retornados na consulta
order (query)	string	Lista de campos para ordenação, separada por virgula (,).
fields (query)	string	Lista com o nome das propriedades JSON que serão retornadas.
filter (query)	string	Filtros seguindo o padrão ODATA

Dica

Expandir

title	Request

Body

Não possui body!

Dica

Expandir

title	(200) - Operação realizada com sucesso

hasNext	boolean	Indica se ainda existem registros a serem retornados		*required
remainingRecords	numeric (integer)	Quantidade de registros ainda existem para retorno		*required
items	array	Lista de beneficiários retornados
items.companyCodecompany_code	string	Código da empresa do beneficiário	BA1_CODEMP	*required
items.contractCodecontract_code	string	Código do contrato (Pessoa jurídica)	BA1_CONEMP
items.contractVersionCodecontract_version_code	string	Versão do contrato (Pessoa jurídica)	BA1_VERCON
items.subcontractCodesubcontract_code	string	Código do subcontrato (Pessoa jurídica)	BA1_SUBCON
items.subcontractVersionCodesubcontract_version_code	string	Versão do subcontrato (Pessoa jurídica)	BA1_VERSUB
items.familyCodefamily_code	string	Código da família do beneficiário	BA1_MATRIC	*required
items.subscriberIdsubscriber_id	string	Matricula do beneficiário	BA1_CODINT+BA1_CODEMP+BA1_MATRIC+BA1_TIPREG+BA1_DIGITO	*required
items.name	string	Nome do beneficiário	BA1_NOMUSR	*required
items.socialNamesocial_name	string	Nome social do beneficiário	BA1_NOMSOC
items.birthDatebirth_date	string (date)	Data de nascimento do beneficiário	BA1_DATNAS	*required
items.effectiveDateeffective_date	string (date)	Data de inclusão do beneficiário	BA1_DATINC	*required
items.beneficiaryTypebeneficiary_type	string	Tipo do beneficiário, sendo: T - Titular D - Dependente A - Agregado	BA1_TIPUSU	*required
items.situation	string	Situação do beneficiário, sendo: 1 - Ativo 2 - Inclusão futura 3 - Bloqueio futuro 4 - Bloqueado	BA1_DATINC e BA1_DATBLO	*required
items.blockDateblock_date	string (date)	Data de bloqueio do beneficiário	BA1_DATBLO
items.beneficiaryCpfbeneficiary_cpf	string	Numero do CPF do beneficiário	BA1_CPFUSR

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "items": [
        {
            "companyCodecompany_code": "1008",
            "contractCodecontract_code": "000000000001",
            "contractVersionCodecontract_version_code": "001",
            "subcontractCodesubcontract_code": "000000001",
            "subcontractVersionCodesubcontract_version_code": "001",
            "familyCodefamily_code": "000001",
            "subscriberIdsubscriber_id": "00011008000001010",
            "name": "CLODOALDO SILVA",
            "socialNamesocial_name": "",
            "birthDatebirth_date": "1970-10-10",
            "effectiveDateeffective_date": "2021-02-12",
            "beneficiaryTypebeneficiary_type": "T",
            "situation": "1",
            "blockDateblock_date": "",
            "beneficiaryCpfbeneficiary_cpf": "51351540009"
        },
        {
            "companycodecompany_code": "1008",
            "contractCodecontract_code": "000000000001",
            "contractVersionCodecontract_version_code": "001",
            "subcontractCodesubcontract_code": "000000002",
            "subcontractVersionCodesubcontract_version_code": "001",
            "familyCodefamily_code": "000002",
            "subscriberIdsubscriber_id": "00011008000002017",
            "name": "FABIANA SOPHIA MELO",
            "socialNamesocial_name": "",
            "birthDatebirth_date": "1986-12-12",
            "effectiveDateeffective_date": "2021-03-08",
            "beneficiaryTypebeneficiary_type": "T",
            "situation": "1",
            "blockDateblock_date": "",
            "beneficiaryCpfbeneficiary_cpf": "77476519965"
        }
    ],
    "hasNext": true,
    "remainingRecords": 37
}

Aviso

Expandir

title	(406) - Parâmetros obrigatórios

code	string	Código identificador do erro.	*required
message	string	Literal no idioma da requisição descrevendo o erro para o usuário.	*required
detailedMessage	string	Mensagem técnica e mais detalhada do erro.	*required
details	array	Lista de objetos de erro (recursiva) com mais detalhes sobre o erro principal.	*required

Bloco de código

language	c#
theme	Emacs
title	Exemplo
linenumbers	true

{
    "code": "E001",
    "message": "Existem chaves obrigatórias que não foram informadas.",
    "detailedMessage": "Verifique a lista de erros no campo details para mais detalhes.",
    "details": [
        {
            "code": "E001-406",
            "message": "Chave health-insurer-code obrigatória",
            "detailedMessage": "Não foi informado no queryParams da requisição a chave health-insurer-code."
        }
    ]
}

...

Árvore de páginas

Versões comparadas

Versão antiga 36

Nova versão 37

Chave