CONTEÚDO
- Introdução
- Endpoint
- Tabelas utilizadas
01. INTRODUÇÃO
Esta API retorna os dados da carteirinha do beneficiário informado, incluindo as imagens do cartão frente e verso. As informações relacionadas à montagem dos dados da carteirinha são retornadas, bem como campos customizados, permitindo uma configuração dinâmica da exibição do cartão no frontend.
Clique aqui para detalhes sobre como habilitar o serviço de APIs no Protheus.
02. ENDPOINT
| /totvsHealthPlans/familyContract/v1/beneficiaries/{subscriberId}/card |
03. PARÂMETROS
| 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 | | 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: |
| | 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 |
|
|
|
| Nome | Tipo | Descrição |
|---|
| subscriberId (Path) | string | Identificador único da carteirinha do beneficiário. Obrigatório |
| Authorization (Header) | string | Token de acesso obtido via a API de autenticação, no formato Bearer <access_token>. Obrigatório |
04. RESPOSTA
200 - OK
Retorna os dados da carteirinha do beneficiário, incluindo informações pessoais, planos de saúde, imagens do cartão e configurações de layout.
Exemplo de resposta:
05. TABELAS UTILIZADAS
Coloque o link das tabelas relacionadas