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
GetBookingUserQueue Parameters:
NameParameterData TypeRequiredDescription
IdpathintYesId of the booking user queue
CompanyIdqueryGuidYes
CustomerIdqueryGuidYes
IncludeServiceInformationquerybooleanNoIf you want to include the service information for the booking
IncludeCompanyInformationquerybooleanNoIf you want to include the company information for the booking
BookingUserQueueItemResponse Parameters:
NameParameterData TypeRequiredDescription
BookingUserQueueIdformintNo
CompanyIdformGuidNo
CustomerIdformGuidNo
ServiceIdformintNo
FromformDateTimeNo
ToformDateTimeNo
StatusCodeformintNo
StatusNameformstringYes
SendConfirmationTimeformDateTime?No
QuantitiesformList<BookingUserQueuePriceResponse>Yes
ServiceformServiceInfoResponseYes
CompanyformCompanyInfoResponseYes
CustomerformBookedCustomerYes
BookingUserQueuePriceResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
IdformintNo
BookingUserQueueIdformintNo
ServicePriceIdformint?No
Quantityformint?No
Priceformdouble?No
PriceTextformstringYes
ServiceInfoResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringYes
DescriptionformstringYes
ImageUrlformUriYes
LengthInMinutesformint?No
MaxNumberOfSpotsPerBookingformintNo
MinNumberOfSpotsPerBookingformintNo
GroupBookingformGroupBookingSettingsYes
MultipleResourceformMultipleResourceSettingsYes
IsGroupBookingformboolNo
IsPaymentEnabledformboolNo
GroupBookingSettings Parameters:
NameParameterData TypeRequiredDescription
ActiveformboolNo
MinformintNo
MaxformintNo
MultipleResourceSettings Parameters:
NameParameterData TypeRequiredDescription
ActiveformboolNo
MinformintNo
MaxformintNo
CompanyInfoResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringYes
LogoTypeformUriYes
SitePathformstringYes
BookedCustomer Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
FirstnameformstringYes
LastnameformstringYes
EmailformstringYes
PhoneformstringYes
FacebookUserNameformstringYes
ImageUrlformstringYes
PersonalIdentityNumberformstringYes
CorporateIdentityNumberformstringYes
InvoiceAddress1formstringYes
InvoiceAddress2formstringYes
InvoiceCityformstringYes
InvoicePostalCodeformstringYes
InvoiceCountryCodeformstringYes

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}