| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /timeexceptions/{Id} | Updates a time exception for a given resource belonging to the current user | Updates a time exception for a given resource belonging to the current user if no colliding bookings are found. If a colliding booking is found. A time exception must be either recurring (DaysOfWeek is set and From and To is the valid range for the recurrency) or non recurring (From and To are set) |
|---|
"use strict";
export class TimeExceptionReosurceDetails {
/** @param {{Id?:number,Name?:string,Description?:string,Color?:string,ImageUrl?:string,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Ids of the resources that owns this exception */
Id;
/**
* @type {string}
* @description Name of the resource */
Name;
/**
* @type {string}
* @description Description of the resource */
Description;
/**
* @type {string}
* @description Color of the resource */
Color;
/**
* @type {string}
* @description Image of the resource */
ImageUrl;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class ExceptionCalendarExportStatus {
/** @param {{CalendarId?:string,ExceptionId?:number,Synced?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CalendarId;
/** @type {number} */
ExceptionId;
/** @type {?boolean} */
Synced;
}
export class DayOfWeekDto {
/** @param {{DayOfWeekId?:number,DotNetDayOfWeekId?:number,DayOfWeek?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
DayOfWeekId;
/** @type {number} */
DotNetDayOfWeekId;
/** @type {string} */
DayOfWeek;
}
export class ResourceTimeExceptionQueryResponse {
/** @param {{Id?:number,CompanyId?:string,Locked?:boolean,ResourceIds?:number[],Resources?:TimeExceptionReosurceDetails[],IsRecurring?:boolean,From?:string,To?:string,FromTime?:string,ToTime?:string,ReasonText?:string,ReasonTextPublic?:string,Color?:string,BlockTime?:boolean,Private?:boolean,CalendarExportStatus?:ExceptionCalendarExportStatus,DaysOfWeek?:DayOfWeekDto[],Created?:string,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {number}
* @description Time exception id */
Id;
/**
* @type {string}
* @description Time company id */
CompanyId;
/**
* @type {boolean}
* @description If it's locked for editing for the logged in administrator */
Locked;
/**
* @type {number[]}
* @description Resources that owns this exception */
ResourceIds;
/**
* @type {TimeExceptionReosurceDetails[]}
* @description Resources that owns this exception */
Resources;
/**
* @type {boolean}
* @description Indicates wheter or not the time exception is recurring */
IsRecurring;
/**
* @type {string}
* @description Time exception starting timestamp */
From;
/**
* @type {string}
* @description Time exception ending timestamp */
To;
/**
* @type {string}
* @description If recurring then this value indicates the time of day when the time exception begins */
FromTime;
/**
* @type {string}
* @description If recurring then this value indicates the time of day when the time exception ends */
ToTime;
/**
* @type {string}
* @description The reason of the time exception, example: Vacation, doctors appointment, ... */
ReasonText;
/**
* @type {string}
* @description The reason of the time exception that could be public to customers, example: Vacation, Closed, Sick leave, ... */
ReasonTextPublic;
/**
* @type {string}
* @description What hexadecimal color code the exception should have in the scheduler */
Color;
/**
* @type {boolean}
* @description If the time exception should block the time in the scheduler so it's not avaialable to book */
BlockTime;
/**
* @type {boolean}
* @description If the ReasonText should only be visible to conncted resources. If false, all resources will be able to see it */
Private;
/**
* @type {ExceptionCalendarExportStatus}
* @description The status for export to calendars like Gcal */
CalendarExportStatus;
/**
* @type {DayOfWeekDto[]}
* @description If recurring, an array indicating which days of the week the exception recures on where 1 = Monday .. 7 = Sunday. When recurring then the time portion of the Fields From and To indicates the time of day the recurrence occurs */
DaysOfWeek;
/**
* @type {string}
* @description The datetime the exception was created */
Created;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class UpdateResourceTimeException {
/** @param {{CompanyId?:string,Id?:number,From?:string,To?:string,ResourceIds?:number[],FromTime?:string,ToTime?:string,DaysOfWeek?:number[],ReasonText?:string,ReasonTextPublic?:string,Color?:string,BlockTime?:boolean,Private?:boolean,Force?:boolean,CancelMessage?:string,SendSmsConfirmation?:boolean,SendEmailConfirmation?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description The company id, if empty will use the company id for the user you are logged in with. */
CompanyId;
/**
* @type {number}
* @description Tome exceptions id */
Id;
/**
* @type {?string}
* @description Time exception starting datestamp, only the date of day part is used of this value */
From;
/**
* @type {?string}
* @description Time exception ending datestamp, only the date of day part is used of this value */
To;
/**
* @type {number[]}
* @description Resource id of the resource that owns this exception */
ResourceIds;
/**
* @type {?string}
* @description This value indicates the time of day when the time exception begins. Example: 10:00. If Recurring this will be the startime for each recurring day. */
FromTime;
/**
* @type {?string}
* @description This value indicates the time of day when the time exception ends. Example: 12:00. If Recurring this will be the endtime for each recurring day. */
ToTime;
/**
* @type {number[]}
* @description A comma separated list of which days this day exception belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update. */
DaysOfWeek;
/**
* @type {string}
* @description The reason of the time exception, example: Vacation, doctors appointment, ... */
ReasonText;
/**
* @type {string}
* @description The reason of the time exception that could be public to customers, example: Vacation, Closed, Sick leave, ... */
ReasonTextPublic;
/**
* @type {string}
* @description What hexadecimal color code the exception should have in the scheduler */
Color;
/**
* @type {?boolean}
* @description If the time exception should block the time in the scheduler so it's not avaialable to book */
BlockTime;
/**
* @type {?boolean}
* @description If the ReasonText should only be visible to conncted resources. If false, all resources will be able to see it */
Private;
/**
* @type {boolean}
* @description If this equals true it will force to cancel all bookings that are colliding with the timeexception. */
Force;
/**
* @type {string}
* @description When Force=true and colliding bookings exsists, this message is the message that are sent to the users when canceling their bookings. */
CancelMessage;
/**
* @type {?boolean}
* @description When Force=true and colliding bookings exsists, send cancelmessage as SMS Confirmation */
SendSmsConfirmation;
/**
* @type {?boolean}
* @description When Force=true and colliding bookings exsists, send cancelmessage as Email Confirmation */
SendEmailConfirmation;
}
JavaScript UpdateResourceTimeException 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.
PUT /timeexceptions/{Id} HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateResourceTimeException xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<BlockTime>false</BlockTime>
<CancelMessage>String</CancelMessage>
<Color>String</Color>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<DaysOfWeek xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</DaysOfWeek>
<Force>false</Force>
<From>0001-01-01T00:00:00</From>
<FromTime>PT0S</FromTime>
<Id>0</Id>
<Private>false</Private>
<ReasonText>String</ReasonText>
<ReasonTextPublic>String</ReasonTextPublic>
<ResourceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</ResourceIds>
<SendEmailConfirmation>false</SendEmailConfirmation>
<SendSmsConfirmation>false</SendSmsConfirmation>
<To>0001-01-01T00:00:00</To>
<ToTime>PT0S</ToTime>
</UpdateResourceTimeException>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ResourceTimeExceptionQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<BlockTime>false</BlockTime>
<CalendarExportStatus>
<CalendarId>String</CalendarId>
<ExceptionId>0</ExceptionId>
<Synced>false</Synced>
</CalendarExportStatus>
<Color>String</Color>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Created>0001-01-01T00:00:00</Created>
<DaysOfWeek>
<DayOfWeekDto>
<DayOfWeek>String</DayOfWeek>
<DayOfWeekId>0</DayOfWeekId>
<DotNetDayOfWeekId>0</DotNetDayOfWeekId>
</DayOfWeekDto>
</DaysOfWeek>
<From>0001-01-01T00:00:00</From>
<FromTime>PT0S</FromTime>
<Id>0</Id>
<IsRecurring>false</IsRecurring>
<Locked>false</Locked>
<Private>false</Private>
<ReasonText>String</ReasonText>
<ReasonTextPublic>String</ReasonTextPublic>
<ResourceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</ResourceIds>
<Resources>
<TimeExceptionReosurceDetails>
<Color>String</Color>
<Description>String</Description>
<Id>0</Id>
<ImageUrl i:nil="true" />
<Name>String</Name>
<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>
</TimeExceptionReosurceDetails>
</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>
<To>0001-01-01T00:00:00</To>
<ToTime>PT0S</ToTime>
</ResourceTimeExceptionQueryResponse>