| 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. |
|---|
<?php namespace dtos;
use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};
class AdminBookingReservationResult implements JsonSerializable
{
public function __construct(
/** @description The internal reservation id (target for the release endpoint). */
// @ApiMember(Description="The internal reservation id (target for the release endpoint).")
/** @var int */
public int $Id=0,
/** @description The opaque session key that identifies the reservation. */
// @ApiMember(Description="The opaque session key that identifies the reservation.")
/** @var string */
public string $SessionKey='',
/** @description The reserved service id. */
// @ApiMember(Description="The reserved service id.")
/** @var int */
public int $ServiceId=0,
/** @description The reservation start. */
// @ApiMember(Description="The reservation start.")
/** @var DateTime */
public DateTime $From=new DateTime(),
/** @description The reservation end. */
// @ApiMember(Description="The reservation end.")
/** @var DateTime */
public DateTime $To=new DateTime(),
/** @description Number of reserved spots. */
// @ApiMember(Description="Number of reserved spots.")
/** @var int */
public int $NumberOfBookedSpots=0,
/** @description When the hold expires (company-local time). */
// @ApiMember(Description="When the hold expires (company-local time).")
/** @var DateTime */
public DateTime $ExpirationDatetime=new DateTime(),
/** @description The BookingReservationStatus value. */
// @ApiMember(Description="The BookingReservationStatus value.")
/** @var int */
public int $StatusCode=0,
/** @description The BookingReservationStatus name. */
// @ApiMember(Description="The BookingReservationStatus name.")
/** @var string */
public string $StatusName='',
/** @description The customer id holding the reservation, if any. */
// @ApiMember(Description="The customer id holding the reservation, if any.")
/** @var string|null */
public ?string $CustomerId=null,
/** @description The customer's full name, when a customer is attached. */
// @ApiMember(Description="The customer's full name, when a customer is attached.")
/** @var string */
public string $CustomerName='',
/** @description The customer email (falls back to the BookedBy email when no customer is attached). */
// @ApiMember(Description="The customer email (falls back to the BookedBy email when no customer is attached).")
/** @var string */
public string $CustomerEmail=''
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['SessionKey'])) $this->SessionKey = $o['SessionKey'];
if (isset($o['ServiceId'])) $this->ServiceId = $o['ServiceId'];
if (isset($o['From'])) $this->From = JsonConverters::from('DateTime', $o['From']);
if (isset($o['To'])) $this->To = JsonConverters::from('DateTime', $o['To']);
if (isset($o['NumberOfBookedSpots'])) $this->NumberOfBookedSpots = $o['NumberOfBookedSpots'];
if (isset($o['ExpirationDatetime'])) $this->ExpirationDatetime = JsonConverters::from('DateTime', $o['ExpirationDatetime']);
if (isset($o['StatusCode'])) $this->StatusCode = $o['StatusCode'];
if (isset($o['StatusName'])) $this->StatusName = $o['StatusName'];
if (isset($o['CustomerId'])) $this->CustomerId = $o['CustomerId'];
if (isset($o['CustomerName'])) $this->CustomerName = $o['CustomerName'];
if (isset($o['CustomerEmail'])) $this->CustomerEmail = $o['CustomerEmail'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->SessionKey)) $o['SessionKey'] = $this->SessionKey;
if (isset($this->ServiceId)) $o['ServiceId'] = $this->ServiceId;
if (isset($this->From)) $o['From'] = JsonConverters::to('DateTime', $this->From);
if (isset($this->To)) $o['To'] = JsonConverters::to('DateTime', $this->To);
if (isset($this->NumberOfBookedSpots)) $o['NumberOfBookedSpots'] = $this->NumberOfBookedSpots;
if (isset($this->ExpirationDatetime)) $o['ExpirationDatetime'] = JsonConverters::to('DateTime', $this->ExpirationDatetime);
if (isset($this->StatusCode)) $o['StatusCode'] = $this->StatusCode;
if (isset($this->StatusName)) $o['StatusName'] = $this->StatusName;
if (isset($this->CustomerId)) $o['CustomerId'] = $this->CustomerId;
if (isset($this->CustomerName)) $o['CustomerName'] = $this->CustomerName;
if (isset($this->CustomerEmail)) $o['CustomerEmail'] = $this->CustomerEmail;
return empty($o) ? new class(){} : $o;
}
}
class QueryBookingReservationsResponse implements JsonSerializable
{
public function __construct(
/** @description The matching reservation holds. */
// @ApiMember(Description="The matching reservation holds.")
/** @var array<AdminBookingReservationResult>|null */
public ?array $Results=null,
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Results'])) $this->Results = JsonConverters::fromArray('AdminBookingReservationResult', $o['Results']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Results)) $o['Results'] = JsonConverters::toArray('AdminBookingReservationResult', $this->Results);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You are not an administrator for the requested company", StatusCode=403)
class QueryBookingReservations implements ICompany, JsonSerializable
{
public function __construct(
/** @description The company id, if empty will use the company id for the user you are logged in with. */
// @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
/** @var string|null */
public ?string $CompanyId=null,
/** @description Only holds for this service id. */
// @ApiMember(Description="Only holds for this service id.")
/** @var int|null */
public ?int $ServiceId=null,
/** @description Only holds whose start (From) is on or after this datetime. */
// @ApiMember(Description="Only holds whose start (From) is on or after this datetime.")
/** @var DateTime|null */
public ?DateTime $From=null,
/** @description Only holds whose start (From) is on or before this datetime. */
// @ApiMember(Description="Only holds whose start (From) is on or before this datetime.")
/** @var DateTime|null */
public ?DateTime $To=null,
/** @description Filter by BookingReservationStatus value. When omitted, the spot-holding statuses (Selecting=1, AwaitingPayment=2) are returned. */
// @ApiMember(Description="Filter by BookingReservationStatus value. When omitted, the spot-holding statuses (Selecting=1, AwaitingPayment=2) are returned.")
/** @var int|null */
public ?int $StatusCode=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['ServiceId'])) $this->ServiceId = $o['ServiceId'];
if (isset($o['From'])) $this->From = JsonConverters::from('DateTime', $o['From']);
if (isset($o['To'])) $this->To = JsonConverters::from('DateTime', $o['To']);
if (isset($o['StatusCode'])) $this->StatusCode = $o['StatusCode'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->ServiceId)) $o['ServiceId'] = $this->ServiceId;
if (isset($this->From)) $o['From'] = JsonConverters::to('DateTime', $this->From);
if (isset($this->To)) $o['To'] = JsonConverters::to('DateTime', $this->To);
if (isset($this->StatusCode)) $o['StatusCode'] = $this->StatusCode;
return empty($o) ? new class(){} : $o;
}
}
PHP 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>