Retorna os beneficiários cadastrados na operadora de saúde. | /totvsHealthPlans/familyContract/v1/beneficiaries | |
| Nota |
|---|
| Expandir |
|---|
| | Authorization (header) | | Cabeçalho usado para autorização das requisições (Bearer token) | *required | Content-Type (header) | | 'application/json' é o formato do conteúdo | *required | health-insurer-code | 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) | all-family
| | allFamily (query) | string | Define se será retornado todos os beneficiários do login, quando utilizado o query param | login-user loginUser, sendo: |
| company-code | companyCode (query) | string | Filtro de beneficiários por empresa (BA1_CODEMP) | contract-code
| | contractcode (query) | string | Filtro de beneficiários por contrato (BA1_CONEMP) | contract-version-code
| | contractVersionCode (query) | string | Filtro de beneficiários por versão do contrato (BA1_VERCON) |
| subcontract-code | subcontractCode (query) | string | Filtro de beneficiários por subcontrato (BA1_SUBCON) | subcontract-version-code
| | subcontractVersioncode (query) | string | Filtro de beneficiários por versão do subcontrato (BA1_VERSUB) |
| family-code | familycode (query) | string | Filtro de beneficiários por código da família (BA1_MATRIC) |
| | name (query) | string | Filtro de beneficiários por nome | social-name
| | socialName (query) | string | Filtro de beneficiários por nome social | beneficiary-type
| | 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
| page
| | subscriberId (query) | string | Valor numérico (maior que zero) representando a página solicitada | 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) | | Valor numérico (maior que zero) representando a página solicitada |
| | pageSize (query) | | Valor numérico (maior que zero) representando o total de registros retornados na consulta |
| | order (query) | | Lista de campos para ordenação, separada por virgula (,). |
| | fields (query) | | Lista com o nome das propriedades JSON que serão retornadas. |
| | filter (query) | | Filtros seguindo o padrão ODATA |
|
|
|
| Dica |
|---|
| Expandir |
|---|
| 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.company-_code | string | Código da empresa do beneficiário | BA1_CODEMP | *required | | items.contract-_code | string | Código do contrato (Pessoa jurídica) | BA1_CONEMP |
| | items.contract-_version-_code | string | Versão do contrato (Pessoa jurídica) | BA1_VERCON |
| | items.subcontract-_code | string | Código do subcontrato (Pessoa jurídica) | BA1_SUBCON |
| | items.subcontract-_version-_code | string | Versão do subcontrato (Pessoa jurídica) | BA1_VERSUB |
| | items.family-_code | string | Código da família do beneficiário | BA1_MATRIC | *required | | items.subscriber-_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.social-_name | string | Nome social do beneficiário | BA1_NOMSOC |
| | items.birth-_date | string (date) | Data de nascimento do beneficiário | BA1_DATNAS | *required | | items.effective-_date | string (date) | Data de inclusão do beneficiário | BA1_DATINC | *required | | items.beneficiary-_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.block-_date | string (date) | Data de bloqueio do beneficiário | BA1_DATBLO |
| | items.beneficiary-_cpf | string | Numero do CPF do beneficiário | BA1_CPFUSR |
|
| Bloco de código |
|---|
| language | c# |
|---|
| theme | Emacs |
|---|
| title | Exemplo |
|---|
| linenumbers | true |
|---|
| {
"items": [
{
"company-_code": "1008",
"contract-_code": "000000000001",
"contract-_version-_code": "001",
"subcontract-_code": "000000001",
"subcontract-_version-_code": "001",
"family-_code": "000001",
"subscriber-_id": "00011008000001010",
"name": "CLODOALDO SILVA",
"social-_name": "",
"birth-_date": "1970-10-10",
"effective-_date": "2021-02-12",
"beneficiary-_type": "T",
"situation": "1",
"block-_date": "",
"beneficiary-_cpf": "51351540009"
},
{
"company-_code": "1008",
"contract-_code": "000000000001",
"contract-_version-_code": "001",
"subcontract-_code": "000000002",
"subcontract-_version-_code": "001",
"family-_code": "000002",
"subscriber-_id": "00011008000002017",
"name": "FABIANA SOPHIA MELO",
"social-_name": "",
"birth-_date": "1986-12-12",
"effective-_date": "2021-03-08",
"beneficiary-_type": "T",
"situation": "1",
"block-_date": "",
"beneficiary-_cpf": "77476519965"
},
],
{
"company-code"hasNext": "1008"true,
"contract-coderemainingRecords": "000000000001",
"contract-version-code": "001",
"subcontract-code": "000000003",
"subcontract-version-code": "001",
"family-code": "000003",
"subscriber-id": "00011008000003013",
"name": "PAULO AZEVEDO",
"social-name": "",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": [
"birth-date": "1980-10-13",{
"effective-datecode": "2021E001-04-05406",
"beneficiary-typemessage": "TChave health-insurer-code obrigatória",
"situationdetailedMessage": "1",
Não foi informado no queryParams da requisição a "block-date": "",chave health-insurer-code."
}
"beneficiary-cpf": "55555555555"
},
{
"company-code": "1008",
"contract-code": "000000000001",
"contract-version-code": "001",
"subcontract-code": "000000003",
"subcontract-version-code": "001",
"family-code": "000004",
"subscriber-id": "00011008000004010",
"name": "ANDRE",
"social-name": "",
"birth-date": "1985-01-17",
"effective-date": "2021-04-27",
"beneficiary-type": "T",
"situation": "1",
"block-date": "",
"beneficiary-cpf": "53017895890"
}
],
"hasNext": true,
"remainingRecords": 37
} |
|
| | Aviso |
|---|
|
|
