| GET | /bookinguserqueue/user | Get all (future) queue items for the logged in user |
|---|
import Foundation
import ServiceStack
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
public class GetAllBookingQueue : Codable
{
/**
* The user id for your profile. If not set it will set it automatically from your session
*/
// @ApiMember(Description="The user id for your profile. If not set it will set it automatically from your session")
public var userId:String?
/**
* Optional start date for the search interval. If not set it will default to todays date.
*/
// @ApiMember(DataType="dateTime", Description="Optional start date for the search interval. If not set it will default to todays date.", ParameterType="query")
public var dateStart:Date?
/**
* Optional end date for the search interval. If not set all future queue items will be returned.
*/
// @ApiMember(DataType="dateTime", Description="Optional end date for the search interval. If not set all future queue items will be returned.", ParameterType="query")
public var dateEnd:Date?
/**
* Set to true if you want to include the queue items for the company you are logged in as administrator on, if false only queue items for the logged in user will be retrieved. Only administrators are allowed to do this.
*/
// @ApiMember(DataType="boolean", Description="Set to true if you want to include the queue items for the company you are logged in as administrator on, if false only queue items for the logged in user will be retrieved. Only administrators are allowed to do this.", ParameterType="query")
public var companyQueueItems:Bool
/**
* Optional filter for a specific service id.
*/
// @ApiMember(DataType="int", Description="Optional filter for a specific service id.", ParameterType="query")
public var serviceId:Int?
/**
* Optional filter for a specific customer id.
*/
// @ApiMember(DataType="Guid", Description="Optional filter for a specific customer id.", ParameterType="query")
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
/**
* If you want to include the customer information for the booking
*/
// @ApiMember(DataType="boolean", Description="If you want to include the customer information for the booking", ParameterType="query")
public var includeCustomerInformation:Bool
/**
* Number of records to skip (for pagination)
*/
// @ApiMember(DataType="int", Description="Number of records to skip (for pagination)", ParameterType="query")
public var skip:Int?
/**
* Maximum number of records to return (for pagination)
*/
// @ApiMember(DataType="int", Description="Maximum number of records to return (for pagination)", ParameterType="query")
public var take:Int?
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: api.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}]