BokaMera.API.Host

<back to all web services

AvaiableTimesGroupedQuery

"use strict";
export class ExceptionText {
    /** @param {{Reason?:string,ReasonPublic?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Reason;
    /** @type {string} */
    ReasonPublic;
}
export class AvailableTimesSum {
    /** @param {{From?:string,To?:string,Free?:number,FreeSpots?:number,ExceptionTexts?:ExceptionText[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    From;
    /** @type {string} */
    To;
    /** @type {number} */
    Free;
    /** @type {number} */
    FreeSpots;
    /** @type {ExceptionText[]} */
    ExceptionTexts;
}
export class AvailableTimesGroupedDates {
    /** @param {{Group?:string,Times?:AvailableTimesSum[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Group;
    /** @type {AvailableTimesSum[]} */
    Times;
}
export class AvailableTimesGroupedDatesResponse {
    /** @param {{CompanyId?:string,ServiceId?:number,TimesFreeTextSingle?:string,TimesFreeTextMultiple?:string,Items?:AvailableTimesGroupedDates[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /** @type {number} */
    ServiceId;
    /** @type {string} */
    TimesFreeTextSingle;
    /** @type {string} */
    TimesFreeTextMultiple;
    /** @type {AvailableTimesGroupedDates[]} */
    Items;
}
export class AvailableTimesResourceTypeResource {
    /** @param {{ResourceTypeId?:number,ResourceId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The resourcetype id */
    ResourceTypeId;
    /**
     * @type {number}
     * @description The resource id */
    ResourceId;
}
export class AvaiableTimesGroupedQuery {
    /** @param {{CompanyId?:string,ServiceId?:number,From?:string,To?:string,Resources?:AvailableTimesResourceTypeResource[],NumberOfResources?:number,ShowPerResource?:boolean,InsideSearchInterval?:boolean,Duration?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description Company to show services for */
    CompanyId;
    /**
     * @type {number}
     * @description Service id */
    ServiceId;
    /**
     * @type {string}
     * @description From what datetime to show available times */
    From;
    /**
     * @type {string}
     * @description To what datetime to show available times */
    To;
    /**
     * @type {AvailableTimesResourceTypeResource[]}
     * @description Here you can select one of the resource in each resourcetype connected to the service, if none is selected it will show available times for all */
    Resources;
    /**
     * @type {number}
     * @description Here you select number of resources to book (in each resourcetype). Default is 1. */
    NumberOfResources;
    /**
     * @type {boolean}
     * @description If you want to include the connected resourcetypes and resources */
    ShowPerResource;
    /**
     * @type {boolean}
     * @description Both start and time time should be inside test interval. Default is false which means only start time needs to be inside. */
    InsideSearchInterval;
    /**
     * @type {?number}
     * @description The duration you want to book. Needs to withing the service Min and Max. If not set it will use the service duration */
    Duration;
    /** @type {ResponseStatus} */
    ResponseStatus;
}

JavaScript AvaiableTimesGroupedQuery DTOs

GET /services/{ServiceId}/availabletimes/grouped HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AvailableTimesGroupedDatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Items>
    <AvailableTimesGroupedDates>
      <Group>0001-01-01T00:00:00</Group>
      <Times>
        <AvailableTimesSum>
          <ExceptionTexts i:nil="true" />
          <Free>0</Free>
          <FreeSpots>0</FreeSpots>
          <From>0001-01-01T00:00:00</From>
          <To>0001-01-01T00:00:00</To>
        </AvailableTimesSum>
      </Times>
    </AvailableTimesGroupedDates>
  </Items>
  <ServiceId>0</ServiceId>
  <TimesFreeTextMultiple>String</TimesFreeTextMultiple>
  <TimesFreeTextSingle>String</TimesFreeTextSingle>
</AvailableTimesGroupedDatesResponse>