| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| DELETE | /timeexceptions/{Id} | Delete a given time exception that the user have access too |
|---|
export class TimeExceptionReosurceDetails
{
/** @description Ids of the resources that owns this exception */
// @ApiMember(Description="Ids of the resources that owns this exception")
public Id: number;
/** @description Name of the resource */
// @ApiMember(Description="Name of the resource")
public Name: string;
/** @description Description of the resource */
// @ApiMember(Description="Description of the resource")
public Description: string;
/** @description Color of the resource */
// @ApiMember(Description="Color of the resource")
public Color: string;
/** @description Image of the resource */
// @ApiMember(Description="Image of the resource")
public ImageUrl: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<TimeExceptionReosurceDetails>) { (Object as any).assign(this, init); }
}
export class ExceptionCalendarExportStatus
{
public CalendarId: string;
public ExceptionId: number;
public Synced?: boolean;
public constructor(init?: Partial<ExceptionCalendarExportStatus>) { (Object as any).assign(this, init); }
}
export class DayOfWeekDto
{
public DayOfWeekId: number;
public DotNetDayOfWeekId: number;
public DayOfWeek: string;
public constructor(init?: Partial<DayOfWeekDto>) { (Object as any).assign(this, init); }
}
export class ResourceTimeExceptionQueryResponse
{
/** @description Time exception id */
// @ApiMember(Description="Time exception id")
public Id: number;
/** @description Time company id */
// @ApiMember(Description="Time company id")
public CompanyId: string;
/** @description If it's locked for editing for the logged in administrator */
// @ApiMember(Description="If it's locked for editing for the logged in administrator")
public Locked: boolean;
/** @description Resources that owns this exception */
// @ApiMember(Description="Resources that owns this exception")
public ResourceIds: number[];
/** @description Resources that owns this exception */
// @ApiMember(Description="Resources that owns this exception")
public Resources: TimeExceptionReosurceDetails[];
/** @description Indicates wheter or not the time exception is recurring */
// @ApiMember(Description="Indicates wheter or not the time exception is recurring")
public IsRecurring: boolean;
/** @description Time exception starting timestamp */
// @ApiMember(Description="Time exception starting timestamp")
public From: string;
/** @description Time exception ending timestamp */
// @ApiMember(Description="Time exception ending timestamp")
public To: string;
/** @description If recurring then this value indicates the time of day when the time exception begins */
// @ApiMember(Description="If recurring then this value indicates the time of day when the time exception begins")
public FromTime: string;
/** @description If recurring then this value indicates the time of day when the time exception ends */
// @ApiMember(Description="If recurring then this value indicates the time of day when the time exception ends")
public ToTime: string;
/** @description The reason of the time exception, example: Vacation, doctors appointment, ... */
// @ApiMember(Description="The reason of the time exception, example: Vacation, doctors appointment, ...")
public ReasonText: string;
/** @description The reason of the time exception that could be public to customers, example: Vacation, Closed, Sick leave, ... */
// @ApiMember(Description="The reason of the time exception that could be public to customers, example: Vacation, Closed, Sick leave, ...")
public ReasonTextPublic: string;
/** @description What hexadecimal color code the exception should have in the scheduler */
// @ApiMember(Description="What hexadecimal color code the exception should have in the scheduler")
public Color: string;
/** @description If the time exception should block the time in the scheduler so it's not avaialable to book */
// @ApiMember(Description="If the time exception should block the time in the scheduler so it's not avaialable to book")
public BlockTime: boolean;
/** @description If the ReasonText should only be visible to conncted resources. If false, all resources will be able to see it */
// @ApiMember(Description="If the ReasonText should only be visible to conncted resources. If false, all resources will be able to see it")
public Private: boolean;
/** @description The status for export to calendars like Gcal */
// @ApiMember(Description="The status for export to calendars like Gcal")
public CalendarExportStatus: ExceptionCalendarExportStatus;
/** @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 */
// @ApiMember(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")
public DaysOfWeek: DayOfWeekDto[];
/** @description The datetime the exception was created */
// @ApiMember(Description="The datetime the exception was created")
public Created: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<ResourceTimeExceptionQueryResponse>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
// @ValidateRequest(Validator="IsAuthenticated")
export class DeleteResourceTimeException implements ICompany
{
/** @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.")
public CompanyId?: string;
/** @description Time exception id to be deleted */
// @ApiMember(Description="Time exception id to be deleted")
public Id: number;
public constructor(init?: Partial<DeleteResourceTimeException>) { (Object as any).assign(this, init); }
}
TypeScript DeleteResourceTimeException 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.
DELETE /timeexceptions/{Id} HTTP/1.1
Host: api.bokamera.se
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,
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
}
}
}