BokaMera.API.Host

<back to all web services

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
import Foundation
import ServiceStack

// @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")
public class DeleteResourceTimeException : ICompany, Codable
{
    /**
    * 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 var companyId:String?

    /**
    * Time exception id to be deleted
    */
    // @ApiMember(Description="Time exception id to be deleted")
    public var id:Int

    required public init(){}
}

public class ResourceTimeExceptionQueryResponse : Codable
{
    /**
    * Time exception id
    */
    // @ApiMember(Description="Time exception id")
    public var id:Int

    /**
    * Time company id
    */
    // @ApiMember(Description="Time company id")
    public var companyId:String

    /**
    * 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 var locked:Bool

    /**
    * Resources that owns this exception
    */
    // @ApiMember(Description="Resources that owns this exception")
    public var resourceIds:[Int] = []

    /**
    * Resources that owns this exception
    */
    // @ApiMember(Description="Resources that owns this exception")
    public var resources:[TimeExceptionReosurceDetails] = []

    /**
    * Indicates wheter or not the time exception is recurring
    */
    // @ApiMember(Description="Indicates wheter or not the time exception is recurring")
    public var isRecurring:Bool

    /**
    * Time exception starting timestamp
    */
    // @ApiMember(Description="Time exception starting timestamp")
    public var from:Date

    /**
    * Time exception ending timestamp
    */
    // @ApiMember(Description="Time exception ending timestamp")
    public var to:Date

    /**
    * 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")
    @TimeSpan public var fromTime:TimeInterval

    /**
    * 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")
    @TimeSpan public var toTime:TimeInterval

    /**
    * The reason of the time exception, example: Vacation, doctors appointment, ...
    */
    // @ApiMember(Description="The reason of the time exception, example: Vacation, doctors appointment, ...")
    public var reasonText:String

    /**
    * 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 var reasonTextPublic:String

    /**
    * 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 var color:String

    /**
    * 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 var blockTime:Bool

    /**
    * 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 var `private`:Bool

    /**
    * The status for export to calendars like Gcal
    */
    // @ApiMember(Description="The status for export to calendars like Gcal")
    public var calendarExportStatus:ExceptionCalendarExportStatus

    /**
    * 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 var daysOfWeek:[DayOfWeekDto] = []

    /**
    * The datetime the exception was created
    */
    // @ApiMember(Description="The datetime the exception was created")
    public var created:Date

    public var responseStatus:ResponseStatus

    required public init(){}
}

public class TimeExceptionReosurceDetails : Codable
{
    /**
    * Ids of the resources that owns this exception
    */
    // @ApiMember(Description="Ids of the resources that owns this exception")
    public var id:Int

    /**
    * Name of the resource
    */
    // @ApiMember(Description="Name of the resource")
    public var name:String

    /**
    * Description of the resource
    */
    // @ApiMember(Description="Description of the resource")
    public var Description:String

    /**
    * Color of the resource
    */
    // @ApiMember(Description="Color of the resource")
    public var color:String

    /**
    * Image of the resource
    */
    // @ApiMember(Description="Image of the resource")
    public var imageUrl:Uri

    public var responseStatus:ResponseStatus

    required public init(){}
}

public class ExceptionCalendarExportStatus : Codable
{
    public var calendarId:String
    public var exceptionId:Int
    public var synced:Bool?

    required public init(){}
}

public class DayOfWeekDto : Codable
{
    public var dayOfWeekId:Int
    public var dotNetDayOfWeekId:Int
    public var dayOfWeek:String

    required public init(){}
}


Swift DeleteResourceTimeException DTOs

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

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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":"00:00:00","ToTime":"00:00:00","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"}}}