Consultar agendamientos

Al ser una API REST, cada método HTTP tiene el significado esperado, para realizar listar los agendamientos se utiliza el método GET.

Appointments list.

get

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

/appointments/

List all appointments.

Authorizations

Token

AuthorizationstringRequired

Query parameters

start_datestringOptional

Start date in ISO 8601 format. Mandatory if end_date is not specified. The difference between the start date and the end date cannot be more than one month.

end_datestringOptional

End date in ISO 8601 format. Mandatory if start_date is not specified. The difference between the start date and the end date cannot be more than one month.

modalitystringOptional

Modalities UUIDs. In order to specify more than one, this parameter must be repeated. Example: "?modality=id1&modality=id2".

facilitystringOptional

Facilities UUIDs. In order to specify more than one, this parameter must be repeated. Example: "?facility=id1&facility=id2".

roomstringOptional

Rooms UUIDs. In order to specify more than one, this parameter must be repeated. Example: "?room=id1&room=id2".

limitstringOptional

Maximum number of items that will be returned per page. Defaults to 10.

offsetstringOptional

Determines where the current page of data should start within the entire dataset. It represents the number of items that should be skipped before starting to display the items on the current page. Defaults to 0.

orderingstringOptional

Determines the field by which the dataset will be sorted and the direction in which it will be sorted. The field and direction option are specified, separated by a comma. The values that the direction can take are "asc" and "desc" for ascending and descending respectively. Defaults to "created_at,asc".

Responses

200

A successful response that returns appointments.

application/json

400

A failed response because the required parameters were not received or because they contain an error.

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

get

/appointments/

HTTPcURLJavaScriptPython

GET /api/v1/appointments/ HTTP/1.1
Host: middleware-staging.dev-land.space
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "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",
  "total_count": 1
}