Atualizar um agendamento

Sendo uma API REST, cada método HTTP tem o significado esperado; para realizar a atualização utiliza-se o método PUT.

Changes appointment details by folio.

put

https://middleware-staging.dev-land.space/api/v1http://middleware-staging.dev-land.space/api/v1

/orders/{folio}/appointments/{id}/

Given an order identifier changes the appointment details.

Autorizações

Token

AuthorizationstringObrigatório

Parâmetros de rota

foliostringObrigatório

idstringObrigatório

order_idstringObrigatório

Order UUID for which an appointment is to be made.

appointment_idstringObrigatório

Identifier of the appointment to be obtained.

Corpo

application/json

appointment_datestringObrigatório

Date of appointment.

appointment_timestringObrigatório

Time of appointment.

appointment_durationintegerObrigatório

Appointment duration in minutes.

Respostas

200

A successful response that returns the appointment details.

application/json

errorsobjectOpcional

This field will be null because no errors occurred.

successbooleanOpcional

This field will be true because no errors occurred.

Example: true

400

A failed response because the required parameters were not received.

application/json

401

A failed response due to insufficient permissions to execute the operation.

application/json

403

A failed response due to not having the proper permissions.

application/json

500

A failed response due to a server problem.

application/json

put

/orders/{folio}/appointments/{id}/

HTTPcURLJavaScriptPython

PUT /api/v1/orders/{folio}/appointments/{id}/ HTTP/1.1
Host: middleware-staging.dev-land.space
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "appointment_date": "text",
  "appointment_time": "text",
  "appointment_duration": 1
}

{
  "data": {
    "id": "text",
    "appointment": {
      "id": "text",
      "created_at": "text",
      "updated_at": "text",
      "name": "text",
      "order": {
        "id": "text"
      },
      "room": {
        "id": "text"
      },
      "facility": {
        "id": "text"
      },
      "start_date": "text",
      "end_date": "text",
      "cancelled": true,
      "event_type": "text"
    }
  },
  "errors": {},
  "success": "true"
}