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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DayOfWeekDto:
    day_of_week_id: int = 0
    dot_net_day_of_week_id: int = 0
    day_of_week: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleResources:
    id: int = 0
    # @ApiMember(Description="Name of the resource")
    name: Optional[str] = None
    """
    Name of the resource
    """


    # @ApiMember(Description="The image url of the resource")
    image_url: Optional[str] = None
    """
    The image url of the resource
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleServices:
    id: int = 0
    # @ApiMember(Description="Name of the service")
    name: Optional[str] = None
    """
    Name of the service
    """


    # @ApiMember(Description="The image url of the service")
    image_url: Optional[str] = None
    """
    The image url of the service
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecurringScheduleExceptionResponse:
    # @ApiMember(Description="Start time of the schedule exception.")
    start_time: datetime.timedelta = datetime.timedelta()
    """
    Start time of the schedule exception.
    """


    # @ApiMember(Description="End time of the schedule exception.")
    end_time: datetime.timedelta = datetime.timedelta()
    """
    End time of the schedule exception.
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecurringScheduleDateResponse:
    id: int = 0
    date: datetime.datetime = datetime.datetime(1, 1, 1)
    start_time: datetime.timedelta = datetime.timedelta()
    end_time: datetime.timedelta = datetime.timedelta()
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RecurringScheduleQueryResponse:
    # @ApiMember(Description="The schedule id")
    id: int = 0
    """
    The schedule id
    """


    # @ApiMember(Description="Name of the schedule")
    name: Optional[str] = None
    """
    Name of the schedule
    """


    # @ApiMember(Description="Description of the schedule")
    description: Optional[str] = None
    """
    Description of the schedule
    """


    # @ApiMember(Description="If the schedule is active or not")
    active: bool = False
    """
    If the schedule is active or not
    """


    # @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)
    time_interval: int = 0
    """
    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="The timestamp to which the schedule is valid from", IsRequired=true)
    valid_from: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The timestamp to which the schedule is valid from
    """


    # @ApiMember(Description="The timestamp to which the schedule is valid to", IsRequired=true)
    valid_to: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The timestamp to which the schedule is valid to
    """


    # @ApiMember(Description="The time for the schedule opening hours (starttime)", IsRequired=true)
    start_time: datetime.timedelta = datetime.timedelta()
    """
    The time for the schedule opening hours (starttime)
    """


    # @ApiMember(Description="The time for the schedule opening hours (endtime)", IsRequired=true)
    end_time: datetime.timedelta = datetime.timedelta()
    """
    The time for the schedule opening hours (endtime)
    """


    # @ApiMember(Description="The number of days the schedule is valid from todays date", IsRequired=true)
    number_of_schedule_days: int = 0
    """
    The number of days the schedule is valid from todays date
    """


    # @ApiMember(Description="If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.", IsRequired=true)
    is_resource_specific: Optional[bool] = None
    """
    If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.
    """


    # @ApiMember(Description="The timestamp when the schedule was updated", IsRequired=true)
    updated_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The timestamp when the schedule was updated
    """


    # @ApiMember(Description="The timestamp when the schedule was created", IsRequired=true)
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The timestamp when the schedule was created
    """


    # @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)
    enable_booking_until_closing_time: bool = False
    """
    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="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")
    days_of_week: Optional[List[DayOfWeekDto]] = None
    """
    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="The resources that is connected to the schedule")
    resources: Optional[List[ScheduleResources]] = None
    """
    The resources that is connected to the schedule
    """


    # @ApiMember(Description="The services that is connected to the schedule")
    services: Optional[List[ScheduleServices]] = None
    """
    The services that is connected to the schedule
    """


    # @ApiMember(Description="The exceptions that is added to the schedule")
    exceptions: Optional[List[RecurringScheduleExceptionResponse]] = None
    """
    The exceptions that is added to the schedule
    """


    # @ApiMember(Description="Schedule dates, used when the schedule is not a rolling schedule using days of week")
    schedule_dates: Optional[List[RecurringScheduleDateResponse]] = None
    """
    Schedule dates, used when the schedule is not a rolling schedule using days of week
    """


    response_status: Optional[ResponseStatus] = None


# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DeleteRecurringSchedule(ICompany):
    # @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    company_id: Optional[str] = None
    """
    The company id, if empty will use the company id for the user you are logged in with.
    """


    # @ApiMember(Description="The schedule id", IsRequired=true, ParameterType="path")
    id: int = 0
    """
    The schedule id
    """

Python DeleteRecurringSchedule DTOs

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

HTTP + JSV

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/jsv
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
		}
	}
}