Skip to content

Capacity

Returns list of resource capacities in the system. Returned data can be limited with start and end query parameters.

Operations

Download capacities as JSON

Request

GET https://api.zoined.com/v2/download/capacity.json?limit=1000&offset=0&start=2021-01-01&end=2021-01-31

Security
bearerAuth
Query
limitnumber

How many entries to return

Example:limit=1000
offsetnumber

Which offset to return data from

Example:offset=0
startstring

Return data starting from given date

Example:start=2021-01-01
endstring

Return data ending to given date

Example:end=2021-01-31
curl -i -X GET \
  'https://zapi-api.zoined.com/_mock/v2/download/capacity.json?limit=1000&offset=0&start=2021-01-01&end=2021-01-31' \
  -H 'Authorization: Bearer <YOUR_token_HERE>'

Responses

Request has been processed successfully.

Headers

  • Content-Type: application/json
Bodyapplication/json
organisation_idstringrequired

Organisation ID

Example:"540"
product_idstring

A (string, required) - Product ID

Example:"123"
event_idstring

Event ID

Example:"221"
capacity_datestringrequired

Date of capacity (yyyy-mm-dd)

Example:"2020-02-01"
capacity_timestring

Time of capacity (HH:mm:ss).

Example:"15:00:00"
capacity_typestringrequired

Capacity type. Must be either event or room.

Example:"event"
max_capacitynumberrequired

Maximum available capacity for this item.

Example:100
Response
{
  "organisation_id": "540",
  "product_id": "123",
  "event_id": "221",
  "capacity_date": "2020-02-01",
  "capacity_time": "15:00:00",
  "capacity_type": "event",
  "max_capacity": 100
}