Get reservations for an organization
GET api/V3/{language}/org/{orgIdentifier}/reservations
?from={from}
&to={to}
&page={page}
&perPage={perPage}
&showCancelled={showCancelled}
Returns a list of reservations ordered by id, with the option to specify start and end dates.
Request Information
URI Parameters
| PARAMETERS | ||
|---|---|---|
| language (string) |
Language in which the localizable values should be returned. Part of base url. Value is either 'fr' or 'en' |
Required |
| orgIdentifier (string) |
Amilia-specific organization identifier. This identifier can be either the organization number, such as 8008, or the organization URL identifier. You can find that by looking at the URL of your Amilia store. It may look like lower-case words separated by a dash, such as forest-explorers. Note that in v2 and v1 we call that the 'rewrite URL'. |
Required |
| from (date) |
Start date formatted as YYYY-MM-DD. Inclusive in all versions of the API. Default value is null |
Optional |
| to (date) |
End date formatted as YYYY-MM-DD. Inclusive in version 3, exclusive in previous versions of the API. Default value is null |
Optional |
| page (integer) |
Result page number that appears first. Default value is 1 |
Optional |
| perPage (integer) |
Number of results per page. Default value is 200 |
Optional |
| showCancelled (boolean) |
Option to also return cancelled items. Default value is False |
Optional |
Body Parameters
None.
Response Information
Resource Description
| PARAMETERS | ||
|---|---|---|
| ReservationId (string) | ||
| Title (string) |
Title of the resource |
|
| Type (ReservationType) | ||
| Start (date) |
Inclusive start limit. Format is 9999-12-31 |
|
| End (date) |
Inclusive end limit. Format is 9999-12-31 |
|
| AllDay (boolean) |
True when occurrence (event) lasts all day |
|
| IsCancelled (boolean) | ||
| Location (LocationSummaryWithAddressApiModelV3) |
Object containing location id and name |
|
| BookingType (BookingTypeSummaryApiModelV3) | ||
| AdminBooking (AdminBookingSummaryApiModelV3) |
Extra information on scheduled admin booking |
|
| ClientReservation (ClientReservationSummaryApiModelV3) | ||
| Activity (ActivitySummaryApiModelV3) |
Object containing the activity details (activity id and name, program id and name, category id and name, subcategory id and name) For a reservation, the Activity object can be null |
|
| Contract (ReservationSummaryRentalContractApiModelV3) |
In an activity, object containing the reservation contract id and admin notes For a reservation, the Contract object can be null |
|
| Client (ReserveeApiModelV3) |
In an activity, object containing the client details for a reservation For a reservation, the Client object can be null |
|