Índice |
---|
Dica |
---|
Só são suportadas integrações no padrão REST. |
...
Informações |
---|
|
Endpoint
Endpoint | Método | Header Content-Type | Descrição | ||
---|---|---|---|---|---|
http://exemplo.com/ buscaBeneficiarios
| POST | application/json | Endpoint lista os beneficiários agrupados por contrato. |
...
Atributo | Obrigatoriedade | Tipo | Descrição |
---|---|---|---|
chaveUnica | M | String | Chave de identificação do usuário retornada no login |
nome | M | String | Retornar o nome do beneficiário |
numero_contrato | C | String | Retorna o numero do contrato. Condicional para gravar o número de contrato na ocorrência gerada pelo atendimento de balcão |
Nota |
---|
Importante: O payload enviado deve conter os campos necessários para o acionamento da integração de elegibilidade.Retorno da API - Sucesso |
Bloco de código | ||
---|---|---|
| ||
{ "coluna": [ { "id": "nome", "descricao": "Nome" }, { "id": "data_nascimento", "descricao": "Nasc." }, { "id": "registro_geral", "descricao": "RG" }, { "id": "id_matricula", "descricao": "Matricula" }, { "id": "nome_mae", "descricao": "Nome da Mãe" }, { "id": "numero_contrato", "descricao": "Número Contrato" }, { "id": "contrato_descricao", "descricao": "Descrição Contrato" } ], "beneficiarios": [ { "nome": "João Pedro", "data_nascimento": "05/08/1994", "registro_geral": "3025-517", "id_matricula": "123-123-321", "nome_mae": "Maria Delmaschio", "chaveUnica": "15846772777", "numero_contrato":"0000001", "contrato_descricao":"MS PLATINUM" }, { "nome": "João Pedro", "data_nascimento": "05/08/1994", "registro_geral": "3025-517", "id_matricula": "123-123-321", "nome_mae": "Maria Delmaschio", "chaveUnica": "15846772777", "numero_contrato":"0000001", "contrato_descricao":"MS PLATINUM" }, { "nome": "João Pedro", "data_nascimento": "05/08/1994", "registro_geral": "3025-517", "id_matricula": "123-123-321", "nome_mae": "Maria Delmaschio", "chaveUnica": "15846772777", "numero_contrato":"0000002", "contrato_descricao":"MS GOLD" } ] } |
Retorno da API - Falha
Nota |
---|
|
...