| Dica |
|---|
Só são suportadas integrações no padrão REST. |
Introdução
Método de listagem dos indicadores favoritos do paciente
Método "aps/anexos"
| Informações |
|---|
|
Endpoint
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
exemplo.com / aps/indicadores/favoritos
| POST | application/json |
|
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.
Serão enviados no BODY os seguintes parâmetros:
Parâmetro | Obrigatório | Tipo | Descrição |
|
|---|---|---|---|---|
chaveUnica | M | String | Chave de identificação do usuário retornada no login |
|
integracao | OP | Objeto | Nó integração retornado no login do usuário |
|
beneficiario | M | Objeto | Beneficiario selecionado para agendamento da consulta |
|
idTipoDocumento | OP | Number | ID de identificação do tipo de documento cadastrado no Previva |
| Bloco de código |
|---|
{
"chaveUnica":"String",
"integracao":{ Objeto },
"beneficiario":{ Objeto }
"idTipoDocumento": Number
} |
Objeto beneficiario
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
chaveUnica | M | String | Chave de identificação do paciente |
|
numeroContrato | M | String | Número do contrato do paciente |
|
integracao | OP | Objeto | Nó integração retornado no login do usuário |
|
| Bloco de código |
|---|
{
"beneficiario":{
"chaveUnica":"String",
"numeroContrato":"String",
"integracao":{ Objeto }
} |
Exemplo request
| Bloco de código |
|---|
{
"chaveUnica": "101012",
"integracao": {
"cpf": "123456789123",
"numero_cartao": "9288701",
},
"beneficiario": {
"chaveUnica": "101012", //geralmente é o cpf
"numeroContrato": "616161",
"integracao": {
"cpf": "123456789123",
"numero_cartao": "9288701",
},
},
"idTipoDocumento": 1
} |
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.
Objeto principal
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
anexos | M | Array de objetos do tipo "indicador" |
|
|
| Bloco de código |
|---|
{
"anexos": [ "Objeto" ],
} |
Objeto “indicador"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
codigoDocumento | M | Numer | Codigo identificador do documento cadastrado no Previva |
|
descricao | M | String | Descrição do documento |
|
tipoDocumento | M | Objeto do tipo item | Tipo de documento | |
dataInclusao | M | String | Data de inclusão | Formato esperado:
|
mimeType | M | String | Mime Type do arquivo |
|
| Bloco de código |
|---|
{
"codigoDocumento":" Number,
"descricao":"String",
"tipoDocumento":"Objeto" ,
"dataInclusao": "String",
"mimeType":"String",
} |
Objeto “item"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
codigo | M | Numer | Codigo identificador do item |
|
descricao | M | String | Descrição do item |
|
| Bloco de código |
|---|
{
"codigo": Number,
"descricao":"String",
} |
Retorno da API - Sucesso
| Bloco de código |
|---|
{
"anexos":[
{
"codigoDocumento": 1,
"descricao": "Exame 01",
"tipoDocumento": {
"codigo": 1,
"descricao": "Exame"
},
"dataInclusao": "2024-08-02 08:20:00",
"mimeType": "application/pdf"
},
{
"codigoDocumento": 2,
"descricao": "Geral 01",
"tipoDocumento": {
"codigo": 2,
"descricao": "Geral"
},
"dataInclusao": "2024-10-02 08:20:00",
"mimeType": "image/png",
}
]
} |
Retorno da API - Falha
| Bloco de código |
|---|
{
"mensagem": "Não foi possível listar os anexos"
} |
| Aviso |
|---|
|