| Índice |
|---|
| Dica |
|---|
Só são suportadas integrações no padrão REST. |
Método "detalhePINSS"
| Informações |
|---|
|
Endpoint
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
http://exemplo.com/ PINSS/detalhePINSS
| POST | application/json | Endpoint para listar o detalhe do PINSS relacionado ao beneficiário selecionado |
Parâmetros de entrada
Serão enviados no HEADER os headers estáticos definidos ao configurar a integração, combinado com os tokens retornados pela configuração de autorização da integração (caso seja vinculada) e os headers de segurança retornado no login do beneficiário.
...
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
Beneficiário | M | Objeto | Objeto relacionado ao beneficiário |
OBJETO BENEFICIARIO
Objeto beneficiario
Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
chaveUnica | M | String | chave única do beneficiário |
numeroContrato | M | String | numero do contrato do beneficiário |
integracao | M | Objeto | Objeto de integração do beneficiário |
Exemplo request
| Bloco de código | ||
|---|---|---|
| ||
url:
https://www.operadoradesaude.com.br/mobilesaude/PINSS/detalhePINSS
Body:
{
"integracao": {
"xpto": "voluptatibus",
"xyz": "quibusdam",
"abcdef": 9288701
},
"beneficiario": {
"nomechaveUnica": "Geraldo Felix Juniorgeraldo@mobilesaude.com.br",
"matriculanumeroContrato": "2320170425162943-000100200300400500609",
"chaveUnicaintegracao": "geraldo@mobilesaude.com.br", {
"tipoBeneficiarionumero_cartao_benef": "Dependente00010002000001000",
"numeroContrato": "00100200300400500609",
"integracao": {
"numero_cartao_benef": "00010002000001000",
" "cpf_benef": "07805206708",
"abcdef": 9288701
}
}
} |
Descrição dos objetos e atributos de retorno - Sucesso
Está indicado abaixo a estrutura de retorno do método. Esse método deve obedecer as regras indicadas no objeto principal e em seus desdobramentos.
...
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
urlDocumentoTecnico | M | String | URL do documento técnico do PINSS |
|
pinss | M | Array | Array de objetos PINSS |
|
| Bloco de código | ||
|---|---|---|
| ||
{
"urlDocumentoTecnico": "string",
"pinss": [Array-objetos]
} |
| Nota |
|---|
|
...
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
titulo | M | String | Titulo da informação | Texto livre |
valores | M | Array | Array de objetos valores, contendo descrição e valor |
|
...
| Bloco de código |
|---|
|
...
Atributo
...
Critério
...
Tipo
...
Descrição
...
Regra de preenchimento
...
descricao
...
M
...
String
...
Descrição da informação
...
Texto livre
...
valor
...
M
...
String
...
Valor da informação
| |
{
"urlDocumentoTecnico": "string",
"pinss": [
{
"titulo": "string",
"valores": [Array-objetos]
}
} |
Objeto valores
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
descricao | M | String | Descrição da informação | Texto livre |
valor | M | String | Valor da informação | Texto livre |
| Bloco de código | ||
|---|---|---|
| ||
{
"urlDocumentoTecnico": "string",
"pinss": [
{
"titulo": "string",
"valores": [
{
"descricao": "string",
"valor": "string"
}
]
}
} |
Retorno da API - Sucesso
| Bloco de código | ||
|---|---|---|
| ||
{
"urlDocumentoTecnico": "https://assets-front-testing.sandbox.mosiaomnichannel.com.br/v1/pinss/anexo_pin_ss.pdf",
"pinss": [
{
"titulo": "Cliente",
"valores": [
{
"descricao": "Nome Completo",
"valor": "Geraldo Felix Junior"
},
{
"descricao": "Data de nascimento",
"valor": "1978-03-01"
},
{
"descricao": "Número do Cartão Nacional de Saúde (CNS)",
"valor": "999999999999999"
}
]
},
{
"titulo": "Contrato",
"valores": [
{
"descricao": "Contratante",
"valor": "Mobile Saúde"
},
{
"descricao": "Tipo de contratante",
"valor": "Pessoa Jurídica"
},
{
"descricao": "Número do contrato",
"valor": "00100200300400500609"
},
{
"descricao": "Início da vigência do contrato",
"valor": "2012-01-01"
}
]
},
{
"titulo": "Plano de Saúde",
"valores": [
{
"descricao": "Operadora",
"valor": "Plataforma testing"
},
{
"descricao": "Código ANS da Operadora",
"valor": "111111111111"
},
{
"descricao": "Nome do plano",
"valor": "CASSI Família I"
},
{
"descricao": "Número de registro do plano na ANS",
"valor": "999.999/99-9"
},
{
"descricao": "Segmentação assistencial do plano",
"valor": "Ambulatorial + Hospitalar com obstetrícia"
},
{
"descricao": "Matrícula do beneficiário no plano",
"valor": "2320170425162943-0"
},
{
"descricao": "Início da vigência do plano",
"valor": "2012-01-01"
},
{
"descricao": "Término da cobertura parcial temporária (CPT)",
"valor": "Não há"
},
{
"descricao": "Padrão de acomodação",
"valor": "Individual"
},
{
"descricao": "Tipo de contratação",
"valor": "Plano Coletivo Empresarial"
},
{
"descricao": "Tipo de regulamentação",
"valor": "Plano Regulamentado"
},
{
"descricao": "Área de abrangência geográfica",
"valor": "Estadual"
}
]
},
{
"titulo": "Carências",
"valores": [
{
"descricao": "ES - Atendimentos Ambulatoriais",
"valor": "2012-12-31"
},
{
"descricao": "ES - Internações e Outros Procedimentos",
"valor": "2012-12-31"
},
{
"descricao": "ES - Partos a Termo",
"valor": "2012-12-31"
},
{
"descricao": "ES - Odontologia",
"valor": "2012-12-31"
}
]
}
]
} |
Retorno da API - Falha
| Aviso |
|---|
|