Venues
Endpoints to work with the venues of a partner.
Get venues
GET /api/internal/v1/partners/:partner_id/venues
Get the venues of a partner.
The action must be performed by an authenticated user with permission venues.read and partner access.
Path Parameters
partner_id
integer
The id of the partner.
Query Parameters
type
string
Filter venues by type: external and internal.
page
integer
The page number to be displayed.
search
string
Filter venues by the given search term.
Create a new venue
POST /api/internal/v1/partners/:partner_id/venues/
Create a new venue.
Path Parameters
partner_id
integer
The ID of the partner.
Request Body
facility_id
integer
To which facility the venue should belong. If nothing is given, the venue will be considered external.
name
string
The name of the venue.
short_name
string
The short name of the venue.
address.country_id
integer
address.state_id
integer
address.city
string
address.post_code
number
address.street_name
string
address.street_number
string
address.additional_information
string
Get venue
GET /api/internal/v1/partners/:partner_id/venues/:venue_id
Get a venue by its id.
The action must be performed by an authenticated user with permission venues.read and partner access.
Path Parameters
venue_id
integer
The id of the venue.
partner_id
integer
The id of the partner.
Update venue
PUT /api/internal/v1/partners/:partner_id/venues/:venue_id
Path Parameters
partner_id
integer
The ID of the partner.
venue_id
integer
The ID of the venue.
Request Body
name
string
The venue name.
short_name
string
The venue short name.
use_facility_opening_times
boolean
Indicate if the opening times of the parent facility should be used. If set to true, the given opening_times will be ignored.
use_facility_address
boolean
Indicate if the address of the partner facility should be used. If set to true, the given address will be ignored.
opening_times
array
The opening times of the venue. The format is the same as the one used in the update facility endpoint.
address.country_id
integer
address.state_id
integer
address.city
string
address.post_code
string
address.street_name
string
address.street_number
string
address.additional_information
string
Delete venue
DELETE /api/internal/v1/partners/:partner_id/venues/:venue_id
Path Parameters
partner_id
integer
The ID of the partner.
venue_id
integer
The ID of the venue.
Get venue images
GET /api/internal/v1/partners/:partner_id/venues/:venue_id/images
Get the images of the given venue.
Path Parameters
partner_id
integer
The ID of the partner.
venue_id
integer
The ID of the venue.
Upload venue image
POST /api/internal/v1/partners/:partner_id/venues/:venue_id/images
Upload a new venue image.
Path Parameters
partner_id
integer
The ID of the partner.
venue_id
integer
The ID of the venue.
Request Body
image
object
The image to upload.
Delete venue image
DELETE /api/internal/v1/partners/:partner_id/venues/:venue_id/images/:image_id
Delete the given venue image.
Path Parameters
parner_id
integer
The ID of the partner.
venue_id
integer
The ID of the venue.
image_id
integer
The ID of the image.
Get venue prices
GET /api/internal/v1/partners/:partner_id/venues/:venue_id/prices
Path Parameters
partner_id
integer
The ID of the partner.
venue_id
integer
The ID of the venue.
Get venues_on_first_level menu template
GET /api/internal/v1/partners/:partner_id/venues/menu-templates/venues_on_first_level
Path Parameters
partner_id
integer
The ID of the partner.
Get facilities_on_first_level menu template
GET /api/internal/v1/partners/:partner_id/venues/menu-templates/facilities_on_first_level
Path Parameters
partner_id
integer
The ID of the partner.
Get venues_on_first_level_with_facility_names menu template
GET /api/internal/v1/partners/:partner_id/venues/menu-templates/venues_on_first_level_with_facility_names
Path Parameters
partner_id
integer
The ID of the partner.
Last updated
Was this helpful?