BokaMera.API.Host

<back to all web services

GetBookingUserQueue

Requires Authentication
The following routes are available for this service:
GET/bookinguserqueue/{Id}Get queue item by Id
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class GetBookingUserQueue
{
    /**
    * Id of the booking user queue
    */
    @ApiMember(Description="Id of the booking user queue", IsRequired=true, ParameterType="path")
    open var Id:Int? = null

    /**
    * 
    */
    @ApiMember(Description="", IsRequired=true)
    open var CompanyId:UUID? = null

    /**
    * 
    */
    @ApiMember(Description="", IsRequired=true)
    open var CustomerId:UUID? = null

    /**
    * If you want to include the service information for the booking
    */
    @ApiMember(DataType="boolean", Description="If you want to include the service information for the booking", ParameterType="query")
    open var IncludeServiceInformation:Boolean? = null

    /**
    * If you want to include the company information for the booking
    */
    @ApiMember(DataType="boolean", Description="If you want to include the company information for the booking", ParameterType="query")
    open var IncludeCompanyInformation:Boolean? = null
}

open class BookingUserQueueItemResponse
{
    open var BookingUserQueueId:Int? = null
    open var CompanyId:UUID? = null
    open var CustomerId:UUID? = null
    open var ServiceId:Int? = null
    open var From:Date? = null
    open var To:Date? = null
    open var StatusCode:Int? = null
    open var StatusName:String? = null
    open var SendConfirmationTime:Date? = null
    open var Quantities:ArrayList<BookingUserQueuePriceResponse> = ArrayList<BookingUserQueuePriceResponse>()
    open var Service:ServiceInfoResponse? = null
    open var Company:CompanyInfoResponse? = null
    open var Customer:BookedCustomer? = null
}

open class BookingUserQueuePriceResponse
{
    open var CompanyId:UUID? = null
    open var Id:Int? = null
    open var BookingUserQueueId:Int? = null
    open var ServicePriceId:Int? = null
    open var Quantity:Int? = null
    open var Price:Double? = null
    open var PriceText:String? = null
}

open class ServiceInfoResponse
{
    open var Id:Int? = null
    open var Name:String? = null
    open var Description:String? = null
    open var ImageUrl:Uri? = null
    open var LengthInMinutes:Int? = null
    open var MaxNumberOfSpotsPerBooking:Int? = null
    open var MinNumberOfSpotsPerBooking:Int? = null
    open var GroupBooking:GroupBookingSettings? = null
    open var MultipleResource:MultipleResourceSettings? = null
    open var IsGroupBooking:Boolean? = null
    open var IsPaymentEnabled:Boolean? = null
}

open class GroupBookingSettings
{
    open var Active:Boolean? = null
    open var Min:Int? = null
    open var Max:Int? = null
}

open class MultipleResourceSettings
{
    open var Active:Boolean? = null
    open var Min:Int? = null
    open var Max:Int? = null
}

open class CompanyInfoResponse
{
    open var Id:UUID? = null
    open var Name:String? = null
    open var LogoType:Uri? = null
    open var SitePath:String? = null
}

open class BookedCustomer
{
    open var Id:UUID? = null
    open var Firstname:String? = null
    open var Lastname:String? = null
    open var Email:String? = null
    open var Phone:String? = null
    open var FacebookUserName:String? = null
    open var ImageUrl:String? = null
    open var PersonalIdentityNumber:String? = null
    open var CorporateIdentityNumber:String? = null
    open var InvoiceAddress1:String? = null
    open var InvoiceAddress2:String? = null
    open var InvoiceCity:String? = null
    open var InvoicePostalCode:String? = null
    open var InvoiceCountryCode:String? = null
    /**
    * Tags attached to this customer.
    */
    @ApiMember(Description="Tags attached to this customer.")
    open var Tags:ArrayList<TagResponse> = ArrayList<TagResponse>()
}

open class TagResponse
{
    open var Id:Int? = null
    open var CompanyId:UUID? = null
    open var Name:String? = null
    open var Scope:Int? = null
    open var Color:String? = null
    open var SortOrder:Int? = null
    open var Active:Boolean? = null
    open var CreatedDate:Date? = null
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin GetBookingUserQueue 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/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BookingUserQueueItemResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <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>
    <Tags>
      <TagResponse>
        <Active>false</Active>
        <Color>String</Color>
        <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
        <CreatedDate>0001-01-01T00:00:00</CreatedDate>
        <Id>0</Id>
        <Name>String</Name>
        <ResponseStatus xmlns:d5p1="http://schemas.servicestack.net/types">
          <d5p1:ErrorCode>String</d5p1:ErrorCode>
          <d5p1:Message>String</d5p1:Message>
          <d5p1:StackTrace>String</d5p1:StackTrace>
          <d5p1:Errors>
            <d5p1:ResponseError>
              <d5p1:ErrorCode>String</d5p1:ErrorCode>
              <d5p1:FieldName>String</d5p1:FieldName>
              <d5p1:Message>String</d5p1:Message>
              <d5p1:Meta xmlns:d8p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
                <d8p1:KeyValueOfstringstring>
                  <d8p1:Key>String</d8p1:Key>
                  <d8p1:Value>String</d8p1:Value>
                </d8p1:KeyValueOfstringstring>
              </d5p1:Meta>
            </d5p1:ResponseError>
          </d5p1:Errors>
          <d5p1:Meta xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringstring>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value>String</d6p1:Value>
            </d6p1:KeyValueOfstringstring>
          </d5p1:Meta>
        </ResponseStatus>
        <Scope>0</Scope>
        <SortOrder>0</SortOrder>
      </TagResponse>
    </Tags>
  </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>