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 java.math.*
import java.util.*
import net.servicestack.client.*


open class CreateBookingUserQueue
{
    var CompanyId:UUID? = null
    var CustomerId:UUID? = null
    var Customer:CustomerToHandle? = null
    var ServiceId:Int? = null
    var From:Date? = null
    var To:Date? = null
    var Quantities:ArrayList<QuantityToBook> = ArrayList<QuantityToBook>()
}

open class CustomerToHandle
{
    var CustomerId:UUID? = null
    var Firstname:String? = null
    var Lastname:String? = null
    var Email:String? = null
    var Phone:String? = null
    var SubscribedToNewsletter:Boolean? = null
}

open class QuantityToBook
{
    /**
    * 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)
    var PriceId:Int? = null

    /**
    * 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)
    var Quantity:Int? = null

    /**
    * 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.")
    var OccupiesSpot:Boolean? = null
}

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

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

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

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

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

open class CompanyInfoResponse
{
    var Id:UUID? = null
    var Name:String? = null
    var LogoType:Uri? = null
    var Category:String? = null
    var Street1:String? = null
    var Street2:String? = null
    var ZipCode:String? = null
    var City:String? = null
    var CountryId:String? = null
    var Longitude:String? = null
    var Latitude:String? = null
    var Phone:String? = null
    var Email:String? = null
    var HomePage:String? = null
    var SitePath:String? = null
}

Kotlin CreateBookingUserQueue DTOs

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

HTTP + JSV

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

POST /bookinguserqueue HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	CustomerId: 00000000-0000-0000-0000-000000000000,
	Customer: 
	{
		CustomerId: 00000000-0000-0000-0000-000000000000,
		Firstname: String,
		Lastname: String,
		Email: String,
		Phone: String,
		SubscribedToNewsletter: False
	},
	ServiceId: 0,
	Quantities: 
	[
		{
			PriceId: 0,
			Quantity: 0,
			OccupiesSpot: False
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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