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 java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class CreateRecurringSchedule : ICompany
{
    /**
    * 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.")
    var CompanyId:UUID? = null

    /**
    * The schedule name
    */
    @ApiMember(Description="The schedule name")
    var Name:String? = null

    /**
    * The schedule description
    */
    @ApiMember(Description="The schedule description")
    var Description:String? = null

    /**
    * If schedule is active or not
    */
    @ApiMember(Description="If schedule is active or not")
    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)
    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)
    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)
    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)
    var ValidTo:Date? = null

    /**
    * The time for the schedule opening hours (starttime)
    */
    @ApiMember(Description="The time for the schedule opening hours (starttime)", IsRequired=true)
    var StartTime:TimeSpan? = null

    /**
    * The time for the schedule opening hours (endtime)
    */
    @ApiMember(Description="The time for the schedule opening hours (endtime)", IsRequired=true)
    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)
    var NumberOfScheduleDays:Int? = null

    /**
    * 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 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")
    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.")
    var ScheduleDates:ArrayList<AddRecurringScheduleDate> = ArrayList<AddRecurringScheduleDate>()

    /**
    * 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.")
    var Exceptions:ArrayList<ScheduleException> = ArrayList<ScheduleException>()

    /**
    * 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.")
    var Resources:ArrayList<AddScheduleResource> = ArrayList<AddScheduleResource>()

    /**
    * Set what services the schedule should be connected to.
    */
    @ApiMember(Description="Set what services the schedule should be connected to.")
    var Services:ArrayList<AddScheduleService> = ArrayList<AddScheduleService>()
}

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)
    var Date:Date? = null

    /**
    * The time for the schedule opening hours (starttime)
    */
    @ApiMember(Description="The time for the schedule opening hours (starttime)", IsRequired=true)
    var StartTime:TimeSpan? = null

    /**
    * The time for the schedule opening hours (endtime)
    */
    @ApiMember(Description="The time for the schedule opening hours (endtime)", IsRequired=true)
    var EndTime:TimeSpan? = null
}

open class ScheduleException
{
    var StartTime:TimeSpan? = null
    var EndTime:TimeSpan? = null
}

open class AddScheduleResource
{
    /**
    * The resource id
    */
    @ApiMember(Description="The resource id", IsRequired=true)
    var Id:Int? = null
}

open class AddScheduleService
{
    /**
    * The service id
    */
    @ApiMember(Description="The service id", IsRequired=true)
    var Id:Int? = null
}

open class RecurringScheduleQueryResponse
{
    /**
    * The schedule id
    */
    @ApiMember(Description="The schedule id")
    var Id:Int? = null

    /**
    * Name of the schedule
    */
    @ApiMember(Description="Name of the schedule")
    var Name:String? = null

    /**
    * Description of the schedule
    */
    @ApiMember(Description="Description of the schedule")
    var Description:String? = null

    /**
    * If the schedule is active or not
    */
    @ApiMember(Description="If the schedule is active or not")
    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)
    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)
    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)
    var ValidTo:Date? = null

    /**
    * The time for the schedule opening hours (starttime)
    */
    @ApiMember(Description="The time for the schedule opening hours (starttime)", IsRequired=true)
    var StartTime:TimeSpan? = null

    /**
    * The time for the schedule opening hours (endtime)
    */
    @ApiMember(Description="The time for the schedule opening hours (endtime)", IsRequired=true)
    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)
    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)
    var IsResourceSpecific:Boolean? = null

    /**
    * The timestamp when the schedule was updated
    */
    @ApiMember(Description="The timestamp when the schedule was updated", IsRequired=true)
    var UpdatedDate:Date? = null

    /**
    * The timestamp when the schedule was created
    */
    @ApiMember(Description="The timestamp when the schedule was created", IsRequired=true)
    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)
    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")
    var DaysOfWeek:ArrayList<DayOfWeekDto> = ArrayList<DayOfWeekDto>()

    /**
    * The resources that is connected to the schedule
    */
    @ApiMember(Description="The resources that is connected to the schedule")
    var Resources:ArrayList<ScheduleResources> = ArrayList<ScheduleResources>()

    /**
    * The services that is connected to the schedule
    */
    @ApiMember(Description="The services that is connected to the schedule")
    var Services:ArrayList<ScheduleServices> = ArrayList<ScheduleServices>()

    /**
    * The exceptions that is added to the schedule
    */
    @ApiMember(Description="The exceptions that is added to the schedule")
    var Exceptions:ArrayList<RecurringScheduleExceptionResponse> = ArrayList<RecurringScheduleExceptionResponse>()

    /**
    * 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")
    var ScheduleDates:ArrayList<RecurringScheduleDateResponse> = ArrayList<RecurringScheduleDateResponse>()

    var ResponseStatus:ResponseStatus? = null
}

open class DayOfWeekDto
{
    var DayOfWeekId:Int? = null
    var DotNetDayOfWeekId:Int? = null
    var DayOfWeek:String? = null
}

open class ScheduleResources
{
    var Id:Int? = null
    /**
    * Name of the resource
    */
    @ApiMember(Description="Name of the resource")
    var Name:String? = null

    /**
    * The image url of the resource
    */
    @ApiMember(Description="The image url of the resource")
    var ImageUrl:Uri? = null
}

open class ScheduleServices
{
    var Id:Int? = null
    /**
    * Name of the service
    */
    @ApiMember(Description="Name of the service")
    var Name:String? = null

    /**
    * The image url of the service
    */
    @ApiMember(Description="The image url of the service")
    var ImageUrl:Uri? = null
}

open class RecurringScheduleExceptionResponse
{
    /**
    * Start time of the schedule exception.
    */
    @ApiMember(Description="Start time of the schedule exception.")
    var StartTime:TimeSpan? = null

    /**
    * End time of the schedule exception.
    */
    @ApiMember(Description="End time of the schedule exception.")
    var EndTime:TimeSpan? = null
}

open class RecurringScheduleDateResponse
{
    var Id:Int? = null
    var Date:Date? = null
    var StartTime:TimeSpan? = null
    var EndTime:TimeSpan? = null
    var ResponseStatus:ResponseStatus? = null
}

Kotlin 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>