Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
DELETE | /schedules/recurring/{Id} | Remove a recurring schedule | Remove recurring schedule. |
---|
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos
Namespace Global
Namespace BokaMera.API.ServiceModel.Dtos
Public Partial Class DayOfWeekDto
Public Overridable Property DayOfWeekId As Integer
Public Overridable Property DotNetDayOfWeekId As Integer
Public Overridable Property DayOfWeek As String
End Class
<ValidateRequest(Validator:="IsAuthenticated")>
Public Partial Class DeleteRecurringSchedule
Implements ICompany
'''<Summary>
'''The company id, if empty will use the company id for the user you are logged in with.
'''</Summary>
<ApiMember(Description:="The company id, if empty will use the company id for the user you are logged in with.")>
Public Overridable Property CompanyId As Nullable(Of Guid)
'''<Summary>
'''The schedule id
'''</Summary>
<ApiMember(Description:="The schedule id", IsRequired:=true, ParameterType:="path")>
Public Overridable Property Id As Integer
End Class
Public Partial Class RecurringScheduleDateResponse
Public Overridable Property Id As Integer
Public Overridable Property [Date] As Date
Public Overridable Property StartTime As TimeSpan
Public Overridable Property EndTime As TimeSpan
Public Overridable Property ResponseStatus As ResponseStatus
End Class
Public Partial Class RecurringScheduleExceptionResponse
'''<Summary>
'''Start time of the schedule exception.
'''</Summary>
<ApiMember(Description:="Start time of the schedule exception.")>
Public Overridable Property StartTime As TimeSpan
'''<Summary>
'''End time of the schedule exception.
'''</Summary>
<ApiMember(Description:="End time of the schedule exception.")>
Public Overridable Property EndTime As TimeSpan
End Class
Public Partial Class RecurringScheduleQueryResponse
Public Sub New()
DaysOfWeek = New List(Of DayOfWeekDto)
Resources = New List(Of ScheduleResources)
Services = New List(Of ScheduleServices)
Exceptions = New List(Of RecurringScheduleExceptionResponse)
ScheduleDates = New List(Of RecurringScheduleDateResponse)
End Sub
'''<Summary>
'''The schedule id
'''</Summary>
<ApiMember(Description:="The schedule id")>
Public Overridable Property Id As Integer
'''<Summary>
'''Name of the schedule
'''</Summary>
<ApiMember(Description:="Name of the schedule")>
Public Overridable Property Name As String
'''<Summary>
'''Description of the schedule
'''</Summary>
<ApiMember(Description:="Description of the schedule")>
Public Overridable Property Description As String
'''<Summary>
'''If the schedule is active or not
'''</Summary>
<ApiMember(Description:="If the schedule is active or not")>
Public Overridable Property Active As Boolean
'''<Summary>
'''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
'''</Summary>
<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)>
Public Overridable Property TimeInterval As Integer
'''<Summary>
'''The timestamp to which the schedule is valid from
'''</Summary>
<ApiMember(Description:="The timestamp to which the schedule is valid from", IsRequired:=true)>
Public Overridable Property ValidFrom As Date
'''<Summary>
'''The timestamp to which the schedule is valid to
'''</Summary>
<ApiMember(Description:="The timestamp to which the schedule is valid to", IsRequired:=true)>
Public Overridable Property ValidTo As Date
'''<Summary>
'''The time for the schedule opening hours (starttime)
'''</Summary>
<ApiMember(Description:="The time for the schedule opening hours (starttime)", IsRequired:=true)>
Public Overridable Property StartTime As TimeSpan
'''<Summary>
'''The time for the schedule opening hours (endtime)
'''</Summary>
<ApiMember(Description:="The time for the schedule opening hours (endtime)", IsRequired:=true)>
Public Overridable Property EndTime As TimeSpan
'''<Summary>
'''The number of days the schedule is valid from todays date
'''</Summary>
<ApiMember(Description:="The number of days the schedule is valid from todays date", IsRequired:=true)>
Public Overridable Property NumberOfScheduleDays As Integer
'''<Summary>
'''If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.
'''</Summary>
<ApiMember(Description:="If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.", IsRequired:=true)>
Public Overridable Property IsResourceSpecific As Nullable(Of Boolean)
'''<Summary>
'''The timestamp when the schedule was updated
'''</Summary>
<ApiMember(Description:="The timestamp when the schedule was updated", IsRequired:=true)>
Public Overridable Property UpdatedDate As Date
'''<Summary>
'''The timestamp when the schedule was created
'''</Summary>
<ApiMember(Description:="The timestamp when the schedule was created", IsRequired:=true)>
Public Overridable Property CreatedDate As Date
'''<Summary>
'''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).
'''</Summary>
<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)>
Public Overridable Property EnableBookingUntilClosingTime As Boolean
'''<Summary>
'''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
'''</Summary>
<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 Overridable Property DaysOfWeek As List(Of DayOfWeekDto)
'''<Summary>
'''The resources that is connected to the schedule
'''</Summary>
<ApiMember(Description:="The resources that is connected to the schedule")>
Public Overridable Property Resources As List(Of ScheduleResources)
'''<Summary>
'''The services that is connected to the schedule
'''</Summary>
<ApiMember(Description:="The services that is connected to the schedule")>
Public Overridable Property Services As List(Of ScheduleServices)
'''<Summary>
'''The exceptions that is added to the schedule
'''</Summary>
<ApiMember(Description:="The exceptions that is added to the schedule")>
Public Overridable Property Exceptions As List(Of RecurringScheduleExceptionResponse)
'''<Summary>
'''Schedule dates, used when the schedule is not a rolling schedule using days of week
'''</Summary>
<ApiMember(Description:="Schedule dates, used when the schedule is not a rolling schedule using days of week")>
Public Overridable Property ScheduleDates As List(Of RecurringScheduleDateResponse)
Public Overridable Property ResponseStatus As ResponseStatus
End Class
Public Partial Class ScheduleResources
Public Overridable Property Id As Integer
'''<Summary>
'''Name of the resource
'''</Summary>
<ApiMember(Description:="Name of the resource")>
Public Overridable Property Name As String
'''<Summary>
'''The image url of the resource
'''</Summary>
<ApiMember(Description:="The image url of the resource")>
Public Overridable Property ImageUrl As Uri
End Class
Public Partial Class ScheduleServices
Public Overridable Property Id As Integer
'''<Summary>
'''Name of the service
'''</Summary>
<ApiMember(Description:="Name of the service")>
Public Overridable Property Name As String
'''<Summary>
'''The image url of the service
'''</Summary>
<ApiMember(Description:="The image url of the service")>
Public Overridable Property ImageUrl As Uri
End Class
End Namespace
End Namespace
VB.NET DeleteRecurringSchedule DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: testapi.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK Content-Type: text/jsonl 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"}}}