| Requires any of the roles: | bookingsupplier-administrator-write, bookingsupplier-administrator-read, superadmin |
| GET | /admin/bookingreservations | List booking-reservation holds (admin) | Lists the active reservation holds for a company. By default only the spot-holding statuses (Selecting, AwaitingPayment) — the ones actually reducing availability — are returned; pass StatusCode to filter to a specific status. Optionally filter by ServiceId and a From/To window on the hold start. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | query | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
| ServiceId | query | int? | No | Only holds for this service id. |
| From | query | DateTime? | No | Only holds whose start (From) is on or after this datetime. |
| To | query | DateTime? | No | Only holds whose start (From) is on or before this datetime. |
| StatusCode | query | int? | No | Filter by BookingReservationStatus value. When omitted, the spot-holding statuses (Selecting=1, AwaitingPayment=2) are returned. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Results | form | List<AdminBookingReservationResult> | Yes | The matching reservation holds. |
| ResponseStatus | form | ResponseStatus | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The internal reservation id (target for the release endpoint). |
| SessionKey | form | Guid | No | The opaque session key that identifies the reservation. |
| ServiceId | form | int | No | The reserved service id. |
| From | form | DateTime | No | The reservation start. |
| To | form | DateTime | No | The reservation end. |
| NumberOfBookedSpots | form | int | No | Number of reserved spots. |
| ExpirationDatetime | form | DateTime | No | When the hold expires (company-local time). |
| StatusCode | form | int | No | The BookingReservationStatus value. |
| StatusName | form | string | Yes | The BookingReservationStatus name. |
| CustomerId | form | Guid? | No | The customer id holding the reservation, if any. |
| CustomerName | form | string | Yes | The customer's full name, when a customer is attached. |
| CustomerEmail | form | string | Yes | The customer email (falls back to the BookedBy email when no customer is attached). |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /admin/bookingreservations HTTP/1.1 Host: testapi.bokamera.se Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Results":[{"Id":0,"ServiceId":0,"NumberOfBookedSpots":0,"StatusCode":0,"StatusName":"String","CustomerId":"00000000-0000-0000-0000-000000000000","CustomerName":"String","CustomerEmail":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}