BokaMera.API.Host

<back to all web services

GetAllBookingQueueForAdmin

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read
The following routes are available for this service:
GET/bookinguserqueue/companyGet all queue items for company
"use strict";
export class BookingUserQueuePriceResponse {
    /** @param {{CompanyId?:string,Id?:number,BookingUserQueueId?:number,ServicePriceId?:number,Quantity?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /** @type {number} */
    Id;
    /** @type {number} */
    BookingUserQueueId;
    /** @type {?number} */
    ServicePriceId;
    /** @type {?number} */
    Quantity;
}
export class GroupBookingSettings {
    /** @param {{Active?:boolean,Min?:number,Max?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Active;
    /** @type {number} */
    Min;
    /** @type {number} */
    Max;
}
export class MultipleResourceSettings {
    /** @param {{Active?:boolean,Min?:number,Max?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Active;
    /** @type {number} */
    Min;
    /** @type {number} */
    Max;
}
export class ServiceInfoResponse {
    /** @param {{Id?:number,Name?:string,Description?:string,ImageUrl?:string,LengthInMinutes?:number,MaxNumberOfSpotsPerBooking?:number,MinNumberOfSpotsPerBooking?:number,GroupBooking?:GroupBookingSettings,MultipleResource?:MultipleResourceSettings,IsGroupBooking?:boolean,IsPaymentEnabled?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    Description;
    /** @type {string} */
    ImageUrl;
    /** @type {?number} */
    LengthInMinutes;
    /** @type {number} */
    MaxNumberOfSpotsPerBooking;
    /** @type {number} */
    MinNumberOfSpotsPerBooking;
    /** @type {GroupBookingSettings} */
    GroupBooking;
    /** @type {MultipleResourceSettings} */
    MultipleResource;
    /** @type {boolean} */
    IsGroupBooking;
    /** @type {boolean} */
    IsPaymentEnabled;
}
export class CompanyInfoResponse {
    /** @param {{Id?:string,Name?:string,LogoType?:string,Category?:string,Street1?:string,Street2?:string,ZipCode?:string,City?:string,CountryId?:string,Longitude?:string,Latitude?:string,Phone?:string,Email?:string,HomePage?:string,SitePath?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Name;
    /** @type {string} */
    LogoType;
    /** @type {string} */
    Category;
    /** @type {string} */
    Street1;
    /** @type {string} */
    Street2;
    /** @type {string} */
    ZipCode;
    /** @type {string} */
    City;
    /** @type {string} */
    CountryId;
    /** @type {string} */
    Longitude;
    /** @type {string} */
    Latitude;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Email;
    /** @type {string} */
    HomePage;
    /** @type {string} */
    SitePath;
}
export class BookingUserQueueItemResponse {
    /** @param {{BookingUserQueueId?:number,CompanyId?:string,CustomerId?:string,ServiceId?:number,From?:string,To?:string,StatusCode?:number,StatusName?:string,SendConfirmationTime?:string,Quantities?:BookingUserQueuePriceResponse[],Service?:ServiceInfoResponse,Company?:CompanyInfoResponse}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    BookingUserQueueId;
    /** @type {string} */
    CompanyId;
    /** @type {string} */
    CustomerId;
    /** @type {number} */
    ServiceId;
    /** @type {string} */
    From;
    /** @type {string} */
    To;
    /** @type {number} */
    StatusCode;
    /** @type {string} */
    StatusName;
    /** @type {?string} */
    SendConfirmationTime;
    /** @type {BookingUserQueuePriceResponse[]} */
    Quantities;
    /** @type {ServiceInfoResponse} */
    Service;
    /** @type {CompanyInfoResponse} */
    Company;
}
export class GetAllBookingQueueForUserResponse {
    /** @param {{BookingUserQueueResponseList?:BookingUserQueueItemResponse[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {BookingUserQueueItemResponse[]} */
    BookingUserQueueResponseList;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetAllBookingQueueForAdmin {
    /** @param {{CompanyId?:string,ServiceId?:number,DateStart?:string,DateEnd?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    CompanyId;
    /** @type {number} */
    ServiceId;
    /** @type {?string} */
    DateStart;
    /** @type {?string} */
    DateEnd;
}

JavaScript GetAllBookingQueueForAdmin DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /bookinguserqueue/company HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json

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

{"BookingUserQueueResponseList":[{"BookingUserQueueId":0,"ServiceId":0,"StatusCode":0,"StatusName":"String","SendConfirmationTime":"0001-01-01T00:00:00","Quantities":[{"Id":0,"BookingUserQueueId":0,"ServicePriceId":0,"Quantity":0}],"Service":{"Id":0,"Name":"String","Description":"String","LengthInMinutes":0,"MaxNumberOfSpotsPerBooking":0,"MinNumberOfSpotsPerBooking":0,"GroupBooking":{"Active":false,"Min":0,"Max":0},"MultipleResource":{"Active":false,"Min":0,"Max":0},"IsGroupBooking":false,"IsPaymentEnabled":false},"Company":{"Name":"String","Category":"String","Street1":"String","Street2":"String","ZipCode":"String","City":"String","CountryId":"String","Longitude":"String","Latitude":"String","Phone":"String","Email":"String","HomePage":"String","SitePath":"String"}}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}