| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /schedules/date/{Id} | Update date schedule | Update date schedule to the company for the currently logged in user, only administrators are allowed to add schedules. |
|---|
<?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 DateScheduleDateResponse implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
/** @var DateTime */
public DateTime $From=new DateTime(),
/** @var DateTime */
public DateTime $To=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['From'])) $this->From = JsonConverters::from('DateTime', $o['From']);
if (isset($o['To'])) $this->To = JsonConverters::from('DateTime', $o['To']);
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->From)) $o['From'] = JsonConverters::to('DateTime', $this->From);
if (isset($this->To)) $o['To'] = JsonConverters::to('DateTime', $this->To);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
class ScheduleResources implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
/** @description Name of the resource */
// @ApiMember(Description="Name of the resource")
/** @var string|null */
public ?string $Name=null,
/** @description The image url of the resource */
// @ApiMember(Description="The image url of the resource")
/** @var string|null */
public ?string $ImageUrl=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['ImageUrl'])) $this->ImageUrl = JsonConverters::from('string', $o['ImageUrl']);
}
/** @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->ImageUrl)) $o['ImageUrl'] = JsonConverters::to('string', $this->ImageUrl);
return empty($o) ? new class(){} : $o;
}
}
class ScheduleServices implements JsonSerializable
{
public function __construct(
/** @var int */
public int $Id=0,
/** @description Name of the service */
// @ApiMember(Description="Name of the service")
/** @var string|null */
public ?string $Name=null,
/** @description The image url of the service */
// @ApiMember(Description="The image url of the service")
/** @var string|null */
public ?string $ImageUrl=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['ImageUrl'])) $this->ImageUrl = JsonConverters::from('string', $o['ImageUrl']);
}
/** @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->ImageUrl)) $o['ImageUrl'] = JsonConverters::to('string', $this->ImageUrl);
return empty($o) ? new class(){} : $o;
}
}
class DateScheduleQueryResponse implements JsonSerializable
{
public function __construct(
/** @description The schedule id */
// @ApiMember(Description="The schedule id")
/** @var int */
public int $Id=0,
/** @description Name of the schedule */
// @ApiMember(Description="Name of the schedule")
/** @var string|null */
public ?string $Name=null,
/** @description Description of the schedule */
// @ApiMember(Description="Description of the schedule")
/** @var string|null */
public ?string $Description=null,
/** @description If the schedule is active or not */
// @ApiMember(Description="If the schedule is active or not")
/** @var bool|null */
public ?bool $Active=null,
/** @description If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this. */
// @ApiMember(Description="If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.", IsRequired=true)
/** @var bool|null */
public ?bool $IsResourceSpecific=null,
/** @description Schedule dates */
// @ApiMember(Description="Schedule dates")
/** @var array<DateScheduleDateResponse>|null */
public ?array $ScheduleDates=null,
/** @description The resources that is connected to the schedule */
// @ApiMember(Description="The resources that is connected to the schedule")
/** @var array<ScheduleResources>|null */
public ?array $Resources=null,
/** @description The services that is connected to the schedule */
// @ApiMember(Description="The services that is connected to the schedule")
/** @var array<ScheduleServices>|null */
public ?array $Services=null,
/** @description The timestamp when the schedule was updated */
// @ApiMember(Description="The timestamp when the schedule was updated", IsRequired=true)
/** @var DateTime */
public DateTime $UpdatedDate=new DateTime(),
/** @description The timestamp when the schedule was created */
// @ApiMember(Description="The timestamp when the schedule was created", IsRequired=true)
/** @var DateTime */
public DateTime $CreatedDate=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['IsResourceSpecific'])) $this->IsResourceSpecific = $o['IsResourceSpecific'];
if (isset($o['ScheduleDates'])) $this->ScheduleDates = JsonConverters::fromArray('DateScheduleDateResponse', $o['ScheduleDates']);
if (isset($o['Resources'])) $this->Resources = JsonConverters::fromArray('ScheduleResources', $o['Resources']);
if (isset($o['Services'])) $this->Services = JsonConverters::fromArray('ScheduleServices', $o['Services']);
if (isset($o['UpdatedDate'])) $this->UpdatedDate = JsonConverters::from('DateTime', $o['UpdatedDate']);
if (isset($o['CreatedDate'])) $this->CreatedDate = JsonConverters::from('DateTime', $o['CreatedDate']);
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->IsResourceSpecific)) $o['IsResourceSpecific'] = $this->IsResourceSpecific;
if (isset($this->ScheduleDates)) $o['ScheduleDates'] = JsonConverters::toArray('DateScheduleDateResponse', $this->ScheduleDates);
if (isset($this->Resources)) $o['Resources'] = JsonConverters::toArray('ScheduleResources', $this->Resources);
if (isset($this->Services)) $o['Services'] = JsonConverters::toArray('ScheduleServices', $this->Services);
if (isset($this->UpdatedDate)) $o['UpdatedDate'] = JsonConverters::to('DateTime', $this->UpdatedDate);
if (isset($this->CreatedDate)) $o['CreatedDate'] = JsonConverters::to('DateTime', $this->CreatedDate);
if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
return empty($o) ? new class(){} : $o;
}
}
class AddDateScheduleDate implements JsonSerializable
{
public function __construct(
/** @description The from date for the timeslot */
// @ApiMember(Description="The from date for the timeslot", IsRequired=true)
/** @var DateTime */
public DateTime $From=new DateTime(),
/** @description The to date for the timeslot */
// @ApiMember(Description="The to date for the timeslot", IsRequired=true)
/** @var DateTime */
public DateTime $To=new DateTime()
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['From'])) $this->From = JsonConverters::from('DateTime', $o['From']);
if (isset($o['To'])) $this->To = JsonConverters::from('DateTime', $o['To']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->From)) $o['From'] = JsonConverters::to('DateTime', $this->From);
if (isset($this->To)) $o['To'] = JsonConverters::to('DateTime', $this->To);
return empty($o) ? new class(){} : $o;
}
}
class AddScheduleResource implements JsonSerializable
{
public function __construct(
/** @description The resource id */
// @ApiMember(Description="The resource id", IsRequired=true)
/** @var int */
public int $Id=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
return empty($o) ? new class(){} : $o;
}
}
class AddScheduleService implements JsonSerializable
{
public function __construct(
/** @description The service id */
// @ApiMember(Description="The service id", IsRequired=true)
/** @var int */
public int $Id=0
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
return empty($o) ? new class(){} : $o;
}
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class UpdateDateSchedule implements ICompany, JsonSerializable
{
public function __construct(
/** @description Id of the schedule to update */
// @ApiMember(Description="Id of the schedule to update", IsRequired=true, ParameterType="path")
/** @var int */
public int $Id=0,
/** @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 The schedule name */
// @ApiMember(Description="The schedule name")
/** @var string|null */
public ?string $Name=null,
/** @description The schedule description */
// @ApiMember(Description="The schedule description")
/** @var string|null */
public ?string $Description=null,
/** @description If schedule is active or not */
// @ApiMember(Description="If schedule is active or not")
/** @var bool|null */
public ?bool $Active=null,
/** @description The number of days the schedule is valid from todays date */
// @ApiMember(Description="The number of days the schedule is valid from todays date", IsRequired=true)
/** @var int */
public int $NumberOfScheduleDays=0,
/** @description The dates for the schedule. This is the actual timeslots. */
// @ApiMember(Description="The dates for the schedule. This is the actual timeslots.")
/** @var array<AddDateScheduleDate>|null */
public ?array $ScheduleDates=null,
/** @description If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources. */
// @ApiMember(Description="If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.")
/** @var array<AddScheduleResource>|null */
public ?array $Resources=null,
/** @description Set what services the schedule should be connected to. */
// @ApiMember(Description="Set what services the schedule should be connected to.")
/** @var array<AddScheduleService>|null */
public ?array $Services=null
) {
}
/** @throws Exception */
public function fromMap($o): void {
if (isset($o['Id'])) $this->Id = $o['Id'];
if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
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['NumberOfScheduleDays'])) $this->NumberOfScheduleDays = $o['NumberOfScheduleDays'];
if (isset($o['ScheduleDates'])) $this->ScheduleDates = JsonConverters::fromArray('AddDateScheduleDate', $o['ScheduleDates']);
if (isset($o['Resources'])) $this->Resources = JsonConverters::fromArray('AddScheduleResource', $o['Resources']);
if (isset($o['Services'])) $this->Services = JsonConverters::fromArray('AddScheduleService', $o['Services']);
}
/** @throws Exception */
public function jsonSerialize(): mixed
{
$o = [];
if (isset($this->Id)) $o['Id'] = $this->Id;
if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
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->NumberOfScheduleDays)) $o['NumberOfScheduleDays'] = $this->NumberOfScheduleDays;
if (isset($this->ScheduleDates)) $o['ScheduleDates'] = JsonConverters::toArray('AddDateScheduleDate', $this->ScheduleDates);
if (isset($this->Resources)) $o['Resources'] = JsonConverters::toArray('AddScheduleResource', $this->Resources);
if (isset($this->Services)) $o['Services'] = JsonConverters::toArray('AddScheduleService', $this->Services);
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.
PUT /schedules/date/{Id} HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateDateSchedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Active>false</Active>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
<NumberOfScheduleDays>0</NumberOfScheduleDays>
<Resources>
<AddScheduleResource>
<Id>0</Id>
</AddScheduleResource>
</Resources>
<ScheduleDates>
<AddDateScheduleDate>
<From>0001-01-01T00:00:00</From>
<To>0001-01-01T00:00:00</To>
</AddDateScheduleDate>
</ScheduleDates>
<Services>
<AddScheduleService>
<Id>0</Id>
</AddScheduleService>
</Services>
</UpdateDateSchedule>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DateScheduleQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<Active>false</Active>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<Description>String</Description>
<Id>0</Id>
<IsResourceSpecific>false</IsResourceSpecific>
<Name>String</Name>
<Resources>
<ScheduleResources>
<Id>0</Id>
<ImageUrl i:nil="true" />
<Name>String</Name>
</ScheduleResources>
</Resources>
<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>
<ScheduleDates>
<DateScheduleDateResponse>
<From>0001-01-01T00:00:00</From>
<Id>0</Id>
<ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
<d4p1:ErrorCode>String</d4p1:ErrorCode>
<d4p1:Message>String</d4p1:Message>
<d4p1:StackTrace>String</d4p1:StackTrace>
<d4p1:Errors>
<d4p1:ResponseError>
<d4p1:ErrorCode>String</d4p1:ErrorCode>
<d4p1:FieldName>String</d4p1:FieldName>
<d4p1:Message>String</d4p1:Message>
<d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:KeyValueOfstringstring>
<d7p1:Key>String</d7p1:Key>
<d7p1:Value>String</d7p1:Value>
</d7p1:KeyValueOfstringstring>
</d4p1:Meta>
</d4p1:ResponseError>
</d4p1:Errors>
<d4p1: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>
</d4p1:Meta>
</ResponseStatus>
<To>0001-01-01T00:00:00</To>
</DateScheduleDateResponse>
</ScheduleDates>
<Services>
<ScheduleServices>
<Id>0</Id>
<ImageUrl i:nil="true" />
<Name>String</Name>
</ScheduleServices>
</Services>
<UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
</DateScheduleQueryResponse>