BokaMera.API.Host

<back to all web services

DeleteResourceTimeException

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/timeexceptions/{Id}Delete a given time exception that the user have access too
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)
    @ValidateRequest(Validator="IsAuthenticated")
    public static class DeleteResourceTimeException 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 id to be deleted
        */
        @ApiMember(Description="Time exception id to be deleted")
        public Integer Id = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public DeleteResourceTimeException setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getId() { return Id; }
        public DeleteResourceTimeException setId(Integer value) { this.Id = value; return this; }
    }

    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 DeleteResourceTimeException DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /timeexceptions/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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":"00:00:00","ToTime":"00:00:00","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"}}}