| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /timeexceptions | Inserts a time exception for a given resource belonging to the current user | Inserts a time exception for a given resource belonging to the current user if no colliding bookings are found. If a colliding booking is found. A time exception must be either recurring (DaysOfWeek is set and From and To is the valid range for the recurrency) or non recurring (From and To are set) |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
public class dtos
{
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
// @ApiResponse(Description="Bookings exists that needs to be unbooked before creating this time exceptions, use the /timeexceptions/collidingevents to find which bookings and use the booking service to unbook them", StatusCode=409)
@ValidateRequest(Validator="IsAuthenticated")
public static class CreateResourceTimeException extends CreateResourceTimeExceptionBase implements 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.")
public UUID CompanyId = null;
/**
* Time exception starting datestamp, only the date of day part is used of this value
*/
@ApiMember(Description="Time exception starting datestamp, only the date of day part is used of this value", IsRequired=true)
public Date From = null;
/**
* Time exception ending datestamp, only the date of day part is used of this value
*/
@ApiMember(Description="Time exception ending datestamp, only the date of day part is used of this value", IsRequired=true)
public Date To = null;
/**
* Resource id of the resource that owns this exception
*/
@ApiMember(Description="Resource id of the resource that owns this exception", IsRequired=true)
public ArrayList<Integer> ResourceIds = null;
/**
* This value indicates the time of day when the time exception begins. Example: 10:00. If Recurring this will be the startime for each recurring day.
*/
@ApiMember(Description="This value indicates the time of day when the time exception begins. Example: 10:00. If Recurring this will be the startime for each recurring day.")
public TimeSpan FromTime = null;
/**
* This value indicates the time of day when the time exception ends. Example: 12:00. If Recurring this will be the endtime for each recurring day.
*/
@ApiMember(Description="This value indicates the time of day when the time exception ends. Example: 12:00. If Recurring this will be the endtime for each recurring day.")
public TimeSpan ToTime = null;
/**
* A comma separated list of which days this day exception belongs to, 1 = Monday .. 7 = Sunday
*/
@ApiMember(Description="A comma separated list of which days this day exception belongs to, 1 = Monday .. 7 = Sunday")
public ArrayList<Integer> DaysOfWeek = null;
/**
* The reason of the time exception, example: Vacation, doctors appointment, ...
*/
@ApiMember(Description="The reason of the time exception, example: Vacation, doctors appointment, ...", IsRequired=true)
public String ReasonText = null;
/**
* The reason of the time exception that could be public to customers, example: Vacation, Closed, Sick leave, ...
*/
@ApiMember(Description="The reason of the time exception that could be public to customers, example: Vacation, Closed, Sick leave, ...")
public String ReasonTextPublic = null;
/**
* What hexadecimal color code the exception should have in the scheduler
*/
@ApiMember(Description="What hexadecimal color code the exception should have in the scheduler")
public String Color = null;
/**
* If the time exception should block the time in the scheduler so it's not avaialable to book
*/
@ApiMember(Description="If the time exception should block the time in the scheduler so it's not avaialable to book")
public Boolean BlockTime = null;
/**
* If the ReasonText should only be visible to conncted resources. If false, all resources will be able to see it
*/
@ApiMember(Description="If the ReasonText should only be visible to conncted resources. If false, all resources will be able to see it")
public Boolean Private = null;
/**
* By default sets to 1, which is to add time exception without canceling colliding bookings
*/
@ApiMember(Description="By default sets to 1, which is to add time exception without canceling colliding bookings")
public CollidingBookingOptions CollidingBookingOptions = null;
public UUID getCompanyId() { return CompanyId; }
public CreateResourceTimeException setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Date getFrom() { return From; }
public CreateResourceTimeException setFrom(Date value) { this.From = value; return this; }
public Date getTo() { return To; }
public CreateResourceTimeException setTo(Date value) { this.To = value; return this; }
public ArrayList<Integer> getResourceIds() { return ResourceIds; }
public CreateResourceTimeException setResourceIds(ArrayList<Integer> value) { this.ResourceIds = value; return this; }
public TimeSpan getFromTime() { return FromTime; }
public CreateResourceTimeException setFromTime(TimeSpan value) { this.FromTime = value; return this; }
public TimeSpan getToTime() { return ToTime; }
public CreateResourceTimeException setToTime(TimeSpan value) { this.ToTime = value; return this; }
public ArrayList<Integer> getDaysOfWeek() { return DaysOfWeek; }
public CreateResourceTimeException setDaysOfWeek(ArrayList<Integer> value) { this.DaysOfWeek = value; return this; }
public String getReasonText() { return ReasonText; }
public CreateResourceTimeException setReasonText(String value) { this.ReasonText = value; return this; }
public String getReasonTextPublic() { return ReasonTextPublic; }
public CreateResourceTimeException setReasonTextPublic(String value) { this.ReasonTextPublic = value; return this; }
public String getColor() { return Color; }
public CreateResourceTimeException setColor(String value) { this.Color = value; return this; }
public Boolean isBlockTime() { return BlockTime; }
public CreateResourceTimeException setBlockTime(Boolean value) { this.BlockTime = value; return this; }
public Boolean isPrivate() { return Private; }
public CreateResourceTimeException setPrivate(Boolean value) { this.Private = value; return this; }
public CollidingBookingOptions getCollidingBookingOptions() { return CollidingBookingOptions; }
public CreateResourceTimeException setCollidingBookingOptions(CollidingBookingOptions value) { this.CollidingBookingOptions = value; return this; }
}
public static class CreateResourceTimeExceptionBase
{
/**
* If this equals true it will it add the time exception with the option you have selected in CollidingBookingOption. Default is to cancel all colliding bookings.
*/
@ApiMember(Description="If this equals true it will it add the time exception with the option you have selected in CollidingBookingOption. Default is to cancel all colliding bookings.")
public Boolean Force = null;
/**
* When Force=true and colliding bookings exsists, this message is the message that are sent to the users when canceling their bookings.
*/
@ApiMember(Description="When Force=true and colliding bookings exsists, this message is the message that are sent to the users when canceling their bookings.")
public String CancelMessage = null;
/**
* When Force=true and colliding bookings exsists, send cancelmessage as SMS Confirmation
*/
@ApiMember(Description="When Force=true and colliding bookings exsists, send cancelmessage as SMS Confirmation")
public Boolean SendSmsConfirmation = null;
/**
* When Force=true and colliding bookings exsists, send cancelmessage as Email Confirmation
*/
@ApiMember(Description="When Force=true and colliding bookings exsists, send cancelmessage as Email Confirmation")
public Boolean SendEmailConfirmation = null;
public Boolean isForce() { return Force; }
public CreateResourceTimeExceptionBase setForce(Boolean value) { this.Force = value; return this; }
public String getCancelMessage() { return CancelMessage; }
public CreateResourceTimeExceptionBase setCancelMessage(String value) { this.CancelMessage = value; return this; }
public Boolean isSendSmsConfirmation() { return SendSmsConfirmation; }
public CreateResourceTimeExceptionBase setSendSmsConfirmation(Boolean value) { this.SendSmsConfirmation = value; return this; }
public Boolean isSendEmailConfirmation() { return SendEmailConfirmation; }
public CreateResourceTimeExceptionBase setSendEmailConfirmation(Boolean value) { this.SendEmailConfirmation = value; return this; }
}
public static enum CollidingBookingOptions
{
AddWithoutCancelingCollidingBookings(1),
AddAndCancelCollidingBookings(2);
private final int value;
CollidingBookingOptions(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
public static class ResourceTimeExceptionQueryResponse
{
/**
* Time exception id
*/
@ApiMember(Description="Time exception id")
public Integer Id = null;
/**
* Time company id
*/
@ApiMember(Description="Time company id")
public UUID CompanyId = null;
/**
* If it's locked for editing for the logged in administrator
*/
@ApiMember(Description="If it's locked for editing for the logged in administrator")
public Boolean Locked = null;
/**
* Resources that owns this exception
*/
@ApiMember(Description="Resources that owns this exception")
public ArrayList<Integer> ResourceIds = null;
/**
* Resources that owns this exception
*/
@ApiMember(Description="Resources that owns this exception")
public ArrayList<TimeExceptionReosurceDetails> Resources = null;
/**
* Indicates wheter or not the time exception is recurring
*/
@ApiMember(Description="Indicates wheter or not the time exception is recurring")
public Boolean IsRecurring = null;
/**
* Time exception starting timestamp
*/
@ApiMember(Description="Time exception starting timestamp")
public Date From = null;
/**
* Time exception ending timestamp
*/
@ApiMember(Description="Time exception ending timestamp")
public Date To = null;
/**
* If recurring then this value indicates the time of day when the time exception begins
*/
@ApiMember(Description="If recurring then this value indicates the time of day when the time exception begins")
public TimeSpan FromTime = null;
/**
* If recurring then this value indicates the time of day when the time exception ends
*/
@ApiMember(Description="If recurring then this value indicates the time of day when the time exception ends")
public TimeSpan ToTime = null;
/**
* The reason of the time exception, example: Vacation, doctors appointment, ...
*/
@ApiMember(Description="The reason of the time exception, example: Vacation, doctors appointment, ...")
public String ReasonText = null;
/**
* The reason of the time exception that could be public to customers, example: Vacation, Closed, Sick leave, ...
*/
@ApiMember(Description="The reason of the time exception that could be public to customers, example: Vacation, Closed, Sick leave, ...")
public String ReasonTextPublic = null;
/**
* What hexadecimal color code the exception should have in the scheduler
*/
@ApiMember(Description="What hexadecimal color code the exception should have in the scheduler")
public String Color = null;
/**
* If the time exception should block the time in the scheduler so it's not avaialable to book
*/
@ApiMember(Description="If the time exception should block the time in the scheduler so it's not avaialable to book")
public Boolean BlockTime = null;
/**
* If the ReasonText should only be visible to conncted resources. If false, all resources will be able to see it
*/
@ApiMember(Description="If the ReasonText should only be visible to conncted resources. If false, all resources will be able to see it")
public Boolean Private = null;
/**
* The status for export to calendars like Gcal
*/
@ApiMember(Description="The status for export to calendars like Gcal")
public ExceptionCalendarExportStatus CalendarExportStatus = 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")
public ArrayList<DayOfWeekDto> DaysOfWeek = null;
/**
* The datetime the exception was created
*/
@ApiMember(Description="The datetime the exception was created")
public Date Created = null;
public ResponseStatus ResponseStatus = null;
public Integer getId() { return Id; }
public ResourceTimeExceptionQueryResponse setId(Integer value) { this.Id = value; return this; }
public UUID getCompanyId() { return CompanyId; }
public ResourceTimeExceptionQueryResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Boolean isLocked() { return Locked; }
public ResourceTimeExceptionQueryResponse setLocked(Boolean value) { this.Locked = value; return this; }
public ArrayList<Integer> getResourceIds() { return ResourceIds; }
public ResourceTimeExceptionQueryResponse setResourceIds(ArrayList<Integer> value) { this.ResourceIds = value; return this; }
public ArrayList<TimeExceptionReosurceDetails> getResources() { return Resources; }
public ResourceTimeExceptionQueryResponse setResources(ArrayList<TimeExceptionReosurceDetails> value) { this.Resources = value; return this; }
public Boolean getIsRecurring() { return IsRecurring; }
public ResourceTimeExceptionQueryResponse setIsRecurring(Boolean value) { this.IsRecurring = value; return this; }
public Date getFrom() { return From; }
public ResourceTimeExceptionQueryResponse setFrom(Date value) { this.From = value; return this; }
public Date getTo() { return To; }
public ResourceTimeExceptionQueryResponse setTo(Date value) { this.To = value; return this; }
public TimeSpan getFromTime() { return FromTime; }
public ResourceTimeExceptionQueryResponse setFromTime(TimeSpan value) { this.FromTime = value; return this; }
public TimeSpan getToTime() { return ToTime; }
public ResourceTimeExceptionQueryResponse setToTime(TimeSpan value) { this.ToTime = value; return this; }
public String getReasonText() { return ReasonText; }
public ResourceTimeExceptionQueryResponse setReasonText(String value) { this.ReasonText = value; return this; }
public String getReasonTextPublic() { return ReasonTextPublic; }
public ResourceTimeExceptionQueryResponse setReasonTextPublic(String value) { this.ReasonTextPublic = value; return this; }
public String getColor() { return Color; }
public ResourceTimeExceptionQueryResponse setColor(String value) { this.Color = value; return this; }
public Boolean isBlockTime() { return BlockTime; }
public ResourceTimeExceptionQueryResponse setBlockTime(Boolean value) { this.BlockTime = value; return this; }
public Boolean isPrivate() { return Private; }
public ResourceTimeExceptionQueryResponse setPrivate(Boolean value) { this.Private = value; return this; }
public ExceptionCalendarExportStatus getCalendarExportStatus() { return CalendarExportStatus; }
public ResourceTimeExceptionQueryResponse setCalendarExportStatus(ExceptionCalendarExportStatus value) { this.CalendarExportStatus = value; return this; }
public ArrayList<DayOfWeekDto> getDaysOfWeek() { return DaysOfWeek; }
public ResourceTimeExceptionQueryResponse setDaysOfWeek(ArrayList<DayOfWeekDto> value) { this.DaysOfWeek = value; return this; }
public Date getCreated() { return Created; }
public ResourceTimeExceptionQueryResponse setCreated(Date value) { this.Created = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public ResourceTimeExceptionQueryResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class TimeExceptionReosurceDetails
{
/**
* Ids of the resources that owns this exception
*/
@ApiMember(Description="Ids of the resources that owns this exception")
public Integer Id = null;
/**
* Name of the resource
*/
@ApiMember(Description="Name of the resource")
public String Name = null;
/**
* Description of the resource
*/
@ApiMember(Description="Description of the resource")
public String Description = null;
/**
* Color of the resource
*/
@ApiMember(Description="Color of the resource")
public String Color = null;
/**
* Image of the resource
*/
@ApiMember(Description="Image of the resource")
public Uri ImageUrl = null;
public ResponseStatus ResponseStatus = null;
public Integer getId() { return Id; }
public TimeExceptionReosurceDetails setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public TimeExceptionReosurceDetails setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public TimeExceptionReosurceDetails setDescription(String value) { this.Description = value; return this; }
public String getColor() { return Color; }
public TimeExceptionReosurceDetails setColor(String value) { this.Color = value; return this; }
public Uri getImageUrl() { return ImageUrl; }
public TimeExceptionReosurceDetails setImageUrl(Uri value) { this.ImageUrl = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public TimeExceptionReosurceDetails setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class ExceptionCalendarExportStatus
{
public String CalendarId = null;
public Integer ExceptionId = null;
public Boolean Synced = null;
public String getCalendarId() { return CalendarId; }
public ExceptionCalendarExportStatus setCalendarId(String value) { this.CalendarId = value; return this; }
public Integer getExceptionId() { return ExceptionId; }
public ExceptionCalendarExportStatus setExceptionId(Integer value) { this.ExceptionId = value; return this; }
public Boolean isSynced() { return Synced; }
public ExceptionCalendarExportStatus setSynced(Boolean value) { this.Synced = value; return this; }
}
public static class DayOfWeekDto
{
public Integer DayOfWeekId = null;
public Integer DotNetDayOfWeekId = null;
public String DayOfWeek = null;
public Integer getDayOfWeekId() { return DayOfWeekId; }
public DayOfWeekDto setDayOfWeekId(Integer value) { this.DayOfWeekId = value; return this; }
public Integer getDotNetDayOfWeekId() { return DotNetDayOfWeekId; }
public DayOfWeekDto setDotNetDayOfWeekId(Integer value) { this.DotNetDayOfWeekId = value; return this; }
public String getDayOfWeek() { return DayOfWeek; }
public DayOfWeekDto setDayOfWeek(String value) { this.DayOfWeek = value; return this; }
}
}
Java CreateResourceTimeException 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.
POST /timeexceptions HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
ResourceIds:
[
0
],
FromTime: PT0S,
ToTime: PT0S,
DaysOfWeek:
[
0
],
ReasonText: String,
ReasonTextPublic: String,
Color: String,
BlockTime: False,
Private: False,
CollidingBookingOptions: AddWithoutCancelingCollidingBookings,
Force: False,
CancelMessage: String,
SendSmsConfirmation: False,
SendEmailConfirmation: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
Locked: False,
ResourceIds:
[
0
],
Resources:
[
{
Id: 0,
Name: String,
Description: String,
Color: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}
],
IsRecurring: False,
FromTime: PT0S,
ToTime: PT0S,
ReasonText: String,
ReasonTextPublic: String,
Color: String,
BlockTime: False,
Private: False,
CalendarExportStatus:
{
CalendarId: String,
ExceptionId: 0,
Synced: False
},
DaysOfWeek:
[
{
DayOfWeekId: 0,
DotNetDayOfWeekId: 0,
DayOfWeek: String
}
],
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}