The old manager had only the concept of courses. In the new one, something more general is used: events. Each event has a type: course, seminar, etc. Currently, only the type course is implemented. The next types will be implemented in the future.
Get events
GET/api/internal/v1/partners/:partner_id/events
Get all the events of a partner.
Path Parameters
Name
Type
Description
partner_id
integer
The ID of the partner.
Query Parameters
Name
Type
Description
page
number
The page to display.
timeframe
string
Filter events by their timeframe. Allowed values: all, current, upcoming, past, cancelled, inactive.
The date time since the event can be booked. Format: Y-m-d H:i:s
bookable_until
string
The date time until the event can be booked. Format: Y-m-d H:i:s
start_date
string
The date when the event starts. Format: Y-m-d
end_date
string
The date when the event is over. Format: Y-m-d
freebie
boolean
Indicates if the event is freebie or not.
waitlist_enabled
boolean
waitlist_max_places
number
waitlist_autofill_free_places
boolean
birthdate_mandatory
boolean
max_participants
number
online_max_participants
number
disable_online_payment
boolean
instructor_ids
array
The IDs of the event instructors. Use the dedicated endpoint to fetch all the available instructors (pagination is applied, allow the user to filter by name). An event can have none, one, or many instructors.
audience_ids
array
The IDs of the event audiences. Use the dedicated endpoint to fetch all the available audiences.
Update the date settings of the given event. New appointments will be generate based on the date settings. Old appointments (if any) will be deleted.
Path Parameters
Name
Type
Description
partner_id
integer
The id of the partner.
event_id
integer
The ID of the event.
Request Body
Name
Type
Description
date_settings
array
Array with all the date settings.
date_settings.*
array
Array with the date settings of a day.
date_settings.*.appointments
array
Array of appointments.
date_settings.*.appointments.*.starts_at
string
The hour when the appointment will start. The allowed format is H:i:s.
date_settings.*.appointments.*.ends_at
string
The hour when the appointment will end. The allowed format is H:i:s.
date_settings.*.appointments.*.venue_id
integer
The ID of the venue where the appointment will take place.
To easily understand the format of the date_settings parameter, below is an example of a request done in PHP.
For the moment, the appointments array should receive a single entry. In the future will be possible to send multiple entries and schedule more than one appointment per day.
Create a new event price. If the event has no default price, the price will be created with type default. If it already has a default price, the price will be created with the type secondary.
Path Parameters
Name
Type
Description
partner_id
integer
The ID of the partner.
event_id
integer
The ID of the event.
Request Body
Name
Type
Description
name
string
The price name.
description
string
The price description.
form
string
The price form: gross or net.
amount
number
The price amount.
vat_id
integer
The ID of the VAT.
usable_online
boolean
Indicate if the price will be usable online or not.
Update the given price. If a anything related to the amount is changed (amount, vat, form), a new price will be created and the old one will be deleted. Make sure the fetch the update price using the new id if this happens.
Path Parameters
Name
Type
Description
partner_id
integer
The ID of the partner.
event_id
integer
The ID of the event.
price_id
integer
The ID of the price.
Request Body
Name
Type
Description
name
string
The price name.
description
string
The price description.
form
string
The price form: net or gross.
amount
number
The price amount.
vat_id
integer
The ID of the VAT applied to the price.
usable_online
boolean
Indicate if the price will be usable online or not.
