BokaMera.API.Host

<back to all web services

DeleteRecurringSchedule

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/schedules/recurring/{Id}Remove a recurring scheduleRemove recurring schedule.
import java.math.*
import java.util.*
import net.servicestack.client.*


@ValidateRequest(Validator="IsAuthenticated")
open class DeleteRecurringSchedule : 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

    /**
    * The schedule id
    */
    @ApiMember(Description="The schedule id", IsRequired=true, ParameterType="path")
    var Id:Int? = null
}

open class RecurringScheduleQueryResponse
{
    /**
    * The schedule id
    */
    @ApiMember(Description="The schedule id")
    var Id:Int? = null

    /**
    * Name of the schedule
    */
    @ApiMember(Description="Name of the schedule")
    var Name:String? = null

    /**
    * Description of the schedule
    */
    @ApiMember(Description="Description of the schedule")
    var Description:String? = null

    /**
    * If the schedule is active or not
    */
    @ApiMember(Description="If the schedule is active or not")
    var Active:Boolean? = null

    /**
    * Time interval for available times Here you set the interval at which times should appear. For example, if you select the range 15minutes, and your service has an duration of 1 hour and opening hours are 9AM to 6PM you will see the following suggested times: 09AM-10PM 09:15AM-10:15PM, 09:30AM-10:30PM ,  ..... 04:45PM-05:45, 05:00PM-06:00PM
    */
    @ApiMember(Description="Time interval for available times Here you set the interval at which times should appear. For example, if you select the range 15minutes, and your service has an duration of 1 hour and opening hours are 9AM to 6PM you will see the following suggested times: 09AM-10PM 09:15AM-10:15PM, 09:30AM-10:30PM ,  ..... 04:45PM-05:45, 05:00PM-06:00PM", IsRequired=true)
    var TimeInterval:Int? = null

    /**
    * The timestamp to which the schedule is valid from
    */
    @ApiMember(Description="The timestamp to which the schedule is valid from", IsRequired=true)
    var ValidFrom:Date? = null

    /**
    * The timestamp to which the schedule is valid to
    */
    @ApiMember(Description="The timestamp to which the schedule is valid to", IsRequired=true)
    var ValidTo:Date? = null

    /**
    * The time for the schedule opening hours (starttime)
    */
    @ApiMember(Description="The time for the schedule opening hours (starttime)", IsRequired=true)
    var StartTime:TimeSpan? = null

    /**
    * The time for the schedule opening hours (endtime)
    */
    @ApiMember(Description="The time for the schedule opening hours (endtime)", IsRequired=true)
    var EndTime:TimeSpan? = null

    /**
    * The number of days the schedule is valid from todays date
    */
    @ApiMember(Description="The number of days the schedule is valid from todays date", IsRequired=true)
    var NumberOfScheduleDays:Int? = null

    /**
    * If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.
    */
    @ApiMember(Description="If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.", IsRequired=true)
    var IsResourceSpecific:Boolean? = null

    /**
    * The timestamp when the schedule was updated
    */
    @ApiMember(Description="The timestamp when the schedule was updated", IsRequired=true)
    var UpdatedDate:Date? = null

    /**
    * The timestamp when the schedule was created
    */
    @ApiMember(Description="The timestamp when the schedule was created", IsRequired=true)
    var CreatedDate:Date? = null

    /**
    * Allow bookings end time exceeds the opening hours Here you can choose whether it should be possible to make a reservation exceeding the opening hours. This should be ticked when a service duration is longer than 24 hours (possible to book over midnight).
    */
    @ApiMember(Description="Allow bookings end time exceeds the opening hours Here you can choose whether it should be possible to make a reservation exceeding the opening hours. This should be ticked when a service duration is longer than 24 hours (possible to book over midnight).", IsRequired=true)
    var EnableBookingUntilClosingTime:Boolean? = 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 resources that is connected to the schedule
    */
    @ApiMember(Description="The resources that is connected to the schedule")
    var Resources:ArrayList<ScheduleResources> = ArrayList<ScheduleResources>()

    /**
    * The services that is connected to the schedule
    */
    @ApiMember(Description="The services that is connected to the schedule")
    var Services:ArrayList<ScheduleServices> = ArrayList<ScheduleServices>()

    /**
    * The exceptions that is added to the schedule
    */
    @ApiMember(Description="The exceptions that is added to the schedule")
    var Exceptions:ArrayList<RecurringScheduleExceptionResponse> = ArrayList<RecurringScheduleExceptionResponse>()

    /**
    * Schedule dates, used when the schedule is not a rolling schedule using days of week
    */
    @ApiMember(Description="Schedule dates, used when the schedule is not a rolling schedule using days of week")
    var ScheduleDates:ArrayList<RecurringScheduleDateResponse> = ArrayList<RecurringScheduleDateResponse>()

    var ResponseStatus:ResponseStatus? = null
}

open class DayOfWeekDto
{
    var DayOfWeekId:Int? = null
    var DotNetDayOfWeekId:Int? = null
    var DayOfWeek:String? = null
}

open class ScheduleResources
{
    var Id:Int? = null
    /**
    * Name of the resource
    */
    @ApiMember(Description="Name of the resource")
    var Name:String? = null

    /**
    * The image url of the resource
    */
    @ApiMember(Description="The image url of the resource")
    var ImageUrl:Uri? = null
}

open class ScheduleServices
{
    var Id:Int? = null
    /**
    * Name of the service
    */
    @ApiMember(Description="Name of the service")
    var Name:String? = null

    /**
    * The image url of the service
    */
    @ApiMember(Description="The image url of the service")
    var ImageUrl:Uri? = null
}

open class RecurringScheduleExceptionResponse
{
    /**
    * Start time of the schedule exception.
    */
    @ApiMember(Description="Start time of the schedule exception.")
    var StartTime:TimeSpan? = null

    /**
    * End time of the schedule exception.
    */
    @ApiMember(Description="End time of the schedule exception.")
    var EndTime:TimeSpan? = null
}

open class RecurringScheduleDateResponse
{
    var Id:Int? = null
    var Date:Date? = null
    var StartTime:TimeSpan? = null
    var EndTime:TimeSpan? = null
    var ResponseStatus:ResponseStatus? = null
}

Kotlin DeleteRecurringSchedule DTOs

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

HTTP + CSV

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

DELETE /schedules/recurring/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"Name":"String","Description":"String","Active":false,"TimeInterval":0,"StartTime":"00:00:00","EndTime":"00:00:00","NumberOfScheduleDays":0,"IsResourceSpecific":false,"EnableBookingUntilClosingTime":false,"DaysOfWeek":[{"DayOfWeekId":0,"DotNetDayOfWeekId":0,"DayOfWeek":"String"}],"Resources":[{"Id":0,"Name":"String"}],"Services":[{"Id":0,"Name":"String"}],"Exceptions":[{"StartTime":"00:00:00","EndTime":"00:00:00"}],"ScheduleDates":[{"Id":0,"StartTime":"00:00:00","EndTime":"00:00:00","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}