Skip to content

Capacity

Capacities are used to provide details about available capacity for various resources at specific point of time. These could be eg. hotel rooms or event tickets.

Operations

Upload list of capacities

Request

POST https://api.zoined.com/capacity?dryRun=false&separator=%3B&encoding=utf-8

Security
bearerAuth
Query
dryRunbooleanrequired

Only validate the request without storing the data

Example:dryRun=false
separatorstringrequired

Column separator used when loading CSV data

Example:separator=;
encodingstringrequired

Character encoding used in the CSV data (default is utf-8)

Example:encoding=utf-8
Body
Any of:
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, ticket or room.

Example:"event"
max_capacitynumberrequired

Maximum available capacity for this item.

Example:100
source_systemstring

Identifier of the source system this data is from. Needed when mapping between source system identifiers and master identifiers are used.

Example:"ABCDEF"
curl -i -X POST \
  'https://zapi-api.zoined.com/_mock/capacity?dryRun=false&separator=%3B&encoding=utf-8' \
  -H 'Authorization: Bearer <YOUR_token_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "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,
    "source_system": "ABCDEF"
  }'

Responses

Request has been processed successfully.

Headers

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

Status of the operation OK / Not OK

Example:"OK"
msgstringrequired

Message describing result of operation

Example:"1 entity added"
Response
{
  "status": "OK",
  "msg": "1 entity added"
}