BokaMera.API.Host

<back to all web services

CreateRecurringSchedule

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/schedules/recurringAdd new recurring scheduleAdd new recurring schedule to the company for the currently logged in user, only administrators are allowed to add schedules.
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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddRecurringScheduleDate:
    # @ApiMember(Description="The date for the schedule opening (only date part is used here", IsRequired=true)
    date: datetime.datetime = datetime.datetime(1, 1, 1)
    """
    The date for the schedule opening (only date part is used here
    """


    # @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)
    """


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleException:
    start_time: datetime.timedelta = datetime.timedelta()
    end_time: datetime.timedelta = datetime.timedelta()


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


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


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateRecurringSchedule(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 name")
    name: Optional[str] = None
    """
    The schedule name
    """


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


    # @ApiMember(Description="If schedule is active or not")
    active: bool = False
    """
    If 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="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="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 recurring, an array indicating which days of the week the schedule 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[int]] = None
    """
    If recurring, an array indicating which days of the week the schedule 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 not recuring, an array indicating which dates that are open for the schedule.")
    schedule_dates: Optional[List[AddRecurringScheduleDate]] = None
    """
    If not recuring, an array indicating which dates that are open for the schedule.
    """


    # @ApiMember(Description="Schedule exceptions. For example closed on lunch time between 12AM and 1PM. These times will be removed from the recurring schedule.")
    exceptions: Optional[List[ScheduleException]] = None
    """
    Schedule exceptions. For example closed on lunch time between 12AM and 1PM. These times will be removed from the recurring schedule.
    """


    # @ApiMember(Description="If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.")
    resources: Optional[List[AddScheduleResource]] = None
    """
    If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.
    """


    # @ApiMember(Description="Set what services the schedule should be connected to.")
    services: Optional[List[AddScheduleService]] = None
    """
    Set what services the schedule should be connected to.
    """

Python CreateRecurringSchedule DTOs

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

HTTP + XML

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

POST /schedules/recurring HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateRecurringSchedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <DaysOfWeek xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </DaysOfWeek>
  <Description>String</Description>
  <EnableBookingUntilClosingTime>false</EnableBookingUntilClosingTime>
  <EndTime>PT0S</EndTime>
  <Exceptions>
    <ScheduleException>
      <EndTime>PT0S</EndTime>
      <StartTime>PT0S</StartTime>
    </ScheduleException>
  </Exceptions>
  <Name>String</Name>
  <NumberOfScheduleDays>0</NumberOfScheduleDays>
  <Resources>
    <AddScheduleResource>
      <Id>0</Id>
    </AddScheduleResource>
  </Resources>
  <ScheduleDates>
    <AddRecurringScheduleDate>
      <Date>0001-01-01T00:00:00</Date>
      <EndTime>PT0S</EndTime>
      <StartTime>PT0S</StartTime>
    </AddRecurringScheduleDate>
  </ScheduleDates>
  <Services>
    <AddScheduleService>
      <Id>0</Id>
    </AddScheduleService>
  </Services>
  <StartTime>PT0S</StartTime>
  <TimeInterval>0</TimeInterval>
  <ValidFrom>0001-01-01T00:00:00</ValidFrom>
  <ValidTo>0001-01-01T00:00:00</ValidTo>
</CreateRecurringSchedule>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RecurringScheduleQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <DaysOfWeek>
    <DayOfWeekDto>
      <DayOfWeek>String</DayOfWeek>
      <DayOfWeekId>0</DayOfWeekId>
      <DotNetDayOfWeekId>0</DotNetDayOfWeekId>
    </DayOfWeekDto>
  </DaysOfWeek>
  <Description>String</Description>
  <EnableBookingUntilClosingTime>false</EnableBookingUntilClosingTime>
  <EndTime>PT0S</EndTime>
  <Exceptions>
    <RecurringScheduleExceptionResponse>
      <EndTime>PT0S</EndTime>
      <StartTime>PT0S</StartTime>
    </RecurringScheduleExceptionResponse>
  </Exceptions>
  <Id>0</Id>
  <IsResourceSpecific>false</IsResourceSpecific>
  <Name>String</Name>
  <NumberOfScheduleDays>0</NumberOfScheduleDays>
  <Resources>
    <ScheduleResources>
      <Id>0</Id>
      <ImageUrl i:nil="true" />
      <Name>String</Name>
    </ScheduleResources>
  </Resources>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <ScheduleDates>
    <RecurringScheduleDateResponse>
      <Date>0001-01-01T00:00:00</Date>
      <EndTime>PT0S</EndTime>
      <Id>0</Id>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <StartTime>PT0S</StartTime>
    </RecurringScheduleDateResponse>
  </ScheduleDates>
  <Services>
    <ScheduleServices>
      <Id>0</Id>
      <ImageUrl i:nil="true" />
      <Name>String</Name>
    </ScheduleServices>
  </Services>
  <StartTime>PT0S</StartTime>
  <TimeInterval>0</TimeInterval>
  <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
  <ValidFrom>0001-01-01T00:00:00</ValidFrom>
  <ValidTo>0001-01-01T00:00:00</ValidTo>
</RecurringScheduleQueryResponse>