| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /schedules/recurring/{Id} | Update recurring schedule | Update recurring schedule to the company for the currently logged in user, only administrators are allowed to update schedules. |
|---|
export class DayOfWeekDto
{
public DayOfWeekId: number;
public DotNetDayOfWeekId: number;
public DayOfWeek: string;
public constructor(init?: Partial<DayOfWeekDto>) { (Object as any).assign(this, init); }
}
export class ScheduleResources
{
public Id: number;
/** @description Name of the resource */
// @ApiMember(Description="Name of the resource")
public Name: string;
/** @description The image url of the resource */
// @ApiMember(Description="The image url of the resource")
public ImageUrl: string;
public constructor(init?: Partial<ScheduleResources>) { (Object as any).assign(this, init); }
}
export class ScheduleServices
{
public Id: number;
/** @description Name of the service */
// @ApiMember(Description="Name of the service")
public Name: string;
/** @description The image url of the service */
// @ApiMember(Description="The image url of the service")
public ImageUrl: string;
public constructor(init?: Partial<ScheduleServices>) { (Object as any).assign(this, init); }
}
export class RecurringScheduleExceptionResponse
{
/** @description Start time of the schedule exception. */
// @ApiMember(Description="Start time of the schedule exception.")
public StartTime: string;
/** @description End time of the schedule exception. */
// @ApiMember(Description="End time of the schedule exception.")
public EndTime: string;
public constructor(init?: Partial<RecurringScheduleExceptionResponse>) { (Object as any).assign(this, init); }
}
export class RecurringScheduleDateResponse
{
public Id: number;
public Date: string;
public StartTime: string;
public EndTime: string;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<RecurringScheduleDateResponse>) { (Object as any).assign(this, init); }
}
export class RecurringScheduleQueryResponse
{
/** @description The schedule id */
// @ApiMember(Description="The schedule id")
public Id: number;
/** @description Name of the schedule */
// @ApiMember(Description="Name of the schedule")
public Name: string;
/** @description Description of the schedule */
// @ApiMember(Description="Description of the schedule")
public Description: string;
/** @description If the schedule is active or not */
// @ApiMember(Description="If the schedule is active or not")
public Active: boolean;
/** @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 */
// @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 TimeInterval: number;
/** @description The timestamp to which the schedule is valid from */
// @ApiMember(Description="The timestamp to which the schedule is valid from", IsRequired=true)
public ValidFrom: string;
/** @description The timestamp to which the schedule is valid to */
// @ApiMember(Description="The timestamp to which the schedule is valid to", IsRequired=true)
public ValidTo: string;
/** @description The time for the schedule opening hours (starttime) */
// @ApiMember(Description="The time for the schedule opening hours (starttime)", IsRequired=true)
public StartTime: string;
/** @description The time for the schedule opening hours (endtime) */
// @ApiMember(Description="The time for the schedule opening hours (endtime)", IsRequired=true)
public EndTime: string;
/** @description 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)
public NumberOfScheduleDays: number;
/** @description 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)
public IsResourceSpecific: boolean;
/** @description The timestamp when the schedule was updated */
// @ApiMember(Description="The timestamp when the schedule was updated", IsRequired=true)
public UpdatedDate: string;
/** @description The timestamp when the schedule was created */
// @ApiMember(Description="The timestamp when the schedule was created", IsRequired=true)
public CreatedDate: string;
/** @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). */
// @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 EnableBookingUntilClosingTime: boolean;
/** @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 */
// @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 DaysOfWeek: DayOfWeekDto[];
/** @description The resources that is connected to the schedule */
// @ApiMember(Description="The resources that is connected to the schedule")
public Resources: ScheduleResources[];
/** @description The services that is connected to the schedule */
// @ApiMember(Description="The services that is connected to the schedule")
public Services: ScheduleServices[];
/** @description The exceptions that is added to the schedule */
// @ApiMember(Description="The exceptions that is added to the schedule")
public Exceptions: RecurringScheduleExceptionResponse[];
/** @description 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")
public ScheduleDates: RecurringScheduleDateResponse[];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<RecurringScheduleQueryResponse>) { (Object as any).assign(this, init); }
}
export class AddRecurringScheduleDate
{
/** @description 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)
public Date: string;
/** @description The time for the schedule opening hours (starttime) */
// @ApiMember(Description="The time for the schedule opening hours (starttime)", IsRequired=true)
public StartTime: string;
/** @description The time for the schedule opening hours (endtime) */
// @ApiMember(Description="The time for the schedule opening hours (endtime)", IsRequired=true)
public EndTime: string;
public constructor(init?: Partial<AddRecurringScheduleDate>) { (Object as any).assign(this, init); }
}
export class ScheduleException
{
public StartTime: string;
public EndTime: string;
public constructor(init?: Partial<ScheduleException>) { (Object as any).assign(this, init); }
}
export class AddScheduleResource
{
/** @description The resource id */
// @ApiMember(Description="The resource id", IsRequired=true)
public Id: number;
public constructor(init?: Partial<AddScheduleResource>) { (Object as any).assign(this, init); }
}
export class AddScheduleService
{
/** @description The service id */
// @ApiMember(Description="The service id", IsRequired=true)
public Id: number;
public constructor(init?: Partial<AddScheduleService>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class UpdateRecurringSchedule implements ICompany
{
/** @description Id of the schedule to update */
// @ApiMember(Description="Id of the schedule to update", IsRequired=true, ParameterType="path")
public Id: number;
/** @description 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.")
public CompanyId?: string;
/** @description The schedule name */
// @ApiMember(Description="The schedule name")
public Name: string;
/** @description The schedule description */
// @ApiMember(Description="The schedule description")
public Description: string;
/** @description If schedule is active or not */
// @ApiMember(Description="If schedule is active or not")
public Active?: boolean;
/** @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 */
// @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 TimeInterval: number;
/** @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). */
// @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 EnableBookingUntilClosingTime: boolean;
/** @description The timestamp to which the schedule is valid from */
// @ApiMember(Description="The timestamp to which the schedule is valid from", IsRequired=true)
public ValidFrom: string;
/** @description The timestamp to which the schedule is valid to */
// @ApiMember(Description="The timestamp to which the schedule is valid to", IsRequired=true)
public ValidTo: string;
/** @description The time for the schedule opening hours (starttime) */
// @ApiMember(Description="The time for the schedule opening hours (starttime)", IsRequired=true)
public StartTime: string;
/** @description The time for the schedule opening hours (endtime) */
// @ApiMember(Description="The time for the schedule opening hours (endtime)", IsRequired=true)
public EndTime: string;
/** @description 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)
public NumberOfScheduleDays: number;
/** @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. */
// @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 DaysOfWeek: number[];
/** @description 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.")
public ScheduleDates: AddRecurringScheduleDate[];
/** @description 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.")
public Exceptions: ScheduleException[];
/** @description 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.")
public Resources: AddScheduleResource[];
/** @description Set what services the schedule should be connected to. */
// @ApiMember(Description="Set what services the schedule should be connected to.")
public Services: AddScheduleService[];
public constructor(init?: Partial<UpdateRecurringSchedule>) { (Object as any).assign(this, init); }
}
TypeScript UpdateRecurringSchedule DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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: testapi.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
}
}
}