| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| DELETE | /timeexceptions/{Id} | Delete a given time exception that the user have access too |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
@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")
open class DeleteResourceTimeException : ICompany
{
/**
* 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.")
var CompanyId:UUID? = null
/**
* Time exception id to be deleted
*/
@ApiMember(Description="Time exception id to be deleted")
var Id:Int? = null
}
open class ResourceTimeExceptionQueryResponse
{
/**
* Time exception id
*/
@ApiMember(Description="Time exception id")
var Id:Int? = null
/**
* Time company id
*/
@ApiMember(Description="Time company id")
var CompanyId:UUID? = null
/**
* If it's locked for editing for the logged in administrator
*/
@ApiMember(Description="If it's locked for editing for the logged in administrator")
var Locked:Boolean? = null
/**
* Resources that owns this exception
*/
@ApiMember(Description="Resources that owns this exception")
var ResourceIds:ArrayList<Int>? = null
/**
* Resources that owns this exception
*/
@ApiMember(Description="Resources that owns this exception")
var Resources:ArrayList<TimeExceptionReosurceDetails> = ArrayList<TimeExceptionReosurceDetails>()
/**
* Indicates wheter or not the time exception is recurring
*/
@ApiMember(Description="Indicates wheter or not the time exception is recurring")
var IsRecurring:Boolean? = null
/**
* Time exception starting timestamp
*/
@ApiMember(Description="Time exception starting timestamp")
var From:Date? = null
/**
* Time exception ending timestamp
*/
@ApiMember(Description="Time exception ending timestamp")
var To:Date? = null
/**
* 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")
var FromTime:TimeSpan? = null
/**
* 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")
var ToTime:TimeSpan? = null
/**
* The reason of the time exception, example: Vacation, doctors appointment, ...
*/
@ApiMember(Description="The reason of the time exception, example: Vacation, doctors appointment, ...")
var ReasonText:String? = null
/**
* 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, ...")
var ReasonTextPublic:String? = null
/**
* What hexadecimal color code the exception should have in the scheduler
*/
@ApiMember(Description="What hexadecimal color code the exception should have in the scheduler")
var Color:String? = null
/**
* 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")
var BlockTime:Boolean? = null
/**
* 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")
var Private:Boolean? = null
/**
* The status for export to calendars like Gcal
*/
@ApiMember(Description="The status for export to calendars like Gcal")
var CalendarExportStatus:ExceptionCalendarExportStatus? = null
/**
* 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")
var DaysOfWeek:ArrayList<DayOfWeekDto> = ArrayList<DayOfWeekDto>()
/**
* The datetime the exception was created
*/
@ApiMember(Description="The datetime the exception was created")
var Created:Date? = null
var ResponseStatus:ResponseStatus? = null
}
open class TimeExceptionReosurceDetails
{
/**
* Ids of the resources that owns this exception
*/
@ApiMember(Description="Ids of the resources that owns this exception")
var Id:Int? = null
/**
* Name of the resource
*/
@ApiMember(Description="Name of the resource")
var Name:String? = null
/**
* Description of the resource
*/
@ApiMember(Description="Description of the resource")
var Description:String? = null
/**
* Color of the resource
*/
@ApiMember(Description="Color of the resource")
var Color:String? = null
/**
* Image of the resource
*/
@ApiMember(Description="Image of the resource")
var ImageUrl:Uri? = null
var ResponseStatus:ResponseStatus? = null
}
open class ExceptionCalendarExportStatus
{
var CalendarId:String? = null
var ExceptionId:Int? = null
var Synced:Boolean? = null
}
open class DayOfWeekDto
{
var DayOfWeekId:Int? = null
var DotNetDayOfWeekId:Int? = null
var DayOfWeek:String? = null
}
Kotlin 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: testapi.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
}
}
}