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 Foundation
import ServiceStack

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

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

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

    /**
    * 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")
    public var includeServiceInformation:Bool

    /**
    * 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")
    public var includeCompanyInformation: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
    public var customer:BookedCustomer

    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?
    public var price:Double?
    public var priceText:String

    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 minNumberOfSpotsPerBooking: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 sitePath:String

    required public init(){}
}

public class BookedCustomer : Codable
{
    public var id:String
    public var firstname:String
    public var lastname:String
    public var email:String
    public var phone:String
    public var facebookUserName:String
    public var imageUrl:String
    public var personalIdentityNumber:String
    public var corporateIdentityNumber:String
    public var invoiceAddress1:String
    public var invoiceAddress2:String
    public var invoiceCity:String
    public var invoicePostalCode:String
    public var invoiceCountryCode:String

    required public init(){}
}


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

GET /bookinguserqueue/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
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,
			Price: 0,
			PriceText: String
		}
	],
	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,
		SitePath: String
	},
	Customer: 
	{
		Firstname: String,
		Lastname: String,
		Email: String,
		Phone: String,
		FacebookUserName: String,
		ImageUrl: String,
		PersonalIdentityNumber: String,
		CorporateIdentityNumber: String,
		InvoiceAddress1: String,
		InvoiceAddress2: String,
		InvoiceCity: String,
		InvoicePostalCode: String,
		InvoiceCountryCode: String
	}
}