...
Método de listagem de atividades do programa de APS
Método "aps/
...
locaisAtendimento"
Informações |
---|
|
...
Endpoint | Método | Header Content-Type | Descrição | ||
---|---|---|---|---|---|
exemplo.com / aps/atividades/tipoAtividadeslocaisAtendimento
| POST | application/json | Endpoint responsavel por realizar a adesão no programa de APS |
...
Bloco de código |
---|
{ "alerta": "String" "locais": [ "Objeto" ], } |
Objeto locais
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
descricao | M | String | Texto de descrição do local de atendimento | Texto livre |
id | M | String | id do local de atendimento |
|
endereco | M | Objeto | Objeto com dados do endereço | Objeto endereço |
contatos | M | Array | Array de objetos do tipo contato | Array de objeto contato |
alerta | OP | String | Texto de alerta do local de atendimento | Texto Livre |
quantidadeMedicos | OP | String | Quantidades de médicos disponíveis para atendimento |
|
Bloco de código |
---|
{ "locais":[ { "descricao":"String", "id":"String", "alerta":"String", "endereco":{ objeto }, "contatos": [ Array-objetos ], "quantidadeMedicos": "String" } |
Objeto endereco
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
endereco | M | String | Texto de endereço do local de atendimento | Texto livre |
numero | M | String | Número do local de atendimento | Texto livre |
complemento | M | String | Complemento do local de atendimento | Texto livre |
bairro | M | String | Bairro do local de atendimento | Texto livre |
cidade | M | String | Cidade do local de atendimento | Texto livre |
estado | M | String | Estado do local de atendimento | Texto livre |
Bloco de código |
---|
{ "locais":[ { "endereco":{ "endereco":"String", "numero":"String", "complemento":"String", "bairro":"String", "cidade":"String", "estado":"String" } } |
Objeto contato
Atributo | Critério | Tipo | Descrição | Regra de preenchimento |
---|---|---|---|---|
tipo | M | String | Tipo de contato | Conteúdo válido: |
id | M | String | id do contato |
|
titulo | M | String | Titulo do contato | EX: “Telefone" |
valor | M | String | Valor do contato | EX:”28 999999999" |
Bloco de código |
---|
{ "locais":[ { "contatos": [ { "tipo":"String", "titulo":"String", "valor":"String" } ] } |
...