Availability slots

Availability slots is the term for any type of slot used for a booking. This collection of endpoints will work for any type of slot

Remove availability slots from option

An availability slot cannot be deleted if it is part of a hold availability request.

SecuritySupplier-production or Supplier-sandbox
Request
path Parameters
experience_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$

The experience ID.

option_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$

The option ID.

header Parameters
accept
required
string

Specify the format of the response.

Value: "application/json"
accept-version
required
string (PORTA version)

The version of PORTA for the request.

Value: Description
vnd.porta-api.v1

Version 1.0.0

API-Key
required
string (API key) ^[a-zA-Z0-9-_\.]{3,50}$

The supplier's API key

Responses
204

Availability slots removed successfully from option

default

Error response

delete/supplier/availability/experiences/{experience_id}/options/{option_id}/slots
Request samples 
Response samples 
application/json
{
  • "code": "400",
  • "id": "3ecae132-a32d-41f9-8f7d-586f34cc29ce",
  • "message": "Check the request for errors."
}
Create availability slots for experience
The maximum number of items in the request body varies based on the type of availability slot:


    

  • Daily slot: 100
    • 

  • Open slot: 1
    • 

  • Time slot: 100
    • 



SecuritySupplier-production or Supplier-sandbox 
Request 
path Parameters
experience_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The experience ID.


 
option_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The option ID.


 
header Parameters
accept
required
string
Specify the format of the response.


 Value: "application/json"  
accept-version
required
string (PORTA version) 
The version of PORTA for the request.


 Value: Description
vnd.porta-api.v1
Version 1.0.0


 
API-Key
required
string (API key) ^[a-zA-Z0-9-_\.]{3,50}$
The supplier's API key


 
Request Body schema: application/json
 Array 
One of:
capacity
integer <int32> 
The remaining number of seats for the slot.


 
required
object (Daily slot) 
 
required
Array of objects (Holder categories)   unique 
Holder categories for the slot.


 
guide_languages
Array of strings (Languages)   unique 
A list of languages which can be booked for the slot. The languages will appear for all available holder categories in the slot.


This property must follow the ISO 639-1 standard.


 
option_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The ID of the option that the slot belongs to.


 
slot_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The availability slot ID, assigned by the supplier.


The ID must be unique. The same ID cannot be re-used for different experiences.


 
Responses 
200
Availability slot


default
Error response


post/supplier/availability/experiences/{experience_id}/options/{option_id}/slots
Request samples 
application/json
[
  • {
    }
]
Response samples 
application/json
{
  • "capacity": 0,
  • "daily_slot": {
    },
  • "available_holder_categories": [
    ],
  • "guide_languages": [
    ],
  • "option_id": "string",
  • "slot_id": "string"
}
Remove availability slot from option
An availability slot cannot be deleted if it is part of a hold availability request.


SecuritySupplier-production or Supplier-sandbox 
Request 
path Parameters
experience_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The experience ID.


 
option_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The option ID.


 
availability_slot_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The availability slot ID.


 
header Parameters
accept
required
string
Specify the format of the response.


 Value: "application/json"  
accept-version
required
string (PORTA version) 
The version of PORTA for the request.


 Value: Description
vnd.porta-api.v1
Version 1.0.0


 
Responses 
204
Availability slot removed successfully from option


default
Error response


delete/supplier/availability/experiences/{experience_id}/options/{option_id}/slots/{availability_slot_id}
Request samples 
Response samples 
application/json
{
  • "code": "400",
  • "id": "3ecae132-a32d-41f9-8f7d-586f34cc29ce",
  • "message": "Check the request for errors."
}
Get availability slot for option
SecuritySupplier-production or Supplier-sandbox 
Request 
path Parameters
experience_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The experience ID.


 
option_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The option ID.


 
availability_slot_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The availability slot ID.


 
header Parameters
accept
required
string
Specify the format of the response.


 Value: "application/json"  
accept-version
required
string (PORTA version) 
The version of PORTA for the request.


 Value: Description
vnd.porta-api.v1
Version 1.0.0


 
Responses 
200
Availability slot


default
Error response


get/supplier/availability/experiences/{experience_id}/options/{option_id}/slots/{availability_slot_id}
Request samples 
Response samples 
application/json
{
  • "capacity": 0,
  • "daily_slot": {
    },
  • "available_holder_categories": [
    ],
  • "guide_languages": [
    ],
  • "option_id": "string",
  • "slot_id": "string"
}
Update capacity for availability slot
SecuritySupplier-production or Supplier-sandbox 
Request 
path Parameters
experience_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The experience ID.


 
option_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The option ID.


 
availability_slot_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The availability slot ID.


 
header Parameters
accept
required
string
Specify the format of the response.


 Value: "application/json"  
accept-version
required
string (PORTA version) 
The version of PORTA for the request.


 Value: Description
vnd.porta-api.v1
Version 1.0.0


 
Request Body schema: application/json
capacity
integer <int32> 
The remaining number of seats for the slot.


 
Responses 
200
Availability slot


default
Error response


patch/supplier/availability/experiences/{experience_id}/options/{option_id}/slots/{availability_slot_id}
Request samples 
application/json
{
  • "capacity": 0
}
Response samples 
application/json
{
  • "capacity": 0,
  • "daily_slot": {
    },
  • "available_holder_categories": [
    ],
  • "guide_languages": [
    ],
  • "option_id": "string",
  • "slot_id": "string"
}
Update availability slot for option
SecuritySupplier-production or Supplier-sandbox 
Request 
path Parameters
experience_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The experience ID.


 
option_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The option ID.


 
availability_slot_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The availability slot ID.


 
header Parameters
accept
required
string
Specify the format of the response.


 Value: "application/json"  
accept-version
required
string (PORTA version) 
The version of PORTA for the request.


 Value: Description
vnd.porta-api.v1
Version 1.0.0


 
Request Body schema: application/json
One of:
capacity
integer <int32> 
The remaining number of seats for the slot.


 
required
object (Daily slot) 
 
required
Array of objects (Holder categories)   unique 
Holder categories for the slot.


 
guide_languages
Array of strings (Languages)   unique 
A list of languages which can be booked for the slot. The languages will appear for all available holder categories in the slot.


This property must follow the ISO 639-1 standard.


 
option_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The ID of the option that the slot belongs to.


 
slot_id
required
string^(?!\-|\.|\_)[0-9a-z\-\.\_]{1,50}$
The availability slot ID, assigned by the supplier.


The ID must be unique. The same ID cannot be re-used for different experiences.


 
Responses 
200
Availability slot


default
Error response


put/supplier/availability/experiences/{experience_id}/options/{option_id}/slots/{availability_slot_id}
Request samples 
application/json
{
  • "capacity": 0,
  • "daily_slot": {
    },
  • "available_holder_categories": [
    ],
  • "guide_languages": [
    ],
  • "option_id": "string",
  • "slot_id": "string"
}
Response samples 
application/json
{
  • "capacity": 0,
  • "daily_slot": {
    },
  • "available_holder_categories": [
    ],
  • "guide_languages": [
    ],
  • "option_id": "string",
  • "slot_id": "string"
}
Copyright © TUI Musement. All rights reserved.