| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| DELETE | /schedules/recurring/{Id} | Remove a recurring schedule | Remove recurring schedule. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | query | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
| Id | path | int | Yes | The schedule id |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | The schedule id |
| Name | form | string | No | Name of the schedule |
| Description | form | string | No | Description of the schedule |
| Active | form | bool | No | If the schedule is active or not |
| TimeInterval | form | int | Yes | 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 |
| ValidFrom | form | DateTime | Yes | The timestamp to which the schedule is valid from |
| ValidTo | form | DateTime | Yes | The timestamp to which the schedule is valid to |
| StartTime | form | TimeSpan | Yes | The time for the schedule opening hours (starttime) |
| EndTime | form | TimeSpan | Yes | The time for the schedule opening hours (endtime) |
| NumberOfScheduleDays | form | int | Yes | The number of days the schedule is valid from todays date |
| IsResourceSpecific | form | bool? | Yes | If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this. |
| UpdatedDate | form | DateTime | Yes | The timestamp when the schedule was updated |
| CreatedDate | form | DateTime | Yes | The timestamp when the schedule was created |
| EnableBookingUntilClosingTime | form | bool | Yes | 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). |
| DaysOfWeek | form | List<DayOfWeekDto> | No | 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 |
| Resources | form | List<ScheduleResources> | No | The resources that is connected to the schedule |
| Services | form | List<ScheduleServices> | No | The services that is connected to the schedule |
| Exceptions | form | List<RecurringScheduleExceptionResponse> | No | The exceptions that is added to the schedule |
| ScheduleDates | form | List<RecurringScheduleDateResponse> | No | Schedule dates, used when the schedule is not a rolling schedule using days of week |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DayOfWeekId | form | int | No | |
| DotNetDayOfWeekId | form | int | No | |
| DayOfWeek | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Name | form | string | No | Name of the resource |
| ImageUrl | form | Uri | No | The image url of the resource |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Name | form | string | No | Name of the service |
| ImageUrl | form | Uri | No | The image url of the service |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StartTime | form | TimeSpan | No | Start time of the schedule exception. |
| EndTime | form | TimeSpan | No | End time of the schedule exception. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Date | form | DateTime | No | |
| StartTime | form | TimeSpan | No | |
| EndTime | form | TimeSpan | No | |
| ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}