...
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 | String | 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 realizada | Formato esperado:
|
classificacaoTipoAtendimentotipoAtendimento | M | Objeto | Objeto do tipo item“tipoAtendimento" | classificação do tipo de atendimento |
tipoAtividade | M | Objeto | objeto do tipo item“tipoAtividade" | classificação do tipo de atendimentoatividade |
Bloco de código | breakoutMode | wide
---|
{ "codigoAtividade":" Number, "codigoAtendimento":" Number, "numeroProtocolo": "String" "titulo":"String", "descricao":"String", "programa":"Objeto" , "situacao":"Objeto" , "dataSugerida": "String", "dataRealizado": "String", "classificacaoTipoAtendimentotipoAtendimento":"Objeto", "tipoAtividade":"Objeto", } |
Objeto "programatipoAtendimento"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
codigo | M | Numer | Codigo identificador do |
tipo de atendimento |
|
descricao | M | String | Descrição do tipo de atendimento |
|
classificacaoTipoAtendimento | M | Objeto | Objeto do tipo "classificacaoTipoAtendimento" | classificação do tipo de atendimento |
Bloco de código |
---|
{
"tipoAtendimento": {
"codigo": "string",
"descricao":"string",
"classificacaoTipoAtendimento":{
"codigo":"string",
"descricao":"string"
}
},
} |
Objeto "classificacaoTipoAtendimento"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
codigo | M | Numer | Codigo identificador da classificacao do tipo de atendimento |
|
descricao | M | String | Descrição do tipo de atendimento |
|
Bloco de código |
---|
{
"classificacaoTipoAtendimento":{
"codigo":"string",
"descricao":"string"
}
} |
Objeto "tipoAtividade"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
codigo | M | Numer | Codigo identificador do tipo de atividade |
|
descricao | M | String | Descrição do tipo de atividade |
|
classificacaoTipoAtividade | M | Objeto | Objeto do tipo "classificacaoTipoAtividade" | classificação do tipo de atividade |
Bloco de código |
---|
{
"tipoAtendimento": {
"codigo": "string",
"descricao":"string",
"classificacaoTipoAtendimento":{
"codigo":"string",
"descricao":"string"
}
},
} |
Objeto "classificacaoTipoAtividade"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
codigo | M | Numer | Codigo identificador da classificacao do tipo de atividade |
|
descricao | M | String | Descrição da classificacao do tipo de atividade |
|
Bloco de código |
---|
{
"classificacaoTipoAtividade":{
"codigo":"string",
"descricao":"string"
}
} |
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 | breakoutMode | wide
---|
{ "programa":{ "codigo":" Number, "titulo":"String", "descricao":"String", "icone":"String", "grupos":[ "Objeto" ], } } |
...