BokaMera.API.Host

CreateRecurringSchedule

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
POST	/schedules/recurring	Add new recurring schedule	Add new recurring schedule to the company for the currently logged in user, only administrators are allowed to add schedules.

**CreateRecurringSchedule** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	body	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
Name	body	string	Yes	The schedule name
Description	body	string	Yes	The schedule description
Active	body	bool	No	If schedule is active or not
TimeInterval	body	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
EnableBookingUntilClosingTime	body	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).
ValidFrom	body	DateTime	Yes	The timestamp to which the schedule is valid from
ValidTo	body	DateTime	Yes	The timestamp to which the schedule is valid to
StartTime	body	TimeSpan	Yes	The time for the schedule opening hours (starttime)
EndTime	body	TimeSpan	Yes	The time for the schedule opening hours (endtime)
NumberOfScheduleDays	body	int	Yes	The number of days the schedule is valid from todays date
DaysOfWeek	body	int[]	Yes	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
ScheduleDates	body	List<AddRecurringScheduleDate>	Yes	If not recuring, an array indicating which dates that are open for the schedule.
Exceptions	body	List<ScheduleException>	Yes	Schedule exceptions. For example closed on lunch time between 12AM and 1PM. These times will be removed from the recurring schedule.
Resources	body	List<AddScheduleResource>	Yes	If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.
Services	body	List<AddScheduleService>	Yes	Set what services the schedule should be connected to.

**AddRecurringScheduleDate** Parameters:
Name	Parameter	Data Type	Required	Description
Date	form	DateTime	Yes	The date for the schedule opening (only date part is used here
StartTime	form	TimeSpan	Yes	The time for the schedule opening hours (starttime)
EndTime	form	TimeSpan	Yes	The time for the schedule opening hours (endtime)

**ScheduleException** Parameters:
Name	Parameter	Data Type	Required	Description
StartTime	form	TimeSpan	No
EndTime	form	TimeSpan	No

**AddScheduleResource** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	Yes	The resource id

**AddScheduleService** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	Yes	The service id

**RecurringScheduleQueryResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No	The schedule id
Name	form	string	Yes	Name of the schedule
Description	form	string	Yes	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-10AM 09:15AM-10:15AM, 09:30AM-10:30AM , ..... 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>	Yes	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>	Yes	The resources that is connected to the schedule
Services	form	List<ScheduleServices>	Yes	The services that is connected to the schedule
Exceptions	form	List<RecurringScheduleExceptionResponse>	Yes	The exceptions that is added to the schedule
ScheduleDates	form	List<RecurringScheduleDateResponse>	Yes	Schedule dates, used when the schedule is not a rolling schedule using days of week
ResponseStatus	form	ResponseStatus	Yes

**DayOfWeekDto** Parameters:
Name	Parameter	Data Type	Required
DayOfWeekId	form	int	No
DotNetDayOfWeekId	form	int	No
DayOfWeek	form	string	Yes

**ScheduleResources** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Name	form	string	Yes	Name of the resource
ImageUrl	form	Uri	Yes	The image url of the resource

**ScheduleServices** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Name	form	string	Yes	Name of the service
ImageUrl	form	Uri	Yes	The image url of the service

**RecurringScheduleExceptionResponse** Parameters:
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.

**RecurringScheduleDateResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Date	form	DateTime	No
StartTime	form	TimeSpan	No
EndTime	form	TimeSpan	No
ResponseStatus	form	ResponseStatus	Yes

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.

POST /schedules/recurring HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Name: String,
	Description: String,
	Active: False,
	TimeInterval: 0,
	EnableBookingUntilClosingTime: False,
	StartTime: PT0S,
	EndTime: PT0S,
	NumberOfScheduleDays: 0,
	DaysOfWeek: 
	[
		0
	],
	ScheduleDates: 
	[
		{
			StartTime: PT0S,
			EndTime: PT0S
		}
	],
	Exceptions: 
	[
		{
			StartTime: PT0S,
			EndTime: PT0S
		}
	],
	Resources: 
	[
		{
			Id: 0
		}
	],
	Services: 
	[
		{
			Id: 0
		}
	]
}

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