...
Endpoint | Método | Header Content-Type | Descrição | ||
|---|---|---|---|---|---|
exemplo.com / aps/programasInscrito
| POST | application/json | Endpoint responsavel por realizar a adesão no programa de APS |
...
| Bloco de código |
|---|
{
"programas": [ "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" ],
}
} |
Objeto "grupo"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
codigo | M | Numer | Codigo identificador do grupo |
|
titulo | M | String | Titulo do grupo |
|
descricao | OP | String | Descrição do grupo |
|
icone | OP | String | Icone do grupo |
|
subgrupo | OP | Objeto do tipo subgrupo |
|
|
| Bloco de código |
|---|
{
"grupos":[
{
"codigo": Number,
"titulo":"String",
"descricao":"String",
"icone":"String",
"subgrupo":"Objeto",
}
]
} |
Objeto "subgrupo"
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
|---|---|---|---|---|
codigo | M | Numer | Codigo identificador do subgrupo |
|
titulo | M | String | Titulo do subgrupo |
|
descricao | OP | String | Descrição do subgrupo |
|
icone | OP | String | Icone do subgrupo |
|
| Bloco de código |
|---|
{
"codigo": Number,
"titulo":"String",
"descricao":"String",
"icone":"String",
} |
...
| Bloco de código | ||
|---|---|---|
| ||
{ "programas":[ { "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 "tipoAtividades "icone":"<link da imagem>", //Parametro opcional "grupos":[ { "codigoTipoAtividadecodigo": 123, "titulo": "Consulta PresencialAtendimento Primário a Saúde", "descricao": "Grupo Xpto", //Parametro opcional "icone":"<link da imagem>", //Parametro opcional "subgrupo":{ "codigo":123, "titulo":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam eget ligula eu lectus lobortis condimentum.", "Atendimento Primário a Saúde", "descricao": "xpto",//Parametro opcional "icone":"<link da imagem>", //Parametro opcional }, }, { "codigo": 123, "titulo": "Atendimento Primário a Saúde", "codigoTipoAtividade": 123, "descricao": "Grupo Xpto", //Parametro opcional "icone":"<link da imagem>", //Parametro opcional "subgrupo":{ "codigo":123, "titulo": "Consulta Presencial",Atendimento Primário a Saúde", "descricao": "xpto",//Parametro opcional "icone":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam eget ligula eu lectus lobortis condimentum.", }, {"<link da imagem>", //Parametro opcional }, } ] }, { "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>", //Parametro opcional "grupos":[ { "codigoTipoAtividadecodigo": 123, "titulo": "Consulta PresencialAtendimento Primário a Saúde", "descricao": "Grupo Xpto", //Parametro opcional "icone":"<link da imagem>", //Parametro opcional "subgrupo":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam eget ligula eu lectus lobortis condimentum.", }, ] { "codigo":123, "titulo": "Atendimento Primário a Saúde", "descricao": "xpto",//Parametro opcional "icone":"<link da imagem>", //Parametro opcional }, } ] }, ] } |
Retorno da API - Falha
| Bloco de código | ||
|---|---|---|
| ||
{
"mensagem": "Não foi possível listar suas atividades"
} |
...