BokaMera.API.Host

<back to all web services

GetAllBookingQueueForUser

Requires Authentication
The following routes are available for this service:
GET/bookinguserqueue/userGet all queue items for the logged in user
GetAllBookingQueueForUser Parameters:
NameParameterData TypeRequiredDescription
UserIdqueryGuid?NoThe user id for your profile. If not set it will set it automatically from your session
DateStartqueryDateTime?No
DateEndqueryDateTime?No
IncludeServiceInformationquerybooleanNoIf you want to include the service information for the booking
IncludeCompanyInformationquerybooleanNoIf you want to include the company information for the booking
GetAllBookingQueueForUserResponse Parameters:
NameParameterData TypeRequiredDescription
BookingUserQueueResponseListformList<BookingUserQueueItemResponse>Yes
ResponseStatusformResponseStatusYes
BookingUserQueueItemResponse Parameters:
NameParameterData TypeRequiredDescription
BookingUserQueueIdformintNo
CompanyIdformGuidNo
CustomerIdformGuidNo
ServiceIdformintNo
FromformDateTimeNo
ToformDateTimeNo
StatusCodeformintNo
StatusNameformstringYes
SendConfirmationTimeformDateTime?No
QuantitiesformList<BookingUserQueuePriceResponse>Yes
ServiceformServiceInfoResponseYes
CompanyformCompanyInfoResponseYes
BookingUserQueuePriceResponse Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
IdformintNo
BookingUserQueueIdformintNo
ServicePriceIdformint?No
Quantityformint?No
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
CategoryformstringYes
Street1formstringYes
Street2formstringYes
ZipCodeformstringYes
CityformstringYes
CountryIdformstringYes
LongitudeformstringYes
LatitudeformstringYes
PhoneformstringYes
EmailformstringYes
HomePageformstringYes
SitePathformstringYes

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/user HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"BookingUserQueueResponseList":[{"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"}}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}