BokaMera.API.Host

<back to all web services

UpdateDateSchedule

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/schedules/date/{Id}Update date scheduleUpdate date schedule to the company for the currently logged in user, only administrators are allowed to add schedules.
"use strict";
export class DateScheduleDateResponse {
    /** @param {{Id?:number,From?:string,To?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    From;
    /** @type {string} */
    To;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ScheduleResources {
    /** @param {{Id?:number,Name?:string,ImageUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /**
     * @type {string}
     * @description Name of the resource */
    Name;
    /**
     * @type {string}
     * @description The image url of the resource */
    ImageUrl;
}
export class ScheduleServices {
    /** @param {{Id?:number,Name?:string,ImageUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /**
     * @type {string}
     * @description Name of the service */
    Name;
    /**
     * @type {string}
     * @description The image url of the service */
    ImageUrl;
}
export class DateScheduleQueryResponse {
    /** @param {{Id?:number,Name?:string,Description?:string,Active?:boolean,IsResourceSpecific?:boolean,ScheduleDates?:DateScheduleDateResponse[],Resources?:ScheduleResources[],Services?:ScheduleServices[],UpdatedDate?:string,CreatedDate?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The schedule id */
    Id;
    /**
     * @type {string}
     * @description Name of the schedule */
    Name;
    /**
     * @type {string}
     * @description Description of the schedule */
    Description;
    /**
     * @type {boolean}
     * @description If the schedule is active or not */
    Active;
    /**
     * @type {boolean}
     * @description If the schedule is only connected to some specific resources. Note: You must have IncludeResources property to see this. */
    IsResourceSpecific;
    /**
     * @type {DateScheduleDateResponse[]}
     * @description Schedule dates */
    ScheduleDates;
    /**
     * @type {ScheduleResources[]}
     * @description The resources that is connected to the schedule */
    Resources;
    /**
     * @type {ScheduleServices[]}
     * @description The services that is connected to the schedule */
    Services;
    /**
     * @type {string}
     * @description The timestamp when the schedule was updated */
    UpdatedDate;
    /**
     * @type {string}
     * @description The timestamp when the schedule was created */
    CreatedDate;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class AddDateScheduleDate {
    /** @param {{From?:string,To?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The from date for the timeslot */
    From;
    /**
     * @type {string}
     * @description The to date for the timeslot */
    To;
}
export class AddScheduleResource {
    /** @param {{Id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The resource id */
    Id;
}
export class AddScheduleService {
    /** @param {{Id?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The service id */
    Id;
}
export class UpdateDateSchedule {
    /** @param {{Id?:number,CompanyId?:string,Name?:string,Description?:string,Active?:boolean,NumberOfScheduleDays?:number,ScheduleDates?:AddDateScheduleDate[],Resources?:AddScheduleResource[],Services?:AddScheduleService[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description Id of the schedule to update */
    Id;
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {string}
     * @description The schedule name */
    Name;
    /**
     * @type {string}
     * @description The schedule description */
    Description;
    /**
     * @type {?boolean}
     * @description If schedule is active or not */
    Active;
    /**
     * @type {number}
     * @description The number of days the schedule is valid from todays date */
    NumberOfScheduleDays;
    /**
     * @type {AddDateScheduleDate[]}
     * @description The dates for the schedule. This is the actual timeslots. */
    ScheduleDates;
    /**
     * @type {AddScheduleResource[]}
     * @description If the schedule is only connected to some resources, add them here. If empty, it will be used by all resources. */
    Resources;
    /**
     * @type {AddScheduleService[]}
     * @description Set what services the schedule should be connected to. */
    Services;
}

JavaScript UpdateDateSchedule 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.

PUT /schedules/date/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateDateSchedule xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Description>String</Description>
  <Id>0</Id>
  <Name>String</Name>
  <NumberOfScheduleDays>0</NumberOfScheduleDays>
  <Resources>
    <AddScheduleResource>
      <Id>0</Id>
    </AddScheduleResource>
  </Resources>
  <ScheduleDates>
    <AddDateScheduleDate>
      <From>0001-01-01T00:00:00</From>
      <To>0001-01-01T00:00:00</To>
    </AddDateScheduleDate>
  </ScheduleDates>
  <Services>
    <AddScheduleService>
      <Id>0</Id>
    </AddScheduleService>
  </Services>
</UpdateDateSchedule>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DateScheduleQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <Description>String</Description>
  <Id>0</Id>
  <IsResourceSpecific>false</IsResourceSpecific>
  <Name>String</Name>
  <Resources>
    <ScheduleResources>
      <Id>0</Id>
      <ImageUrl i:nil="true" />
      <Name>String</Name>
    </ScheduleResources>
  </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>
  <ScheduleDates>
    <DateScheduleDateResponse>
      <From>0001-01-01T00:00:00</From>
      <Id>0</Id>
      <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>
      <To>0001-01-01T00:00:00</To>
    </DateScheduleDateResponse>
  </ScheduleDates>
  <Services>
    <ScheduleServices>
      <Id>0</Id>
      <ImageUrl i:nil="true" />
      <Name>String</Name>
    </ScheduleServices>
  </Services>
  <UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
</DateScheduleQueryResponse>