GET | /services/{ServiceId}/nextfreetime | Get the next available time for the service | Get the next available time for the service |
---|
"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 AvailableTimesResponse {
/** @param {{CompanyId?:string,ServiceId?:number,TimesFreeTextSingle?:string,TimesFreeTextMultiple?:string,Times?:AvailableTimesSum[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
CompanyId;
/** @type {number} */
ServiceId;
/** @type {string} */
TimesFreeTextSingle;
/** @type {string} */
TimesFreeTextMultiple;
/** @type {AvailableTimesSum[]} */
Times;
}
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 NextFreeTimeQuery {
/** @param {{CompanyId?:string,ServiceId?:number,From?:string,To?:string,Resources?:AvailableTimesResourceTypeResource[],NumberOfResources?:number,Duration?:number,ShowPerResource?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/**
* @type {?string}
* @description Company to show available time for */
CompanyId;
/**
* @type {number}
* @description Service id */
ServiceId;
/**
* @type {string}
* @description From what datetime to search available times */
From;
/**
* @type {string}
* @description To what datetime to show available times. Optional, if no datetime is set it will search one year */
To;
/**
* @type {AvailableTimesResourceTypeResource[]}
* @description Here you can select one of the resource in each resource type 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 resource type). Default is 1. */
NumberOfResources;
/**
* @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 {boolean}
* @description If you want to include the connected resource types and resources */
ShowPerResource;
}
JavaScript NextFreeTimeQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /services/{ServiceId}/nextfreetime HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK Content-Type: text/jsonl Content-Length: length {"ServiceId":0,"TimesFreeTextSingle":"String","TimesFreeTextMultiple":"String","Times":[{"Free":0,"FreeSpots":0}]}