BokaMera.API.Host

GetAllBookingQueueForUser

The following routes are available for this service:
GET	/bookinguserqueue/user	Get all (future) queue items for the logged in user

"use strict";
export class GetAllBookingQueueForUser {
    /** @param {{UserId?:string,DateStart?:string,DateEnd?:string,CompanyQueueItems?:boolean,ServiceId?:number,CustomerId?:string,IncludeServiceInformation?:boolean,IncludeCompanyInformation?:boolean,IncludeCustomerInformation?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The user id for your profile. If not set it will set it automatically from your session */
    UserId;
    /**
     * @type {?string}
     * @description Optional start date for the search interval. If not set it will default to todays date. */
    DateStart;
    /**
     * @type {?string}
     * @description Optional end date for the search interval. If not set all future queue items will be returned. */
    DateEnd;
    /**
     * @type {boolean}
     * @description Set to true if you want to include the queue items for the company you are logged in as administrator on, if false only queue items for the logged in user will be retrieved. Only administrators are allowed to do this. */
    CompanyQueueItems;
    /**
     * @type {?number}
     * @description Optional filter for a specific service id. */
    ServiceId;
    /**
     * @type {?string}
     * @description Optional filter for a specific customer id. */
    CustomerId;
    /**
     * @type {boolean}
     * @description If you want to include the service information for the booking */
    IncludeServiceInformation;
    /**
     * @type {boolean}
     * @description If you want to include the company information for the booking */
    IncludeCompanyInformation;
    /**
     * @type {boolean}
     * @description If you want to include the customer information for the booking */
    IncludeCustomerInformation;
}

JavaScript GetAllBookingQueueForUser 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/user HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml

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

<ArrayOfBookingUserQueueItemResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingUserQueueItemResponse>
    <BookingUserQueueId>0</BookingUserQueueId>
    <Company>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <LogoType i:nil="true" />
      <Name>String</Name>
      <SitePath>String</SitePath>
    </Company>
    <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
    <Customer>
      <CorporateIdentityNumber>String</CorporateIdentityNumber>
      <Email>String</Email>
      <FacebookUserName>String</FacebookUserName>
      <Firstname>String</Firstname>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <ImageUrl>String</ImageUrl>
      <InvoiceAddress1>String</InvoiceAddress1>
      <InvoiceAddress2>String</InvoiceAddress2>
      <InvoiceCity>String</InvoiceCity>
      <InvoiceCountryCode>String</InvoiceCountryCode>
      <InvoicePostalCode>String</InvoicePostalCode>
      <Lastname>String</Lastname>
      <PersonalIdentityNumber>String</PersonalIdentityNumber>
      <Phone>String</Phone>
    </Customer>
    <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>
        <Price>0</Price>
        <PriceText>String</PriceText>
        <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>
</ArrayOfBookingUserQueueItemResponse>