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
namespace BokaMera.API.ServiceModel.Dtos

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type TimeExceptionReosurceDetails() = 
        ///<summary>
        ///Ids of the resources that owns this exception
        ///</summary>
        [<ApiMember(Description="Ids of the resources that owns this exception")>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///Name of the resource
        ///</summary>
        [<ApiMember(Description="Name of the resource")>]
        member val Name:String = null with get,set

        ///<summary>
        ///Description of the resource
        ///</summary>
        [<ApiMember(Description="Description of the resource")>]
        member val Description:String = null with get,set

        ///<summary>
        ///Color of the resource
        ///</summary>
        [<ApiMember(Description="Color of the resource")>]
        member val Color:String = null with get,set

        ///<summary>
        ///Image of the resource
        ///</summary>
        [<ApiMember(Description="Image of the resource")>]
        member val ImageUrl:Uri = null with get,set

        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type ExceptionCalendarExportStatus() = 
        member val CalendarId:String = null with get,set
        member val ExceptionId:Int32 = new Int32() with get,set
        member val Synced:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<AllowNullLiteral>]
    type DayOfWeekDto() = 
        member val DayOfWeekId:Int32 = new Int32() with get,set
        member val DotNetDayOfWeekId:Int32 = new Int32() with get,set
        member val DayOfWeek:String = null with get,set

    [<AllowNullLiteral>]
    type ResourceTimeExceptionQueryResponse() = 
        ///<summary>
        ///Time exception id
        ///</summary>
        [<ApiMember(Description="Time exception id")>]
        member val Id:Int32 = new Int32() with get,set

        ///<summary>
        ///Time company id
        ///</summary>
        [<ApiMember(Description="Time company id")>]
        member val CompanyId:Guid = new Guid() with 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")>]
        member val Locked:Boolean = new Boolean() with get,set

        ///<summary>
        ///Resources that owns this exception
        ///</summary>
        [<ApiMember(Description="Resources that owns this exception")>]
        member val ResourceIds:Int32[] = [||] with get,set

        ///<summary>
        ///Resources that owns this exception
        ///</summary>
        [<ApiMember(Description="Resources that owns this exception")>]
        member val Resources:ResizeArray<TimeExceptionReosurceDetails> = new ResizeArray<TimeExceptionReosurceDetails>() with get,set

        ///<summary>
        ///Indicates wheter or not the time exception is recurring
        ///</summary>
        [<ApiMember(Description="Indicates wheter or not the time exception is recurring")>]
        member val IsRecurring:Boolean = new Boolean() with get,set

        ///<summary>
        ///Time exception starting timestamp
        ///</summary>
        [<ApiMember(Description="Time exception starting timestamp")>]
        member val From:DateTime = new DateTime() with get,set

        ///<summary>
        ///Time exception ending timestamp
        ///</summary>
        [<ApiMember(Description="Time exception ending timestamp")>]
        member val To:DateTime = new DateTime() with 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")>]
        member val FromTime:TimeSpan = new TimeSpan() with 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")>]
        member val ToTime:TimeSpan = new TimeSpan() with 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, ...")>]
        member val ReasonText:String = null with 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, ...")>]
        member val ReasonTextPublic:String = null with 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")>]
        member val Color:String = null with 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")>]
        member val BlockTime:Boolean = new Boolean() with 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")>]
        member val Private:Boolean = new Boolean() with get,set

        ///<summary>
        ///The status for export to calendars like Gcal
        ///</summary>
        [<ApiMember(Description="The status for export to calendars like Gcal")>]
        member val CalendarExportStatus:ExceptionCalendarExportStatus = null with 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")>]
        member val DaysOfWeek:ResizeArray<DayOfWeekDto> = new ResizeArray<DayOfWeekDto>() with get,set

        ///<summary>
        ///The datetime the exception was created
        ///</summary>
        [<ApiMember(Description="The datetime the exception was created")>]
        member val Created:DateTime = new DateTime() with get,set

        member val ResponseStatus:ResponseStatus = null with 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(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type DeleteResourceTimeException() = 
        ///<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.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///Time exception id to be deleted
        ///</summary>
        [<ApiMember(Description="Time exception id to be deleted")>]
        member val Id:Int32 = new Int32() with get,set

F# DeleteResourceTimeException DTOs

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

HTTP + XML

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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResourceTimeExceptionQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BlockTime>false</BlockTime>
  <CalendarExportStatus>
    <CalendarId>String</CalendarId>
    <ExceptionId>0</ExceptionId>
    <Synced>false</Synced>
  </CalendarExportStatus>
  <Color>String</Color>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Created>0001-01-01T00:00:00</Created>
  <DaysOfWeek>
    <DayOfWeekDto>
      <DayOfWeek>String</DayOfWeek>
      <DayOfWeekId>0</DayOfWeekId>
      <DotNetDayOfWeekId>0</DotNetDayOfWeekId>
    </DayOfWeekDto>
  </DaysOfWeek>
  <From>0001-01-01T00:00:00</From>
  <FromTime>PT0S</FromTime>
  <Id>0</Id>
  <IsRecurring>false</IsRecurring>
  <Locked>false</Locked>
  <Private>false</Private>
  <ReasonText>String</ReasonText>
  <ReasonTextPublic>String</ReasonTextPublic>
  <ResourceIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ResourceIds>
  <Resources>
    <TimeExceptionReosurceDetails>
      <Color>String</Color>
      <Description>String</Description>
      <Id>0</Id>
      <ImageUrl i:nil="true" />
      <Name>String</Name>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
    </TimeExceptionReosurceDetails>
  </Resources>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <To>0001-01-01T00:00:00</To>
  <ToTime>PT0S</ToTime>
</ResourceTimeExceptionQueryResponse>