| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| DELETE | /resource/{Id} | Delete a resource | Delete a resource for the currently logged in user, only administrators are allowed to delete resources. |
|---|
<?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 TimeException implements ITimeException, JsonSerializable
{
public function __construct(
/** @description Time exception id */
// @ApiMember(Description="Time exception id")
/** @var int */
public int $Id=0,
/** @description Indicates whether or not the time exception is recurring */
// @ApiMember(Description="Indicates whether or not the time exception is recurring")
/** @var bool|null */
public ?bool $IsRecurring=null,
/** @description Indicates whether the time exception is blocking the time or not */
// @ApiMember(Description="Indicates whether the time exception is blocking the time or not")
/** @var bool|null */
public ?bool $IsBlock=null,
/** @description The reason of the time exception, example: Vacation, doctors appointment, ... */
// @ApiMember(Description="The reason of the time exception, example: Vacation, doctors appointment, ...")
/** @var string|null */
public ?string $ReasonText=null,
/** @description The public reason of the time exception, example: Vacation, doctors appointment, ... */
// @ApiMember(Description="The public reason of the time exception, example: Vacation, doctors appointment, ...")
/** @var string|null */
public ?string $ReasonTextPublic=null,
/** @description Time exception start */
// @ApiMember(Description="Time exception start")
/** @var DateTime */
public DateTime $From=new DateTime(),
/** @description Time exception end */
// @ApiMember(Description="Time exception end")
/** @var DateTime */
public DateTime $To=new DateTime(),
/** @description Resources that owns this exception */
// @ApiMember(Description="Resources that owns this exception")
/** @var int[]|null */
public ?array $ResourceIds=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['IsRecurring'])) $this->IsRecurring = $o['IsRecurring'];
if (isset($o['IsBlock'])) $this->IsBlock = $o['IsBlock'];
if (isset($o['ReasonText'])) $this->ReasonText = $o['ReasonText'];
if (isset($o['ReasonTextPublic'])) $this->ReasonTextPublic = $o['ReasonTextPublic'];
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['ResourceIds'])) $this->ResourceIds = JsonConverters::fromArray('int', $o['ResourceIds']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->IsRecurring)) $o['IsRecurring'] = $this->IsRecurring;
if (isset($this->IsBlock)) $o['IsBlock'] = $this->IsBlock;
if (isset($this->ReasonText)) $o['ReasonText'] = $this->ReasonText;
if (isset($this->ReasonTextPublic)) $o['ReasonTextPublic'] = $this->ReasonTextPublic;
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->ResourceIds)) $o['ResourceIds'] = JsonConverters::toArray('int', $this->ResourceIds);
return empty($o) ? new class(){} : $o;
}
}
enum BookingStatusEnum : int
{
case Booked = 1;
case Unbooked = 2;
case Reserved = 3;
case Canceled = 4;
case AwaitingPayment = 5;
case AwaitingPaymentNoTimeLimit = 6;
case Payed = 7;
case AwaitingPaymentRequestFromAdmin = 8;
case AwaitingPaymentFromProvider = 9;
case Invoiced = 10;
}
class BookedCustomer implements JsonSerializable
{
public function __construct(
/** @var string */
public string $Id='',
/** @var string|null */
public ?string $Firstname=null,
/** @var string|null */
public ?string $Lastname=null,
/** @var string|null */
public ?string $Email=null,
/** @var string|null */
public ?string $Phone=null,
/** @var string|null */
public ?string $FacebookUserName=null,
/** @var string|null */
public ?string $ImageUrl=null,
/** @var string|null */
public ?string $CorporateIdentityNumber=null,
/** @var string|null */
public ?string $InvoiceAddress1=null,
/** @var string|null */
public ?string $InvoiceAddress2=null,
/** @var string|null */
public ?string $InvoiceCity=null,
/** @var string|null */
public ?string $InvoicePostalCode=null,
/** @var string|null */
public ?string $InvoiceCountryCode=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Firstname'])) $this->Firstname = $o['Firstname'];
if (isset($o['Lastname'])) $this->Lastname = $o['Lastname'];
if (isset($o['Email'])) $this->Email = $o['Email'];
if (isset($o['Phone'])) $this->Phone = $o['Phone'];
if (isset($o['FacebookUserName'])) $this->FacebookUserName = $o['FacebookUserName'];
if (isset($o['ImageUrl'])) $this->ImageUrl = $o['ImageUrl'];
if (isset($o['CorporateIdentityNumber'])) $this->CorporateIdentityNumber = $o['CorporateIdentityNumber'];
if (isset($o['InvoiceAddress1'])) $this->InvoiceAddress1 = $o['InvoiceAddress1'];
if (isset($o['InvoiceAddress2'])) $this->InvoiceAddress2 = $o['InvoiceAddress2'];
if (isset($o['InvoiceCity'])) $this->InvoiceCity = $o['InvoiceCity'];
if (isset($o['InvoicePostalCode'])) $this->InvoicePostalCode = $o['InvoicePostalCode'];
if (isset($o['InvoiceCountryCode'])) $this->InvoiceCountryCode = $o['InvoiceCountryCode'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Firstname)) $o['Firstname'] = $this->Firstname;
if (isset($this->Lastname)) $o['Lastname'] = $this->Lastname;
if (isset($this->Email)) $o['Email'] = $this->Email;
if (isset($this->Phone)) $o['Phone'] = $this->Phone;
if (isset($this->FacebookUserName)) $o['FacebookUserName'] = $this->FacebookUserName;
if (isset($this->ImageUrl)) $o['ImageUrl'] = $this->ImageUrl;
if (isset($this->CorporateIdentityNumber)) $o['CorporateIdentityNumber'] = $this->CorporateIdentityNumber;
if (isset($this->InvoiceAddress1)) $o['InvoiceAddress1'] = $this->InvoiceAddress1;
if (isset($this->InvoiceAddress2)) $o['InvoiceAddress2'] = $this->InvoiceAddress2;
if (isset($this->InvoiceCity)) $o['InvoiceCity'] = $this->InvoiceCity;
if (isset($this->InvoicePostalCode)) $o['InvoicePostalCode'] = $this->InvoicePostalCode;
if (isset($this->InvoiceCountryCode)) $o['InvoiceCountryCode'] = $this->InvoiceCountryCode;
return empty($o) ? new class(){} : $o;
}
}
class BookedTime implements IBookedTime, JsonSerializable
{
public function __construct(
/** @description Booking id */
// @ApiMember(Description="Booking id")
/** @var int */
public int $Id=0,
/** @description The booked service */
// @ApiMember(Description="The booked service")
/** @var int */
public int $ServiceId=0,
/** @description Booking start */
// @ApiMember(Description="Booking start")
/** @var DateTime */
public DateTime $From=new DateTime(),
/** @description Booking end */
// @ApiMember(Description="Booking end")
/** @var DateTime */
public DateTime $To=new DateTime(),
/** @description Number of booked spots */
// @ApiMember(Description="Number of booked spots")
/** @var int */
public int $BookedSpots=0,
/** @description Number of total spots for the service */
// @ApiMember(Description="Number of total spots for the service")
/** @var int */
public int $TotalSpots=0,
/** @description The pause after the booking */
// @ApiMember(Description="The pause after the booking")
/** @var int */
public int $PauseAfterInMinutes=0,
/** @description The booking status */
// @ApiMember(Description="The booking status")
/** @var int */
public int $StatusId=0,
/** @var BookingStatusEnum|null */
public ?BookingStatusEnum $Status=null,
/** @description The customer the booking belongs to */
// @ApiMember(Description="The customer the booking belongs to")
/** @var BookedCustomer|null */
public ?BookedCustomer $Customer=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
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['BookedSpots'])) $this->BookedSpots = $o['BookedSpots'];
if (isset($o['TotalSpots'])) $this->TotalSpots = $o['TotalSpots'];
if (isset($o['PauseAfterInMinutes'])) $this->PauseAfterInMinutes = $o['PauseAfterInMinutes'];
if (isset($o['StatusId'])) $this->StatusId = $o['StatusId'];
if (isset($o['Status'])) $this->Status = JsonConverters::from('BookingStatusEnum', $o['Status']);
if (isset($o['Customer'])) $this->Customer = JsonConverters::from('BookedCustomer', $o['Customer']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
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->BookedSpots)) $o['BookedSpots'] = $this->BookedSpots;
if (isset($this->TotalSpots)) $o['TotalSpots'] = $this->TotalSpots;
if (isset($this->PauseAfterInMinutes)) $o['PauseAfterInMinutes'] = $this->PauseAfterInMinutes;
if (isset($this->StatusId)) $o['StatusId'] = $this->StatusId;
if (isset($this->Status)) $o['Status'] = JsonConverters::to('BookingStatusEnum', $this->Status);
if (isset($this->Customer)) $o['Customer'] = JsonConverters::to('BookedCustomer', $this->Customer);
return empty($o) ? new class(){} : $o;
}
}
class ResourceQueryResponse implements JsonSerializable
{
public function __construct(
/** @description The resource id */
// @ApiMember(Description="The resource id")
/** @var int */
public int $Id=0,
/** @description The resource name */
// @ApiMember(Description="The resource name")
/** @var string|null */
public ?string $Name=null,
/** @description The resource description */
// @ApiMember(Description="The resource description")
/** @var string|null */
public ?string $Description=null,
/** @description If resource is active or not */
// @ApiMember(Description="If resource is active or not")
/** @var bool|null */
public ?bool $Active=null,
/** @description The resource color in scheduler in hexadecimal color code. Example: #00b0f0 for blue. */
// @ApiMember(Description="The resource color in scheduler in hexadecimal color code. Example: #00b0f0 for blue.")
/** @var string|null */
public ?string $Color=null,
/** @description The email of the resource */
// @ApiMember(Description="The email of the resource")
/** @var string|null */
public ?string $Email=null,
/** @description The image url of the resource */
// @ApiMember(Description="The image url of the resource")
/** @var string|null */
public ?string $ImageUrl=null,
/** @description The mobile phone number of the resource */
// @ApiMember(Description="The mobile phone number of the resource")
/** @var string|null */
public ?string $MobilePhone=null,
/** @description Used by example code locks to know what access group the resource is assigned to */
// @ApiMember(Description="Used by example code locks to know what access group the resource is assigned to")
/** @var string|null */
public ?string $AccessGroup=null,
/** @description If the resource should receive email notification when booked */
// @ApiMember(Description="If the resource should receive email notification when booked")
/** @var bool|null */
public ?bool $EmailNotification=null,
/** @description If the resource should receive SMS notification when booked */
// @ApiMember(Description="If the resource should receive SMS notification when booked")
/** @var bool|null */
public ?bool $SMSNotification=null,
/** @description If the resource should receive email reminders on bookings */
// @ApiMember(Description="If the resource should receive email reminders on bookings")
/** @var bool|null */
public ?bool $SendEmailReminder=null,
/** @description If the resource should receive SMS reminders on bookings */
// @ApiMember(Description="If the resource should receive SMS reminders on bookings")
/** @var bool|null */
public ?bool $SendSMSReminder=null,
/** @description The resource time exceptions */
// @ApiMember(Description="The resource time exceptions")
/** @var array<TimeException>|null */
public ?array $Exceptions=null,
/** @description The resource bookings */
// @ApiMember(Description="The resource bookings")
/** @var array<BookedTime>|null */
public ?array $Bookings=null,
/** @description Then date when the resource was created */
// @ApiMember(Description="Then date when the resource was created")
/** @var DateTime */
public DateTime $Created=new DateTime(),
/** @description Then date when the resource was updated */
// @ApiMember(Description="Then date when the resource was updated")
/** @var DateTime */
public DateTime $Updated=new DateTime(),
/** @var ResponseStatus|null */
public ?ResponseStatus $ResponseStatus=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Name'])) $this->Name = $o['Name'];
if (isset($o['Description'])) $this->Description = $o['Description'];
if (isset($o['Active'])) $this->Active = $o['Active'];
if (isset($o['Color'])) $this->Color = $o['Color'];
if (isset($o['Email'])) $this->Email = $o['Email'];
if (isset($o['ImageUrl'])) $this->ImageUrl = JsonConverters::from('string', $o['ImageUrl']);
if (isset($o['MobilePhone'])) $this->MobilePhone = $o['MobilePhone'];
if (isset($o['AccessGroup'])) $this->AccessGroup = $o['AccessGroup'];
if (isset($o['EmailNotification'])) $this->EmailNotification = $o['EmailNotification'];
if (isset($o['SMSNotification'])) $this->SMSNotification = $o['SMSNotification'];
if (isset($o['SendEmailReminder'])) $this->SendEmailReminder = $o['SendEmailReminder'];
if (isset($o['SendSMSReminder'])) $this->SendSMSReminder = $o['SendSMSReminder'];
if (isset($o['Exceptions'])) $this->Exceptions = JsonConverters::fromArray('TimeException', $o['Exceptions']);
if (isset($o['Bookings'])) $this->Bookings = JsonConverters::fromArray('BookedTime', $o['Bookings']);
if (isset($o['Created'])) $this->Created = JsonConverters::from('DateTime', $o['Created']);
if (isset($o['Updated'])) $this->Updated = JsonConverters::from('DateTime', $o['Updated']);
if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Name)) $o['Name'] = $this->Name;
if (isset($this->Description)) $o['Description'] = $this->Description;
if (isset($this->Active)) $o['Active'] = $this->Active;
if (isset($this->Color)) $o['Color'] = $this->Color;
if (isset($this->Email)) $o['Email'] = $this->Email;
if (isset($this->ImageUrl)) $o['ImageUrl'] = JsonConverters::to('string', $this->ImageUrl);
if (isset($this->MobilePhone)) $o['MobilePhone'] = $this->MobilePhone;
if (isset($this->AccessGroup)) $o['AccessGroup'] = $this->AccessGroup;
if (isset($this->EmailNotification)) $o['EmailNotification'] = $this->EmailNotification;
if (isset($this->SMSNotification)) $o['SMSNotification'] = $this->SMSNotification;
if (isset($this->SendEmailReminder)) $o['SendEmailReminder'] = $this->SendEmailReminder;
if (isset($this->SendSMSReminder)) $o['SendSMSReminder'] = $this->SendSMSReminder;
if (isset($this->Exceptions)) $o['Exceptions'] = JsonConverters::toArray('TimeException', $this->Exceptions);
if (isset($this->Bookings)) $o['Bookings'] = JsonConverters::toArray('BookedTime', $this->Bookings);
if (isset($this->Created)) $o['Created'] = JsonConverters::to('DateTime', $this->Created);
if (isset($this->Updated)) $o['Updated'] = JsonConverters::to('DateTime', $this->Updated);
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 have too low privilegies to call this service", StatusCode=403)
// @ApiResponse(Description="Bookings exists that needs to be unbooked before creating this time exceptions, use the /timeexceptions/collidingevents to find which bookings and use the booking service to unbook them", StatusCode=409)
// @ValidateRequest(Validator="IsAuthenticated")
class DeleteResource implements ICompany, JsonSerializable
{
public function __construct(
/** @description Enter the company id, if blank company id and you are an admin, your company id will be used. */
// @ApiMember(Description="Enter the company id, if blank company id and you are an admin, your company id will be used.", IsRequired=true)
/** @var string */
public string $CompanyId='',
/** @description Id of the resource to delete */
// @ApiMember(Description="Id of the resource to delete", IsRequired=true)
/** @var int */
public int $Id=0,
/** @description If this equals true it will force to set the resource as active = false, this is used when bookings exists on the resource and it can't be deleted. */
// @ApiMember(Description="If this equals true it will force to set the resource as active = false, this is used when bookings exists on the resource and it can't be deleted. ")
/** @var bool|null */
public ?bool $Force=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['Force'])) $this->Force = $o['Force'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->Force)) $o['Force'] = $this->Force;
return empty($o) ? new class(){} : $o;
}
}
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.
DELETE /resource/{Id} HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ResourceQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<AccessGroup>String</AccessGroup>
<Active>false</Active>
<Bookings>
<BookedTime>
<BookedSpots>0</BookedSpots>
<Customer>
<CorporateIdentityNumber>String</CorporateIdentityNumber>
<Email>String</Email>
<FacebookUserName>String</FacebookUserName>
<Firstname>String</Firstname>
<Id>00000000-0000-0000-0000-000000000000</Id>
<ImageUrl>String</ImageUrl>
<InvoiceAddress1>String</InvoiceAddress1>
<InvoiceAddress2>String</InvoiceAddress2>
<InvoiceCity>String</InvoiceCity>
<InvoiceCountryCode>String</InvoiceCountryCode>
<InvoicePostalCode>String</InvoicePostalCode>
<Lastname>String</Lastname>
<Phone>String</Phone>
</Customer>
<From>0001-01-01T00:00:00</From>
<Id>0</Id>
<PauseAfterInMinutes>0</PauseAfterInMinutes>
<ServiceId>0</ServiceId>
<Status>Booked</Status>
<StatusId>0</StatusId>
<To>0001-01-01T00:00:00</To>
<TotalSpots>0</TotalSpots>
</BookedTime>
</Bookings>
<Color>String</Color>
<Created>0001-01-01T00:00:00</Created>
<Description>String</Description>
<Email>String</Email>
<EmailNotification>false</EmailNotification>
<Exceptions>
<TimeException>
<From>0001-01-01T00:00:00</From>
<Id>0</Id>
<IsBlock>false</IsBlock>
<IsRecurring>false</IsRecurring>
<ReasonText>String</ReasonText>
<ReasonTextPublic>String</ReasonTextPublic>
<ResourceIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:int>0</d4p1:int>
</ResourceIds>
<To>0001-01-01T00:00:00</To>
</TimeException>
</Exceptions>
<Id>0</Id>
<ImageUrl i:nil="true" />
<MobilePhone>String</MobilePhone>
<Name>String</Name>
<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>
<SMSNotification>false</SMSNotification>
<SendEmailReminder>false</SendEmailReminder>
<SendSMSReminder>false</SendSMSReminder>
<Updated>0001-01-01T00:00:00</Updated>
</ResourceQueryResponse>