| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /timeexceptions | Inserts a time exception for a given resource belonging to the current user | Inserts 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;
}
/** @typedef {number} */
export var CollidingBookingOptions;
(function (CollidingBookingOptions) {
CollidingBookingOptions[CollidingBookingOptions["AddWithoutCancelingCollidingBookings"] = 1] = "AddWithoutCancelingCollidingBookings"
CollidingBookingOptions[CollidingBookingOptions["AddAndCancelCollidingBookings"] = 2] = "AddAndCancelCollidingBookings"
})(CollidingBookingOptions || (CollidingBookingOptions = {}));
export class CreateResourceTimeException {
/** @param {{CompanyId?:string,From?:string,To?:string,ResourceIds?:number[],FromTime?:string,ToTime?:string,DaysOfWeek?:number[],ReasonText?:string,ReasonTextPublic?:string,Color?:string,BlockTime?:boolean,Private?:boolean,CollidingBookingOptions?:CollidingBookingOptions,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 {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 */
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 {CollidingBookingOptions}
* @description By default sets to 1, which is to add time exception without canceling colliding bookings */
CollidingBookingOptions;
/**
* @type {boolean}
* @description If this equals true it will it add the time exception with the option you have selected in CollidingBookingOption. Default is to cancel all colliding bookings. */
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 CreateResourceTimeException DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /timeexceptions HTTP/1.1
Host: testapi.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
ResourceIds:
[
0
],
FromTime: PT0S,
ToTime: PT0S,
DaysOfWeek:
[
0
],
ReasonText: String,
ReasonTextPublic: String,
Color: String,
BlockTime: False,
Private: False,
CollidingBookingOptions: AddWithoutCancelingCollidingBookings,
Force: False,
CancelMessage: String,
SendSmsConfirmation: False,
SendEmailConfirmation: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
Locked: False,
ResourceIds:
[
0
],
Resources:
[
{
Id: 0,
Name: String,
Description: String,
Color: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}
],
IsRecurring: False,
FromTime: PT0S,
ToTime: PT0S,
ReasonText: String,
ReasonTextPublic: String,
Color: String,
BlockTime: False,
Private: False,
CalendarExportStatus:
{
CalendarId: String,
ExceptionId: 0,
Synced: False
},
DaysOfWeek:
[
{
DayOfWeekId: 0,
DotNetDayOfWeekId: 0,
DayOfWeek: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}