| Dica |
|---|
Só são suportadas integrações no padrão REST. |
Introdução
Método de listagem de atividades do programa de APS
Método "aps/atividades"
| Informações |
|---|
|
Endpoint
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
exemplo.com / aps/programasInscrito
| POST | application/json | Endpoint responsavel por realizar a adesão no programa de APS |
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.
...
| 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",
},
}
} |
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.
...
| Bloco de código |
|---|
{
"codigo": Number,
"titulo":"String",
"descricao":"String",
"icone":"String",
} |
Retorno da API - Sucesso
| Bloco de código | ||
|---|---|---|
| ||
{
"programas":[
{
"codigo":11023,
"titulo": "Atendimento Primário a Saúde",
"descricao": "A linha de cuidado atendimento primário a saúde é a linha de cuidado que...", //Parametro opcional
"icone":"<link da imagem>", //Parametro opcional
"grupos":[
{
"codigo": 123,
"titulo": "Atendimento Primário a Saúde",
"descricao": "Grupo Xpto", //Parametro opcional
"icone":"<link da imagem>", //Parametro opcional
"subgrupo":{
"codigo":123,
"titulo": "Atendimento Primário a Saúde",
"descricao": "xpto",//Parametro opcional
"icone":"<link da imagem>", //Parametro opcional
},
},
{
"codigo": 123,
"titulo": "Atendimento Primário a Saúde",
"descricao": "Grupo Xpto", //Parametro opcional
"icone":"<link da imagem>", //Parametro opcional
"subgrupo":{
"codigo":123,
"titulo": "Atendimento Primário a Saúde",
"descricao": "xpto",//Parametro opcional
"icone":"<link da imagem>", //Parametro opcional
},
}
]
},
{
"codigo":11023,
"titulo": "Atendimento Primário a Saúde",
"descricao": "A linha de cuidado atendimento primário a saúde é a linha de cuidado que...", //Parametro opcional
"icone":"<link da imagem>", //Parametro opcional
"grupos":[
{
"codigo": 123,
"titulo": "Atendimento Primário a Saúde",
"descricao": "Grupo Xpto", //Parametro opcional
"icone":"<link da imagem>", //Parametro opcional
"subgrupo":{
"codigo":123,
"titulo": "Atendimento Primário a Saúde",
"descricao": "xpto",//Parametro opcional
"icone":"<link da imagem>", //Parametro opcional
},
}
]
},
]
} |
Retorno da API - Falha
| Bloco de código | ||
|---|---|---|
| ||
{
"mensagem": "Não foi possível listar suas atividades"
} |
...