| 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/profissionaisResponsaveis"
| Informações |
|---|
|
Endpoint
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
exemplo.com / aps/profissionaisResponsaveis
| 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.
...
| 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",
},
},
"idPrograma":123,
"idGrupo":123,
"idSubgrupo":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 |
|---|
{
"horarioAtendimento":[
{
"diaSemana":{
"codigo":"String",
"descricao":"String",
},
"horaInicio":"String",
"horaFim":"String"
}
]
} |
Retorno da API - Sucesso
| Bloco de código | ||
|---|---|---|
| ||
{
"profissionais":[
{
"codigoProfissional":"123",
"nome": "Cintia Dilay",
"tratatamento":{
"codigo":"123",
"descricao":"Dr.(a)"
},
"foto":"url do arquivo",
"sexo":{
"codigo":"123",
"descricao":"Feminino"
},
"tipoPessoa": {
"codigo":"123",
"descricao":"Pessoa Fisica"
},
"tipoProfissional":{
"codigo":"123",
"descricao":"Enfermeiro"
},
"vinculo":{
"codigo":"123",
"descricao":"Cooperado"
},
"contato":{
"telefone":"",
"telefoneCelular":"",
"email":"",
"whatsapp":""
},
"dadosConselho":{
"numero":"124212",
"uf":"ES",
"tipoConsellho":{
"codigo":"123",
"descricao":"Conselho Regional de Enfermagem",
"sigla": "COREN"
}
},
"programa":{
"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>",
"grupo":{
"codigo": 123,
"titulo": "Atendimento Primário a Saúde",
"descricao": "Grupo Xpto",
"icone":"<link da imagem>",
"subgrupo":{
"codigo":123,
"titulo": "Atendimento Primário a Saúde",
"descricao": "xpto",
"icone":"<link da imagem>",
}
}
},
"horarioAtendimento":[
{
"diaSemana":{
"codigo":"1",
"descricao":"Segunda Feira"
},
"horaInicio": "08:00",
"horaFim": "12:00"
}
],
"profissionalResponsavel": true
},
{
"codigoProfissional":"123",
"tipoPessoa": {
"codigo":"123",
"descricao":"Pessoa Fisica"
},
"tipoProfissional":{
"codigo":"123",
"descricao":"Enfermeiro"
},
"vinculo":{
"codigo":"123",
"descricao":"Cooperado"
},
"tratatamento":{
"codigo":"123",
"descricao":"Dr.(a)"
},
"nome": "Rebeca Modena",
"sexo":{
"codigo":"123",
"descricao":"Feminino"
},
"foto":"url do arquivo",
"contato":{
"telefone":"",
"telefoneCelular":"",
"email":"",
"whatsapp":""
},
"dadosConselho":{
"numero":"124212",
"uf":"ES",
"tipoConsellho":{
"codigo":"123",
"descricao":"Conselho Regional de Enfermagem",
"sigla": "COREN"
}
},
"programa":{
"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>",
"grupo":{
"codigo": 123,
"titulo": "Atendimento Primário a Saúde",
"descricao": "Grupo Xpto",
"icone":"<link da imagem>",
"subgrupo":{
"codigo":123,
"titulo": "Atendimento Primário a Saúde",
"descricao": "xpto",
"icone":"<link da imagem>",
}
}
},
"horarioAtendimento":[
{
"diaSemana":{
"codigo":"1",
"descricao":"Segunda Feira"
},
"horaInicio": "08:00",
"horaFim": "12:00"
}
],
"profissionalResponsavel": false
}
]
} |
Retorno da API - Falha
| Bloco de código | ||
|---|---|---|
| ||
{
"mensagem": "Não foi possível listar suas atividades"
} |
...