...
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
exemplo.com / aps/atividades
| POST | application/json | Endpoint responsavel por realizar a adesão no programa de APS |
...
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
codigoAtividade | M | Numer | Codigo identificador da atividade cadastrada no Previva | |
codigoAtendimento | M | Number | ID do atendimento cadastrada pelo PREVIVA | |
numeroProtocolo | OP | NumerString | Numero de protocolo gerado pela atividade no sistema da PREVIVA | |
titulo | M | String | Titulo da atividade | |
descricao | OP | String | Descrição da atividade | |
programa | M | Objeto do tipo programa | ||
situacao | M | Objeto do tipo item | Situação da atividade | Enum:
|
dataSugerida | OP | String | Data “limite" sugerida para realização da atividade | Formato esperado:
|
dataRealizado | OP | String | Data na qual a atividade foi realizadaclassificaoTipoAtendimento | Formato esperado:
|
classificacaoTipoAtendimento | M | Objeto do tipo item | Objeto do tipo item | classificação do tipo de atendimento |
| Bloco de código | ||
|---|---|---|
| ||
{
"codigoAtividade":" Number,
"codigoAtendimento":" Number,
"numeroProtocolo": "String"
"titulo":"String",
"descricao":"String",
"programa":"Objeto" ,
"situacao":"Objeto" ,
"dataSugerida": "String",
"dataRealizado": "String",
"classificacaoTipoAtendimento":"Objeto" ,
} |
Objeto "programa"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
codigo | M | Numer | Codigo identificador do porgrama |
|
titulo | M | String | Titulo do programa |
|
descricao | OP | String | Descrição do programa |
|
icone | OP | String | Icone do programa |
|
grupos | OP | Array de objetos do tipo "grupo" |
|
|
| Bloco de código | ||
|---|---|---|
| ||
{
"programa":{
"codigo":" Number,
"titulo":"String",
"descricao":"String",
"icone":"String",
"grupos":[ "Objeto" ],
}
} |
...
| Bloco de código | ||
|---|---|---|
| ||
{
"codigo": Number,
"titulodescricao":"String",
} |
Retorno da API - Sucesso
| Bloco de código | ||
|---|---|---|
| ||
{
"atividades": [
{
"codigoAtividade": 123,
"codigoAtendimento": 123,
"numeroProtocolo": "123",
"titulo": "Médico - Agendar consulta",
"descricao": null,
"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>",
},
},
},
"situacao":{
"codigo": 123,
"descricao": "agendado",
},
"dataSugerida": "01/02/2024 09:00:00",
"dataRealizado":"01/02/2024 09:00:00",
"classificaoTipoAtendimento":{
"codigo":123,
"descricao":"Agendamento",
}
]
} |
...