Clique na seta em "Copiar Página" para tirar dúvidas com a Inteligência Artificial.
Este endpoint deve ser utilizado em conjunto com o endpoint GET /api/v1/appointment/schedule/detail, que retorna os dados atuais do agendamento.
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
idBranch | int32 | Sim | Identificador da unidade em que o agendamento foi realizado. |
idActivitySession | int32 | Sim | Identificador da sessão de atividade (agendamento) cujo status será alterado. |
idMember | int32 | Condicional | Identificador do membro. Pelo menos um entre idMember, idProspect ou idEmployee deve ser informado. |
idProspect | int32 | Condicional | Identificador do prospect. Pelo menos um entre idMember, idProspect ou idEmployee deve ser informado. |
idEmployee | int32 | Condicional | Identificador do colaborador. Pelo menos um entre idMember, idProspect ou idEmployee deve ser informado. |
subStatus | int32 | Sim | Novo substatus do agendamento, conforme enum SubStatus abaixo. |
Regra de obrigatoriedade combinada: Obrigatórios: idBranch,idActivitySession,subStatusE pelo menos um entre: idMember,idProspectouidEmployee.
subStatusappointments/schedule/detail).| Valor | Nome | Descrição |
|---|---|---|
| 0 | Agendado | Agendamento criado, ainda não confirmado. |
| 1 | Confirmado | Agendamento confirmado. |
| 2 | Presente | Cliente marcado como presente. |
| 3 | Falta | Cliente ausente (falta). |
| 7 | FaltaJustificada | Cliente ausente com justificativa. |
OBS. incluir a opção de alteração para subStatus correspondente aos valores acima.
Enrollments)subStatus do agendamento, o sistema deve também atualizar o status do cliente na atividade (Enum Enrollments, utilizado no objeto Enrollment / presença).| SubStatus (Agendamento) | Valor SubStatus | Status (Enrollments) | Valor Status | Descrição Status (Enrollments) |
|---|---|---|---|---|
| Agendado | 0 | Presente | 0 | Código do status do cliente relacionado à atividade. |
| Confirmado | 1 | Presente | 0 | |
| Presente | 2 | Presente | 0 | |
| Falta | 3 | Falta | 1 | |
| FaltaJustificada | 7 | Falta Justificada | 2 |
Para Agendado / Confirmado / Presente → gravar Status = 0 (Presente) no enum Enrollments.Para Falta → gravar Status = 1 (Falta). Para FaltaJustificada → gravar Status = 2 (Falta Justificada).
| Campo | Tipo | Descrição |
|---|---|---|
idActivitySession | int32 | Identificador da sessão de atividade. |
subStatus | int32 | Substatus atualizado do agendamento. |
status | int32 | Status do cliente na atividade (Enum Enrollments). |
message | string | Mensagem de confirmação da alteração. |