| 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/locaisAtendimento"
| Informações |
|---|
|
Endpoint
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
exemplo.com / aps/locaisAtendimento
| 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",
},
},
"idAtividade":123,
"idRegiao":123,
"idTipoAtendimento": 123,
"idTipoAtividade":123,
} |
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 |
|---|
{
"locais":[
{
"contatos": [ {
"tipo":"String",
"titulo":"String",
"valor":"String"
}
]
} |
Retorno da API - Sucesso
| Bloco de código | ||
|---|---|---|
| ||
{
"alertaPrincipal":"Atenção: agendamentos só podem ser feitos com um máximo de 90 dias.",
"locais":[
{
"descricao":"Hospital Sirio Libanes",
"id":"19920",
"alerta":"Atenção: Reforçamos medidas para o seu cuidado, como controle e monitoramento de temperatura das pessoas que circulam nas unidades, fluxos de atendimento, espaços físicos e equipes diferentes para pacientes com e sem sintomas de doenças respiratórias, horário mais espaçado entre as consultas (para evitar aglomerações).",
"endereco":{
"endereco":"Rua Dona Adma Jafet",
"numero":"91",
"complemento":"apt 414",
"bairro":"Bela Vista",
"cidade":"São Paulo",
"estado":"SP"
},
"contatos":[
{
"tipo":"1",
"titulo":"Telefone",
"valor":"27 99292-9292"
},
{
"tipo":"2",
"titulo":"E-mail",
"valor":"siriolibanes@hospital.com"
}
]
}
]
} |
Retorno da API - Falha
| Bloco de código | ||
|---|---|---|
| ||
{
"mensagem": "Não foi possível listar suas atividades"
} |
...