Criação de agendamento

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

Create a new appointment by folio.

post

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

/orders/{folio}/appointments/

Given an order identifier creates a new appointment.

Autorizações

Token

AuthorizationstringObrigatório

Parâmetros de rota

foliostringObrigatório

Corpo

application/json

room_namestringOpcional

Name of the room in which the appointment will be made.

appointment_datestringObrigatório

Date of appointment.

appointment_timestringObrigatório

Time of appointment.

appointment_durationintegerObrigatório

Appointment duration in minutes.

Respostas

201

A successful response that returns the appointment details.

application/json

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

post

/orders/{folio}/appointments/

HTTPcURLJavaScriptPython

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

{
  "room_name": "text",
  "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"
}