| Authorization (header) | | Cabeçalho usado para autorização das requisições (Bearer token) | *requiredType Type (header) | | 'application/json' é o formato do conteúdo |
*required | healthInsurerCode (query| Authorization (Header) | 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: | 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) | | 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 | | Token de acesso obtido via a API de autenticação, no formato Bearer <access_token>. *required |
| subscriberId (Path) | string | Identificador único da carteirinha do beneficiário. *required |
