BokaMera.API.Host

<back to all web services

UpdateRecurringSchedule

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/schedules/recurring/{Id}Update recurring scheduleUpdate recurring schedule to the company for the currently logged in user, only administrators are allowed to update schedules.
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class AddRecurringScheduleDate
    {
        ///<summary>
        ///The date for the schedule opening (only date part is used here
        ///</summary>
        [ApiMember(Description="The date for the schedule opening (only date part is used here", IsRequired=true)]
        public virtual DateTime Date { get; set; }

        ///<summary>
        ///The time for the schedule opening hours (starttime)
        ///</summary>
        [ApiMember(Description="The time for the schedule opening hours (starttime)", IsRequired=true)]
        public virtual TimeSpan StartTime { get; set; }

        ///<summary>
        ///The time for the schedule opening hours (endtime)
        ///</summary>
        [ApiMember(Description="The time for the schedule opening hours (endtime)", IsRequired=true)]
        public virtual TimeSpan EndTime { get; set; }
    }

    public partial class AddScheduleResource
    {
        ///<summary>
        ///The resource id
        ///</summary>
        [ApiMember(Description="The resource id", IsRequired=true)]
        public virtual int Id { get; set; }
    }

    public partial class AddScheduleService
    {
        ///<summary>
        ///The service id
        ///</summary>
        [ApiMember(Description="The service id", IsRequired=true)]
        public virtual int Id { get; set; }
    }

    public partial class DayOfWeekDto
    {
        public virtual int DayOfWeekId { get; set; }
        public virtual int DotNetDayOfWeekId { get; set; }
        public virtual string DayOfWeek { get; set; }
    }

    public partial class RecurringScheduleDateResponse
    {
        public virtual int Id { get; set; }
        public virtual DateTime Date { get; set; }
        public virtual TimeSpan StartTime { get; set; }
        public virtual TimeSpan EndTime { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class RecurringScheduleExceptionResponse
    {
        ///<summary>
        ///Start time of the schedule exception.
        ///</summary>
        [ApiMember(Description="Start time of the schedule exception.")]
        public virtual TimeSpan StartTime { get; set; }

        ///<summary>
        ///End time of the schedule exception.
        ///</summary>
        [ApiMember(Description="End time of the schedule exception.")]
        public virtual TimeSpan EndTime { get; set; }
    }

    public partial class RecurringScheduleQueryResponse
    {
        public RecurringScheduleQueryResponse()
        {
            DaysOfWeek = new List<DayOfWeekDto>{};
            Resources = new List<ScheduleResources>{};
            Services = new List<ScheduleServices>{};
            Exceptions = new List<RecurringScheduleExceptionResponse>{};
            ScheduleDates = new List<RecurringScheduleDateResponse>{};
        }

        ///<summary>
        ///The schedule id
        ///</summary>
        [ApiMember(Description="The schedule id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///Name of the schedule
        ///</summary>
        [ApiMember(Description="Name of the schedule")]
        public virtual string Name { get; set; }

        ///<summary>
        ///Description of the schedule
        ///</summary>
        [ApiMember(Description="Description of the schedule")]
        public virtual string Description { get; set; }

        ///<summary>
        ///If the schedule is active or not
        ///</summary>
        [ApiMember(Description="If the schedule is active or not")]
        public virtual bool Active { get; set; }

        ///<summary>
        ///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
        ///</summary>
        [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)]
        public virtual int TimeInterval { get; set; }

        ///<summary>
        ///The timestamp to which the schedule is valid from
        ///</summary>
        [ApiMember(Description="The timestamp to which the schedule is valid from", IsRequired=true)]
        public virtual DateTime ValidFrom { get; set; }

        ///<summary>
        ///The timestamp to which the schedule is valid to
        ///</summary>
        [ApiMember(Description="The timestamp to which the schedule is valid to", IsRequired=true)]
        public virtual DateTime ValidTo { get; set; }

        ///<summary>
        ///The time for the schedule opening hours (starttime)
        ///</summary>
        [ApiMember(Description="The time for the schedule opening hours (starttime)", IsRequired=true)]
        public virtual TimeSpan StartTime { get; set; }

        ///<summary>
        ///The time for the schedule opening hours (endtime)
        ///</summary>
        [ApiMember(Description="The time for the schedule opening hours (endtime)", IsRequired=true)]
        public virtual TimeSpan EndTime { get; set; }

        ///<summary>
        ///The number of days the schedule is valid from todays date
        ///</summary>
        [ApiMember(Description="The number of days the schedule is valid from todays date", IsRequired=true)]
        public virtual int NumberOfScheduleDays { get; set; }

        ///<summary>
        ///If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.
        ///</summary>
        [ApiMember(Description="If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this.", IsRequired=true)]
        public virtual bool? IsResourceSpecific { get; set; }

        ///<summary>
        ///The timestamp when the schedule was updated
        ///</summary>
        [ApiMember(Description="The timestamp when the schedule was updated", IsRequired=true)]
        public virtual DateTime UpdatedDate { get; set; }

        ///<summary>
        ///The timestamp when the schedule was created
        ///</summary>
        [ApiMember(Description="The timestamp when the schedule was created", IsRequired=true)]
        public virtual DateTime CreatedDate { get; set; }

        ///<summary>
        ///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).
        ///</summary>
        [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)]
        public virtual bool EnableBookingUntilClosingTime { get; set; }

        ///<summary>
        ///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
        ///</summary>
        [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")]
        public virtual List<DayOfWeekDto> DaysOfWeek { get; set; }

        ///<summary>
        ///The resources that is connected to the schedule
        ///</summary>
        [ApiMember(Description="The resources that is connected to the schedule")]
        public virtual List<ScheduleResources> Resources { get; set; }

        ///<summary>
        ///The services that is connected to the schedule
        ///</summary>
        [ApiMember(Description="The services that is connected to the schedule")]
        public virtual List<ScheduleServices> Services { get; set; }

        ///<summary>
        ///The exceptions that is added to the schedule
        ///</summary>
        [ApiMember(Description="The exceptions that is added to the schedule")]
        public virtual List<RecurringScheduleExceptionResponse> Exceptions { get; set; }

        ///<summary>
        ///Schedule dates, used when the schedule is not a rolling schedule using days of week
        ///</summary>
        [ApiMember(Description="Schedule dates, used when the schedule is not a rolling schedule using days of week")]
        public virtual List<RecurringScheduleDateResponse> ScheduleDates { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class ScheduleException
    {
        public virtual TimeSpan StartTime { get; set; }
        public virtual TimeSpan EndTime { get; set; }
    }

    public partial class ScheduleResources
    {
        public virtual int Id { get; set; }
        ///<summary>
        ///Name of the resource
        ///</summary>
        [ApiMember(Description="Name of the resource")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The image url of the resource
        ///</summary>
        [ApiMember(Description="The image url of the resource")]
        public virtual Uri ImageUrl { get; set; }
    }

    public partial class ScheduleServices
    {
        public virtual int Id { get; set; }
        ///<summary>
        ///Name of the service
        ///</summary>
        [ApiMember(Description="Name of the service")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The image url of the service
        ///</summary>
        [ApiMember(Description="The image url of the service")]
        public virtual Uri ImageUrl { get; set; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class UpdateRecurringSchedule
        : ICompany
    {
        public UpdateRecurringSchedule()
        {
            DaysOfWeek = new int[]{};
            ScheduleDates = new List<AddRecurringScheduleDate>{};
            Exceptions = new List<ScheduleException>{};
            Resources = new List<AddScheduleResource>{};
            Services = new List<AddScheduleService>{};
        }

        ///<summary>
        ///Id of the schedule to update
        ///</summary>
        [ApiMember(Description="Id of the schedule to update", IsRequired=true, ParameterType="path")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The schedule name
        ///</summary>
        [ApiMember(Description="The schedule name")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The schedule description
        ///</summary>
        [ApiMember(Description="The schedule description")]
        public virtual string Description { get; set; }

        ///<summary>
        ///If schedule is active or not
        ///</summary>
        [ApiMember(Description="If schedule is active or not")]
        public virtual bool? Active { get; set; }

        ///<summary>
        ///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
        ///</summary>
        [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)]
        public virtual int? TimeInterval { get; set; }

        ///<summary>
        ///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).
        ///</summary>
        [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)]
        public virtual bool? EnableBookingUntilClosingTime { get; set; }

        ///<summary>
        ///The timestamp to which the schedule is valid from
        ///</summary>
        [ApiMember(Description="The timestamp to which the schedule is valid from", IsRequired=true)]
        public virtual DateTime? ValidFrom { get; set; }

        ///<summary>
        ///The timestamp to which the schedule is valid to
        ///</summary>
        [ApiMember(Description="The timestamp to which the schedule is valid to", IsRequired=true)]
        public virtual DateTime? ValidTo { get; set; }

        ///<summary>
        ///The time for the schedule opening hours (starttime)
        ///</summary>
        [ApiMember(Description="The time for the schedule opening hours (starttime)", IsRequired=true)]
        public virtual TimeSpan? StartTime { get; set; }

        ///<summary>
        ///The time for the schedule opening hours (endtime)
        ///</summary>
        [ApiMember(Description="The time for the schedule opening hours (endtime)", IsRequired=true)]
        public virtual TimeSpan? EndTime { get; set; }

        ///<summary>
        ///The number of days the schedule is valid from todays date
        ///</summary>
        [ApiMember(Description="The number of days the schedule is valid from todays date", IsRequired=true)]
        public virtual int? NumberOfScheduleDays { get; set; }

        ///<summary>
        ///A comma separated list of which days this day exception belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
        ///</summary>
        [ApiMember(Description="A comma separated list of which days this day exception belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.")]
        public virtual int[] DaysOfWeek { get; set; }

        ///<summary>
        ///If not recuring, an array indicating which dates that are open for the schedule.
        ///</summary>
        [ApiMember(Description="If not recuring, an array indicating which dates that are open for the schedule.")]
        public virtual List<AddRecurringScheduleDate> ScheduleDates { get; set; }

        ///<summary>
        ///Schedule exceptions. For example closed on lunch time between 12AM and 1PM. These times will be removed from the recurring schedule.
        ///</summary>
        [ApiMember(Description="Schedule exceptions. For example closed on lunch time between 12AM and 1PM. These times will be removed from the recurring schedule.")]
        public virtual List<ScheduleException> Exceptions { get; set; }

        ///<summary>
        ///If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.
        ///</summary>
        [ApiMember(Description="If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources.")]
        public virtual List<AddScheduleResource> Resources { get; set; }

        ///<summary>
        ///Set what services the schedule should be connected to.
        ///</summary>
        [ApiMember(Description="Set what services the schedule should be connected to.")]
        public virtual List<AddScheduleService> Services { get; set; }
    }

}

C# UpdateRecurringSchedule 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.

PUT /schedules/recurring/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Name: String,
	Description: String,
	Active: False,
	TimeInterval: 0,
	EnableBookingUntilClosingTime: False,
	ValidFrom: "0001-01-01T00:00:00",
	ValidTo: "0001-01-01T00:00:00",
	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
		}
	}
}