BokaMera.API.Host

DeleteResourceTimeException

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
DELETE	/timeexceptions/{Id}	Delete a given time exception that the user have access too

"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 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,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 {DayOfWeekDto[]}
     * @description If recurring, an array indicating which days of the week the exception recurs 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 DeleteResourceTimeException {
    /** @param {{CompanyId?:string,Id?:number}} [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 Time exception id to be deleted */
    Id;
}

JavaScript DeleteResourceTimeException DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /timeexceptions/{Id} HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsv

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,
	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
		}
	}
}