| 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/
...
gravarConsulta"
| Informações |
|---|
|
Endpoint
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
exemplo.com / aps/locaisAtendimento
| 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.
...
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
nome | M | String | Nome do contato |
|
celular | M | String | Celular do contato |
|
M | String | Email do contato |
|
| Bloco de código |
|---|
{
"dadosContato:":{
"nome":"String",
"celular":"String",
"email":"String"
}
} |
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 |
|---|
{
"profissionaisAgendas": [
{
"profissionais": [
{
"horarios": [
{
"idAgenda": "String",
"dataHora": "YYYY-MM-DD hh:mm:ss"
}
]
}
]
}
]
} |
Retorno da API - Sucesso Caso o atributo data (que é opcional) no body da requisição for preenchido
| Bloco de código |
|---|
{
"profissionaisAgendas": [
{
"data": "2022-03-01",
"profissionais": [
{
"id": "121212",
"nome": "Dr Joaquim Das Neves",
"urlFoto": "https://randomuser.me/api/portraits/men/80.jpg",
"conselho": "CRM-ES 918171",
"localAtendimento": {
"id": "x1817",
"descricao": "Em atendimento em Local Xpxy"
},
"especialidade": {
"descricao": "clinica geral",
"id": "01928"
},
"horarios": [
{
"idAgenda": "121212",
"dataHora": "2022-03-01 11:40:00"
},
{
"idAgenda": "121212",
"dataHora": "2022-03-01 13:40:00"
},
{
"idAgenda": "121212",
"dataHora": "2022-03-01 14:40:00"
}
]
},
{
"id": "2",
"nome": "Dr. Carlos Alberto de Souza",
"conselho": "CRM-ES 31312312",
"localAtendimento": {
"id": "1",
"descricao": "Atendimento em Hospital São José"
},
"especialidade": {
"id": "1",
"descricao": "Clínico Geral"
},
"horarios": [
{
"idAgenda": "1",
"dataHora": "2022-03-01 11:30:00"
},
{
"idAgenda": "2",
"dataHora": "2022-03-01 13:00:00"
},
{
"idAgenda": "5",
"dataHora": "2022-03-01 15:00:00"
},
{
"idAgenda": "6",
"dataHora": "2022-03-01 16:00:00"
}
]
}
]
}
]
}
|
Exemplo de retorno com "sucesso” - Caso o atributo idProfissional no body da requisição for preenchido e o atributo data for preenchido
| Bloco de código |
|---|
{
"profissionaisAgendas":[
{
"data":"2022-02-01",
"profissionais":[]
},
{
"data":"2022-02-03",
"profissionais":[]
},
{
"data":"2022-02-04",
"profissionais":[]
},
{
"data":"2022-02-07",
"profissionais":[
{
"id":"1",
"nome":"Dr. Pedro Paulo Pereira",
"conselho":"CRM-ES 918171",
"urlFoto":"https://randomuser.me/api/portraits/men/80.jpg",
"localAtendimento":{
"id":"123",
"descricao":"Hospital São José"
},
"especialidade":{
"id":"9191919",
"descricao":"Clínico Geral"
},
"horarios":[
{
"idAgenda":"3",
"dataHora":"2022-02-07 10:30:00"
},
{
"idAgenda":"4",
"dataHora":"2022-02-07 11:30:00"
},
{
"idAgenda":"5",
"dataHora":"2022-02-07 13:00:00"
},
{
"idAgenda":"8",
"dataHora":"2022-02-07 15:00:00"
},
{
"idAgenda":"9",
"dataHora":"2022-02-07 16:00:00"
},
{
"idAgenda":"9",
"dataHora":"2022-02-07 17:00:00"
}
]
}
]
},
{
"data":"2022-02-09",
"profissionais":[]
},
{
"data":"2022-02-10",
"profissionais":[]
},
{
"data":"2022-02-11",
"profissionais":[]
},
{
"data":"2022-02-15",
"profissionais":[]
},
{
"data":"2022-02-17",
"profissionais":[]
},
{
"data":"2022-02-18",
"profissionais":[]
},
{
"data":"2022-02-21",
"profissionais":[]
},
{
"data":"2022-02-23",
"profissionais":[]
}
]
} |
Retorno da API - Falha
| Aviso |
|---|
|
...