Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

Endpoint

Método

Header Content-Type

Descrição

exemplo.com / aps/atividades

Nota

Atenção

O endpoint obrigatoriamente deve terminar 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

Numer

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:

  • pendente,

  • em progresso,

  • em espera,

  • agendado,

  • executado,

  • concluido,

  • cancelado

dataSugerida

OP

String

Data “limite" sugerida para realização da atividade

Formato esperado:

YYYY-MM-DD HH:mm:ss

dataRealizado

OP

String

Data na qual a atividade foi realizada

Formato esperado:

YYYY-MM-DD HH:mm:ss

classificaoTipoAtendimentoclassificacaoTipoAtendimento

M

Objeto do tipo item

Objeto do tipo item

classificação do tipo de atendimento

...