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

export class TimeExceptionReosurceDetails
{
    /** @description Ids of the resources that owns this exception */
    // @ApiMember(Description="Ids of the resources that owns this exception")
    public Id: number;

    /** @description Name of the resource */
    // @ApiMember(Description="Name of the resource")
    public Name: string;

    /** @description Description of the resource */
    // @ApiMember(Description="Description of the resource")
    public Description: string;

    /** @description Color of the resource */
    // @ApiMember(Description="Color of the resource")
    public Color: string;

    /** @description Image of the resource */
    // @ApiMember(Description="Image of the resource")
    public ImageUrl: string;

    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<TimeExceptionReosurceDetails>) { (Object as any).assign(this, init); }
}

export class ExceptionCalendarExportStatus
{
    public CalendarId: string;
    public ExceptionId: number;
    public Synced?: boolean;

    public constructor(init?: Partial<ExceptionCalendarExportStatus>) { (Object as any).assign(this, init); }
}

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 ResourceTimeExceptionQueryResponse
{
    /** @description Time exception id */
    // @ApiMember(Description="Time exception id")
    public Id: number;

    /** @description Time company id */
    // @ApiMember(Description="Time company id")
    public CompanyId: string;

    /** @description 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 Locked: boolean;

    /** @description Resources that owns this exception */
    // @ApiMember(Description="Resources that owns this exception")
    public ResourceIds: number[];

    /** @description Resources that owns this exception */
    // @ApiMember(Description="Resources that owns this exception")
    public Resources: TimeExceptionReosurceDetails[];

    /** @description Indicates wheter or not the time exception is recurring */
    // @ApiMember(Description="Indicates wheter or not the time exception is recurring")
    public IsRecurring: boolean;

    /** @description Time exception starting timestamp */
    // @ApiMember(Description="Time exception starting timestamp")
    public From: string;

    /** @description Time exception ending timestamp */
    // @ApiMember(Description="Time exception ending timestamp")
    public To: string;

    /** @description 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 FromTime: string;

    /** @description 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 ToTime: string;

    /** @description The reason of the time exception, example: Vacation, doctors appointment, ... */
    // @ApiMember(Description="The reason of the time exception, example: Vacation, doctors appointment, ...")
    public ReasonText: string;

    /** @description 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 ReasonTextPublic: string;

    /** @description 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 Color: string;

    /** @description 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 BlockTime: boolean;

    /** @description 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 Private: boolean;

    /** @description The status for export to calendars like Gcal */
    // @ApiMember(Description="The status for export to calendars like Gcal")
    public CalendarExportStatus: ExceptionCalendarExportStatus;

    /** @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 datetime the exception was created */
    // @ApiMember(Description="The datetime the exception was created")
    public Created: string;

    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<ResourceTimeExceptionQueryResponse>) { (Object as any).assign(this, init); }
}

// @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")
export class DeleteResourceTimeException implements ICompany
{
    /** @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 Time exception id to be deleted */
    // @ApiMember(Description="Time exception id to be deleted")
    public Id: number;

    public constructor(init?: Partial<DeleteResourceTimeException>) { (Object as any).assign(this, init); }
}

TypeScript 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>