Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
DELETE | /timeexceptions/{Id} | Delete a given time exception that the user have access too |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CompanyId | query | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
Id | path | int | No | Time exception id to be deleted |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | Time exception id |
CompanyId | form | Guid | No | Time company id |
Locked | form | bool | No | If it's locked for editing for the logged in administrator |
ResourceIds | form | int[] | No | Resources that owns this exception |
Resources | form | List<TimeExceptionReosurceDetails> | No | Resources that owns this exception |
IsRecurring | form | bool | No | Indicates wheter or not the time exception is recurring |
From | form | DateTime | No | Time exception starting timestamp |
To | form | DateTime | No | Time exception ending timestamp |
FromTime | form | TimeSpan | No | If recurring then this value indicates the time of day when the time exception begins |
ToTime | form | TimeSpan | No | If recurring then this value indicates the time of day when the time exception ends |
ReasonText | form | string | No | The reason of the time exception, example: Vacation, doctors appointment, ... |
ReasonTextPublic | form | string | No | The reason of the time exception that could be public to customers, example: Vacation, Closed, Sick leave, ... |
Color | form | string | No | What hexadecimal color code the exception should have in the scheduler |
BlockTime | form | bool | No | If the time exception should block the time in the scheduler so it's not avaialable to book |
Private | form | bool | No | If the ReasonText should only be visible to conncted resources. If false, all resources will be able to see it |
CalendarExportStatus | form | ExceptionCalendarExportStatus | No | The status for export to calendars like Gcal |
DaysOfWeek | form | List<DayOfWeekDto> | No | 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 |
Created | form | DateTime | No | The datetime the exception was created |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | Ids of the resources that owns this exception |
Name | form | string | No | Name of the resource |
Description | form | string | No | Description of the resource |
Color | form | string | No | Color of the resource |
ImageUrl | form | Uri | No | Image of the resource |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CalendarId | form | string | No | |
ExceptionId | form | int | No | |
Synced | form | bool? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DayOfWeekId | form | int | No | |
DotNetDayOfWeekId | form | int | No | |
DayOfWeek | form | string | No |
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 } } }