BokaMera.API.Host

<back to all web services

CreateBookingUserQueue

The following routes are available for this service:
POST/bookinguserqueueJoin user to the booking queue
import Foundation
import ServiceStack

public class CreateBookingUserQueue : Codable
{
    public var companyId:String?
    public var customerId:String?
    public var customer:CustomerToBook
    public var serviceId:Int
    public var from:Date
    public var to:Date
    public var quantities:[QuantityToBook] = []

    required public init(){}
}

public class CustomerToBook : Codable
{
    /**
    * Customers firstname
    */
    // @ApiMember(Description="Customers firstname", IsRequired=true)
    public var firstname:String

    /**
    * Customers lastname
    */
    // @ApiMember(Description="Customers lastname", IsRequired=true)
    public var lastname:String

    /**
    * Customers email
    */
    // @ApiMember(Description="Customers email", IsRequired=true)
    public var email:String

    /**
    * Customers phone number. Mobile phone number is required for SMS messages to be sent.
    */
    // @ApiMember(Description="Customers phone number. Mobile phone number is required for SMS messages to be sent.", IsRequired=true)
    public var phone:String

    required public init(){}
}

public class QuantityToBook : Codable
{
    /**
    * If service has a price, enter the price id for that price. If no price exists for the service set 0 as PriceId. If you put 0 and a price exists, it will use that price (only works if just one price exists for the current selected date to book)
    */
    // @ApiMember(Description="If service has a price, enter the price id for that price. If no price exists for the service set 0 as PriceId. If you put 0 and a price exists, it will use that price (only works if just one price exists for the current selected date to book)", IsRequired=true)
    public var priceId:Int

    /**
    * Set the number of spots or resources you want to book on the specific price category
    */
    // @ApiMember(Description="Set the number of spots or resources you want to book on the specific price category", IsRequired=true)
    public var quantity:Int

    /**
    * If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information.
    */
    // @ApiMember(Description="If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information.")
    public var occupiesSpot:Bool

    required public init(){}
}

public class BookingUserQueueItemResponse : Codable
{
    public var bookingUserQueueId:Int
    public var companyId:String
    public var customerId:String
    public var serviceId:Int
    public var from:Date
    public var to:Date
    public var statusCode:Int
    public var statusName:String
    public var sendConfirmationTime:Date?
    public var quantities:[BookingUserQueuePriceResponse] = []
    public var service:ServiceInfoResponse
    public var company:CompanyInfoResponse

    required public init(){}
}

public class BookingUserQueuePriceResponse : Codable
{
    public var companyId:String
    public var id:Int
    public var bookingUserQueueId:Int
    public var servicePriceId:Int?
    public var quantity:Int?

    required public init(){}
}

public class ServiceInfoResponse : Codable
{
    public var id:Int
    public var name:String
    public var Description:String
    public var imageUrl:Uri
    public var lengthInMinutes:Int?
    public var maxNumberOfSpotsPerBooking:Int
    public var groupBooking:GroupBookingSettings
    public var multipleResource:MultipleResourceSettings
    public var isGroupBooking:Bool
    public var isPaymentEnabled:Bool

    required public init(){}
}

public class GroupBookingSettings : Codable
{
    public var active:Bool
    public var min:Int
    public var max:Int

    required public init(){}
}

public class MultipleResourceSettings : Codable
{
    public var active:Bool
    public var min:Int
    public var max:Int

    required public init(){}
}

public class CompanyInfoResponse : Codable
{
    public var id:String
    public var name:String
    public var logoType:Uri
    public var category:String
    public var street1:String
    public var street2:String
    public var zipCode:String
    public var city:String
    public var countryId:String
    public var longitude:String
    public var latitude:String
    public var phone:String
    public var email:String
    public var homePage:String
    public var sitePath:String

    required public init(){}
}

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

POST /bookinguserqueue HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateBookingUserQueue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Customer>
    <Email>String</Email>
    <Firstname>String</Firstname>
    <Lastname>String</Lastname>
    <Phone>String</Phone>
  </Customer>
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <From>0001-01-01T00:00:00</From>
  <Quantities>
    <QuantityToBook>
      <OccupiesSpot>false</OccupiesSpot>
      <PriceId>0</PriceId>
      <Quantity>0</Quantity>
    </QuantityToBook>
  </Quantities>
  <ServiceId>0</ServiceId>
  <To>0001-01-01T00:00:00</To>
</CreateBookingUserQueue>

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