| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /schedules/recurring/{Id} | Update recurring schedule | Update recurring schedule to the company for the currently logged in user, only administrators are allowed to update schedules. |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class UpdateRecurringSchedule : ICompany
{
/**
* Id of the schedule to update
*/
@ApiMember(Description="Id of the schedule to update", IsRequired=true, ParameterType="path")
open var Id:Int? = null
/**
* 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.")
override var CompanyId:UUID? = null
/**
* The schedule name
*/
@ApiMember(Description="The schedule name")
open var Name:String? = null
/**
* The schedule description
*/
@ApiMember(Description="The schedule description")
open var Description:String? = null
/**
* If schedule is active or not
*/
@ApiMember(Description="If schedule is active or not")
open 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)
open var TimeInterval:Int? = 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)
open var EnableBookingUntilClosingTime:Boolean? = null
/**
* The timestamp to which the schedule is valid from
*/
@ApiMember(Description="The timestamp to which the schedule is valid from", IsRequired=true)
open 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)
open var ValidTo:Date? = null
/**
* The time for the schedule opening hours (starttime)
*/
@ApiMember(Description="The time for the schedule opening hours (starttime)", IsRequired=true)
open var StartTime:TimeSpan? = null
/**
* The time for the schedule opening hours (endtime)
*/
@ApiMember(Description="The time for the schedule opening hours (endtime)", IsRequired=true)
open 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)
open var NumberOfScheduleDays:Int? = null
/**
* A comma separated list of which days this day exception belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
*/
@ApiMember(Description="A comma separated list of which days this day exception belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.")
open var DaysOfWeek:ArrayList<Int>? = null
/**
* If not recuring, an array indicating which dates that are open for the schedule.
*/
@ApiMember(Description="If not recuring, an array indicating which dates that are open for the schedule.")
open var ScheduleDates:ArrayList<AddRecurringScheduleDate>? = null
/**
* Schedule exceptions. For example closed on lunch time between 12AM and 1PM. These times will be removed from the recurring schedule.
*/
@ApiMember(Description="Schedule exceptions. For example closed on lunch time between 12AM and 1PM. These times will be removed from the recurring schedule.")
open var Exceptions:ArrayList<ScheduleException>? = null
/**
* If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.
*/
@ApiMember(Description="If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.")
open var Resources:ArrayList<AddScheduleResource>? = null
/**
* Set what services the schedule should be connected to.
*/
@ApiMember(Description="Set what services the schedule should be connected to.")
open var Services:ArrayList<AddScheduleService>? = null
}
open class AddRecurringScheduleDate
{
/**
* The date for the schedule opening (only date part is used here
*/
@ApiMember(Description="The date for the schedule opening (only date part is used here", IsRequired=true)
open var Date:Date? = null
/**
* The time for the schedule opening hours (starttime)
*/
@ApiMember(Description="The time for the schedule opening hours (starttime)", IsRequired=true)
open var StartTime:TimeSpan? = null
/**
* The time for the schedule opening hours (endtime)
*/
@ApiMember(Description="The time for the schedule opening hours (endtime)", IsRequired=true)
open var EndTime:TimeSpan? = null
}
open class ScheduleException
{
open var StartTime:TimeSpan? = null
open var EndTime:TimeSpan? = null
}
open class AddScheduleResource
{
/**
* The resource id
*/
@ApiMember(Description="The resource id", IsRequired=true)
open var Id:Int? = null
}
open class AddScheduleService
{
/**
* The service id
*/
@ApiMember(Description="The service id", IsRequired=true)
open var Id:Int? = null
}
open class RecurringScheduleQueryResponse
{
/**
* The schedule id
*/
@ApiMember(Description="The schedule id")
open var Id:Int? = null
/**
* Name of the schedule
*/
@ApiMember(Description="Name of the schedule")
open var Name:String? = null
/**
* Description of the schedule
*/
@ApiMember(Description="Description of the schedule")
open var Description:String? = null
/**
* If the schedule is active or not
*/
@ApiMember(Description="If the schedule is active or not")
open 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-10AM 09:15AM-10:15AM, 09:30AM-10:30AM , ..... 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-10AM 09:15AM-10:15AM, 09:30AM-10:30AM , ..... 04:45PM-05:45, 05:00PM-06:00PM", IsRequired=true)
open 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)
open 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)
open var ValidTo:Date? = null
/**
* The time for the schedule opening hours (starttime)
*/
@ApiMember(Description="The time for the schedule opening hours (starttime)", IsRequired=true)
open var StartTime:TimeSpan? = null
/**
* The time for the schedule opening hours (endtime)
*/
@ApiMember(Description="The time for the schedule opening hours (endtime)", IsRequired=true)
open 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)
open 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)
open var IsResourceSpecific:Boolean? = null
/**
* The timestamp when the schedule was updated
*/
@ApiMember(Description="The timestamp when the schedule was updated", IsRequired=true)
open var UpdatedDate:Date? = null
/**
* The timestamp when the schedule was created
*/
@ApiMember(Description="The timestamp when the schedule was created", IsRequired=true)
open 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)
open 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")
open var DaysOfWeek:ArrayList<DayOfWeekDto>? = null
/**
* The resources that is connected to the schedule
*/
@ApiMember(Description="The resources that is connected to the schedule")
open var Resources:ArrayList<ScheduleResources>? = null
/**
* The services that is connected to the schedule
*/
@ApiMember(Description="The services that is connected to the schedule")
open var Services:ArrayList<ScheduleServices>? = null
/**
* The exceptions that is added to the schedule
*/
@ApiMember(Description="The exceptions that is added to the schedule")
open var Exceptions:ArrayList<RecurringScheduleExceptionResponse>? = null
/**
* 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")
open var ScheduleDates:ArrayList<RecurringScheduleDateResponse>? = null
open var ResponseStatus:ResponseStatus? = null
}
open class DayOfWeekDto
{
open var DayOfWeekId:Int? = null
open var DotNetDayOfWeekId:Int? = null
open var DayOfWeek:String? = null
}
open class ScheduleResources
{
open var Id:Int? = null
/**
* Name of the resource
*/
@ApiMember(Description="Name of the resource")
open var Name:String? = null
/**
* The image url of the resource
*/
@ApiMember(Description="The image url of the resource")
open var ImageUrl:Uri? = null
}
open class ScheduleServices
{
open var Id:Int? = null
/**
* Name of the service
*/
@ApiMember(Description="Name of the service")
open var Name:String? = null
/**
* The image url of the service
*/
@ApiMember(Description="The image url of the service")
open var ImageUrl:Uri? = null
}
open class RecurringScheduleExceptionResponse
{
/**
* Start time of the schedule exception.
*/
@ApiMember(Description="Start time of the schedule exception.")
open var StartTime:TimeSpan? = null
/**
* End time of the schedule exception.
*/
@ApiMember(Description="End time of the schedule exception.")
open var EndTime:TimeSpan? = null
}
open class RecurringScheduleDateResponse
{
open var Id:Int? = null
open var Date:Date? = null
open var StartTime:TimeSpan? = null
open var EndTime:TimeSpan? = null
open var ResponseStatus:ResponseStatus? = null
}
Kotlin UpdateRecurringSchedule 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.
PUT /schedules/recurring/{Id} HTTP/1.1
Host: api.bookmore.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
CompanyId: 00000000-0000-0000-0000-000000000000,
Name: String,
Description: String,
Active: False,
TimeInterval: 0,
EnableBookingUntilClosingTime: False,
ValidFrom: "0001-01-01T00:00:00",
ValidTo: "0001-01-01T00:00:00",
StartTime: PT0S,
EndTime: PT0S,
NumberOfScheduleDays: 0,
DaysOfWeek:
[
0
],
ScheduleDates:
[
{
StartTime: PT0S,
EndTime: PT0S
}
],
Exceptions:
[
{
StartTime: PT0S,
EndTime: PT0S
}
],
Resources:
[
{
Id: 0
}
],
Services:
[
{
Id: 0
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
Name: String,
Description: String,
Active: False,
TimeInterval: 0,
StartTime: PT0S,
EndTime: PT0S,
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: PT0S,
EndTime: PT0S
}
],
ScheduleDates:
[
{
Id: 0,
StartTime: PT0S,
EndTime: PT0S,
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
}
}
}