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
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 DayOfWeekDto
    {
        public virtual int DayOfWeekId { get; set; }
        public virtual int DotNetDayOfWeekId { get; set; }
        public virtual string DayOfWeek { get; set; }
    }

    [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("IsAuthenticated")]
    public partial class DeleteResourceTimeException
        : ICompany
    {
        ///<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>
        ///Time exception id to be deleted
        ///</summary>
        [ApiMember(Description="Time exception id to be deleted")]
        public virtual int Id { get; set; }
    }

    public partial class ExceptionCalendarExportStatus
    {
        public virtual string CalendarId { get; set; }
        public virtual int ExceptionId { get; set; }
        public virtual bool? Synced { get; set; }
    }

    public partial class ResourceTimeExceptionQueryResponse
    {
        public ResourceTimeExceptionQueryResponse()
        {
            ResourceIds = new int[]{};
            Resources = new List<TimeExceptionReosurceDetails>{};
            DaysOfWeek = new List<DayOfWeekDto>{};
        }

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

        ///<summary>
        ///Time company id
        ///</summary>
        [ApiMember(Description="Time company id")]
        public virtual Guid CompanyId { get; set; }

        ///<summary>
        ///If it's locked for editing for the logged in administrator
        ///</summary>
        [ApiMember(Description="If it's locked for editing for the logged in administrator")]
        public virtual bool Locked { get; set; }

        ///<summary>
        ///Resources that owns this exception
        ///</summary>
        [ApiMember(Description="Resources that owns this exception")]
        public virtual int[] ResourceIds { get; set; }

        ///<summary>
        ///Resources that owns this exception
        ///</summary>
        [ApiMember(Description="Resources that owns this exception")]
        public virtual List<TimeExceptionReosurceDetails> Resources { get; set; }

        ///<summary>
        ///Indicates wheter or not the time exception is recurring
        ///</summary>
        [ApiMember(Description="Indicates wheter or not the time exception is recurring")]
        public virtual bool IsRecurring { get; set; }

        ///<summary>
        ///Time exception starting timestamp
        ///</summary>
        [ApiMember(Description="Time exception starting timestamp")]
        public virtual DateTime From { get; set; }

        ///<summary>
        ///Time exception ending timestamp
        ///</summary>
        [ApiMember(Description="Time exception ending timestamp")]
        public virtual DateTime To { get; set; }

        ///<summary>
        ///If recurring then this value indicates the time of day when the time exception begins
        ///</summary>
        [ApiMember(Description="If recurring then this value indicates the time of day when the time exception begins")]
        public virtual TimeSpan FromTime { get; set; }

        ///<summary>
        ///If recurring then this value indicates the time of day when the time exception ends
        ///</summary>
        [ApiMember(Description="If recurring then this value indicates the time of day when the time exception ends")]
        public virtual TimeSpan ToTime { get; set; }

        ///<summary>
        ///The reason of the time exception, example: Vacation, doctors appointment, ...
        ///</summary>
        [ApiMember(Description="The reason of the time exception, example: Vacation, doctors appointment, ...")]
        public virtual string ReasonText { get; set; }

        ///<summary>
        ///The reason of the time exception that could be public to customers, example: Vacation, Closed, Sick leave, ...
        ///</summary>
        [ApiMember(Description="The reason of the time exception that could be public to customers, example: Vacation, Closed, Sick leave, ...")]
        public virtual string ReasonTextPublic { get; set; }

        ///<summary>
        ///What hexadecimal color code the exception should have in the scheduler
        ///</summary>
        [ApiMember(Description="What hexadecimal color code the exception should have in the scheduler")]
        public virtual string Color { get; set; }

        ///<summary>
        ///If the time exception should block the time in the scheduler so it's not avaialable to book
        ///</summary>
        [ApiMember(Description="If the time exception should block the time in the scheduler so it's not avaialable to book")]
        public virtual bool BlockTime { get; set; }

        ///<summary>
        ///If the ReasonText should only be visible to conncted resources. If false, all resources will be able to see it
        ///</summary>
        [ApiMember(Description="If the ReasonText should only be visible to conncted resources. If false, all resources will be able to see it")]
        public virtual bool Private { get; set; }

        ///<summary>
        ///The status for export to calendars like Gcal
        ///</summary>
        [ApiMember(Description="The status for export to calendars like Gcal")]
        public virtual ExceptionCalendarExportStatus CalendarExportStatus { 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 datetime the exception was created
        ///</summary>
        [ApiMember(Description="The datetime the exception was created")]
        public virtual DateTime Created { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class TimeExceptionReosurceDetails
    {
        ///<summary>
        ///Ids of the resources that owns this exception
        ///</summary>
        [ApiMember(Description="Ids of the resources that owns this exception")]
        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>
        ///Description of the resource
        ///</summary>
        [ApiMember(Description="Description of the resource")]
        public virtual string Description { get; set; }

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

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

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# DeleteResourceTimeException DTOs

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

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}