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
StatusNameformstringNo
SendConfirmationTimeformDateTime?No
QuantitiesformList<BookingUserQueuePriceResponse>No
ServiceformServiceInfoResponseNo
CompanyformCompanyInfoResponseNo
BookingUserQueuePriceResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
IdformintNo
BookingUserQueueIdformintNo
ServicePriceIdformint?No
Quantityformint?No
ServiceInfoResponse Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
NameformstringNo
DescriptionformstringNo
ImageUrlformUriNo
LengthInMinutesformint?No
MaxNumberOfSpotsPerBookingformintNo
MinNumberOfSpotsPerBookingformintNo
GroupBookingformGroupBookingSettingsNo
MultipleResourceformMultipleResourceSettingsNo
IsGroupBookingformboolNo
IsPaymentEnabledformboolNo
GroupBookingSettings Parameters:
NameParameterData TypeRequiredDescription
ActiveformboolNo
MinformintNo
MaxformintNo
MultipleResourceSettings Parameters:
NameParameterData TypeRequiredDescription
ActiveformboolNo
MinformintNo
MaxformintNo
CompanyInfoResponse Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
NameformstringNo
LogoTypeformUriNo
CategoryformstringNo
Street1formstringNo
Street2formstringNo
ZipCodeformstringNo
CityformstringNo
CountryIdformstringNo
LongitudeformstringNo
LatitudeformstringNo
PhoneformstringNo
EmailformstringNo
HomePageformstringNo
SitePathformstringNo

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

HTTP + CSV

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