PATCH/api/appointments/{id}/status

Atualizar Status de Agendamentos

Atualiza o status de um ou mais agendamentos

Access Token

Para realizar requisições GET, POST, PUT, DELETE e PATCH nos endpoints da API você precisa de uma chave de autorização. Chamamos essa chave de accessToken.

Para ter acesso ao accessToken, é necessário que o usuário master da licença efetue a liberação deste pela interface do ImageMais Clinic. O accessToken tem validade de 1 hora.

Headers

AuthorizationOBRIGATÓRIO
Tipo:string
Token de autenticação no formato Bearer {accessToken}
Content-TypeOBRIGATÓRIO
Tipo:application/json
Tipo de conteúdo (application/json)

Parâmetros

idOBRIGATÓRIO
Tipo:number
ID do agendamento

Este parâmetro representa o identificador único do agendamento. O ID do agendamento deve ser um número inteiro que identifica um agendamento específico no sistema.

Observação: Para encontrar o ID do agendamento, para acessar a página de listar agendamentos.

actionOBRIGATÓRIO
Tipo:string
Ação a ser executada. Valores possíveis: agendado, confirmado, cancelado, check-in, em atendimento, faltou, finalizados. Cada status atual permite apenas certas transições.

O parâmetro action permite atualizar o status do agendamento através de uma ação textual. Cada status atual permite apenas certas transições para outros status.

Transições de Status Permitidas:

Estado AtualPode usarNão pode usar
Agendadoconfirmado, canceladoagendado, check-in, em atendimento, faltou, finalizados
Confirmadocheck-in, cancelado, faltouagendado, confirmado, em atendimento, finalizados
Check-incancelado, em atendimentoagendado, confirmado, check-in, faltou, finalizados
Em atendimentofinalizados, canceladoagendado, confirmado, check-in, em atendimento, faltou
Cancelado(nenhuma)Todas as ações
Finalizados(nenhuma)Todas as ações
Faltou(nenhuma)Todas as ações
doctorIdOPCIONAL
Tipo:number
ID do médico

Este parâmetro representa o identificador único do médico. O ID do médico deve ser um número inteiro que identifica um médico específico no sistema.

Observação: Para encontrar o ID do médico, para acessar a página de listar médicos.

Request URL

https://api-dev.imagemais.com/api/appointments/update-status
curl -X 'PATCH' \
  'https://api-dev.imagemais.com/api/appointments/92/status' \
  -H 'accept: */*' \
  -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjMyLCJhY2NvdW50SWQiOjEsImlhdCI6MTc2NjQ4OTAxMCwiZXhwIjoxNzY2NDkyNjEwLCJhdWQiOiJodHRwczovL2FwaS1kZXYuaW1hZ2VtYWlzLmNvbSIsImlzcyI6Imh0dHBzOi8vYXBwLWRldi5pbWFnZW1haXMuY29tIn0.YvTwH6fN9qu9wa0Dj-0NkiwadR1n112v6yZef51p5IM' \
  -H 'Content-Type: application/json' \
  -d '{
  "action": "Finalizado",
  "doctorId": 1
}'
{
  "id": 92,
  "action": "Finalizado",
  ...
{
  "id": 92,
  "action": "Finalizado",
  "doctorId": 1
}

Respostas

{
  "message": "Status atualizado com sucesso"
}
{
  "message": "Status atualizado com sucesso"
}
{
  "message": [
    "action should not be empty",
  ...
{
  "message": [
    "action should not be empty",
    "action must be one of the following values: Agendado, Confirmado, Check-in, Em atendimento, Cancelado, Finalizado, Faltou"
  ],
  "error": "Bad Request",
  "statusCode": 400
}
{
  "message": "Agendamento não encontrado"
}
{
  "message": "Agendamento não encontrado"
}
{
  "statusCode": 401,
  "message": "invalid token"
  ...
{
  "statusCode": 401,
  "message": "invalid token"
}
{
  "statusCode": 401,
  "message": "jwt expired"
  ...
{
  "statusCode": 401,
  "message": "jwt expired"
}
{
  "statusCode": 500,
  "message": "Internal server error"
  ...
{
  "statusCode": 500,
  "message": "Internal server error"
}