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

GET /bookinguserqueue/company HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetAllBookingQueueForUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingUserQueueResponseList>
    <BookingUserQueueItemResponse>
      <BookingUserQueueId>0</BookingUserQueueId>
      <Company>
        <Category>String</Category>
        <City>String</City>
        <CountryId>String</CountryId>
        <Email>String</Email>
        <HomePage>String</HomePage>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <Latitude>String</Latitude>
        <LogoType i:nil="true" />
        <Longitude>String</Longitude>
        <Name>String</Name>
        <Phone>String</Phone>
        <SitePath>String</SitePath>
        <Street1>String</Street1>
        <Street2>String</Street2>
        <ZipCode>String</ZipCode>
      </Company>
      <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
      <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
      <From>0001-01-01T00:00:00</From>
      <Quantities>
        <BookingUserQueuePriceResponse>
          <BookingUserQueueId>0</BookingUserQueueId>
          <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
          <Id>0</Id>
          <Quantity>0</Quantity>
          <ServicePriceId>0</ServicePriceId>
        </BookingUserQueuePriceResponse>
      </Quantities>
      <SendConfirmationTime>0001-01-01T00:00:00</SendConfirmationTime>
      <Service>
        <Description>String</Description>
        <GroupBooking>
          <Active>false</Active>
          <Max>0</Max>
          <Min>0</Min>
        </GroupBooking>
        <Id>0</Id>
        <ImageUrl i:nil="true" />
        <IsGroupBooking>false</IsGroupBooking>
        <IsPaymentEnabled>false</IsPaymentEnabled>
        <LengthInMinutes>0</LengthInMinutes>
        <MaxNumberOfSpotsPerBooking>0</MaxNumberOfSpotsPerBooking>
        <MinNumberOfSpotsPerBooking>0</MinNumberOfSpotsPerBooking>
        <MultipleResource>
          <Active>false</Active>
          <Max>0</Max>
          <Min>0</Min>
        </MultipleResource>
        <Name>String</Name>
      </Service>
      <ServiceId>0</ServiceId>
      <StatusCode>0</StatusCode>
      <StatusName>String</StatusName>
      <To>0001-01-01T00:00:00</To>
    </BookingUserQueueItemResponse>
  </BookingUserQueueResponseList>
  <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>
</GetAllBookingQueueForUserResponse>