| 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. |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type AdminBookingReservationResult() =
///<summary>
///The internal reservation id (target for the release endpoint).
///</summary>
[<ApiMember(Description="The internal reservation id (target for the release endpoint).")>]
member val Id:Int32 = new Int32() with get,set
///<summary>
///The opaque session key that identifies the reservation.
///</summary>
[<ApiMember(Description="The opaque session key that identifies the reservation.")>]
member val SessionKey:Guid = new Guid() with get,set
///<summary>
///The reserved service id.
///</summary>
[<ApiMember(Description="The reserved service id.")>]
member val ServiceId:Int32 = new Int32() with get,set
///<summary>
///The reservation start.
///</summary>
[<ApiMember(Description="The reservation start.")>]
member val From:DateTime = new DateTime() with get,set
///<summary>
///The reservation end.
///</summary>
[<ApiMember(Description="The reservation end.")>]
member val To:DateTime = new DateTime() with get,set
///<summary>
///Number of reserved spots.
///</summary>
[<ApiMember(Description="Number of reserved spots.")>]
member val NumberOfBookedSpots:Int32 = new Int32() with get,set
///<summary>
///When the hold expires (company-local time).
///</summary>
[<ApiMember(Description="When the hold expires (company-local time).")>]
member val ExpirationDatetime:DateTime = new DateTime() with get,set
///<summary>
///The BookingReservationStatus value.
///</summary>
[<ApiMember(Description="The BookingReservationStatus value.")>]
member val StatusCode:Int32 = new Int32() with get,set
///<summary>
///The BookingReservationStatus name.
///</summary>
[<ApiMember(Description="The BookingReservationStatus name.")>]
member val StatusName:String = null with get,set
///<summary>
///The customer id holding the reservation, if any.
///</summary>
[<ApiMember(Description="The customer id holding the reservation, if any.")>]
member val CustomerId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///The customer's full name, when a customer is attached.
///</summary>
[<ApiMember(Description="The customer's full name, when a customer is attached.")>]
member val CustomerName:String = null with get,set
///<summary>
///The customer email (falls back to the BookedBy email when no customer is attached).
///</summary>
[<ApiMember(Description="The customer email (falls back to the BookedBy email when no customer is attached).")>]
member val CustomerEmail:String = null with get,set
[<AllowNullLiteral>]
type QueryBookingReservationsResponse() =
///<summary>
///The matching reservation holds.
///</summary>
[<ApiMember(Description="The matching reservation holds.")>]
member val Results:ResizeArray<AdminBookingReservationResult> = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)>]
[<ApiResponse(Description="You are not an administrator for the requested company", StatusCode=403)>]
[<AllowNullLiteral>]
type QueryBookingReservations() =
///<summary>
///The company id, if empty will use the company id for the user you are logged in with.
///</summary>
[<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///Only holds for this service id.
///</summary>
[<ApiMember(Description="Only holds for this service id.")>]
member val ServiceId:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Only holds whose start (From) is on or after this datetime.
///</summary>
[<ApiMember(Description="Only holds whose start (From) is on or after this datetime.")>]
member val From:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Only holds whose start (From) is on or before this datetime.
///</summary>
[<ApiMember(Description="Only holds whose start (From) is on or before this datetime.")>]
member val To:Nullable<DateTime> = new Nullable<DateTime>() with get,set
///<summary>
///Filter by BookingReservationStatus value. When omitted, the spot-holding statuses (Selecting=1, AwaitingPayment=2) are returned.
///</summary>
[<ApiMember(Description="Filter by BookingReservationStatus value. When omitted, the spot-holding statuses (Selecting=1, AwaitingPayment=2) are returned.")>]
member val StatusCode:Nullable<Int32> = new Nullable<Int32>() with get,set
F# QueryBookingReservations DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryBookingReservationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Results>
<AdminBookingReservationResult>
<CustomerEmail>String</CustomerEmail>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<CustomerName>String</CustomerName>
<ExpirationDatetime>0001-01-01T00:00:00</ExpirationDatetime>
<From>0001-01-01T00:00:00</From>
<Id>0</Id>
<NumberOfBookedSpots>0</NumberOfBookedSpots>
<ServiceId>0</ServiceId>
<SessionKey>00000000-0000-0000-0000-000000000000</SessionKey>
<StatusCode>0</StatusCode>
<StatusName>String</StatusName>
<To>0001-01-01T00:00:00</To>
</AdminBookingReservationResult>
</Results>
</QueryBookingReservationsResponse>