BokaMera.API.Host

<back to all web services

GetAllBookingQueue

Requires Authentication
The following routes are available for this service:
GET/bookinguserqueue/userGet all (future) queue items for the logged in user
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    @ValidateRequest(Validator="IsAuthenticated")
    public static class GetAllBookingQueue
    {
        /**
        * 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 UUID UserId = null;

        /**
        * 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 Date DateStart = null;

        /**
        * 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 Date DateEnd = null;

        /**
        * 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 Boolean CompanyQueueItems = null;

        /**
        * Optional filter for a specific service id.
        */
        @ApiMember(DataType="int", Description="Optional filter for a specific service id.", ParameterType="query")
        public Integer ServiceId = null;

        /**
        * Optional filter for a specific customer id.
        */
        @ApiMember(DataType="Guid", Description="Optional filter for a specific customer id.", ParameterType="query")
        public UUID CustomerId = null;

        /**
        * 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 Boolean IncludeServiceInformation = null;

        /**
        * 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 Boolean IncludeCompanyInformation = null;

        /**
        * 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 Boolean IncludeCustomerInformation = null;

        /**
        * Number of records to skip (for pagination)
        */
        @ApiMember(DataType="int", Description="Number of records to skip (for pagination)", ParameterType="query")
        public Integer Skip = null;

        /**
        * Maximum number of records to return (for pagination)
        */
        @ApiMember(DataType="int", Description="Maximum number of records to return (for pagination)", ParameterType="query")
        public Integer Take = null;
        
        public UUID getUserId() { return UserId; }
        public GetAllBookingQueue setUserId(UUID value) { this.UserId = value; return this; }
        public Date getDateStart() { return DateStart; }
        public GetAllBookingQueue setDateStart(Date value) { this.DateStart = value; return this; }
        public Date getDateEnd() { return DateEnd; }
        public GetAllBookingQueue setDateEnd(Date value) { this.DateEnd = value; return this; }
        public Boolean isCompanyQueueItems() { return CompanyQueueItems; }
        public GetAllBookingQueue setCompanyQueueItems(Boolean value) { this.CompanyQueueItems = value; return this; }
        public Integer getServiceId() { return ServiceId; }
        public GetAllBookingQueue setServiceId(Integer value) { this.ServiceId = value; return this; }
        public UUID getCustomerId() { return CustomerId; }
        public GetAllBookingQueue setCustomerId(UUID value) { this.CustomerId = value; return this; }
        public Boolean isIncludeServiceInformation() { return IncludeServiceInformation; }
        public GetAllBookingQueue setIncludeServiceInformation(Boolean value) { this.IncludeServiceInformation = value; return this; }
        public Boolean isIncludeCompanyInformation() { return IncludeCompanyInformation; }
        public GetAllBookingQueue setIncludeCompanyInformation(Boolean value) { this.IncludeCompanyInformation = value; return this; }
        public Boolean isIncludeCustomerInformation() { return IncludeCustomerInformation; }
        public GetAllBookingQueue setIncludeCustomerInformation(Boolean value) { this.IncludeCustomerInformation = value; return this; }
        public Integer getSkip() { return Skip; }
        public GetAllBookingQueue setSkip(Integer value) { this.Skip = value; return this; }
        public Integer getTake() { return Take; }
        public GetAllBookingQueue setTake(Integer value) { this.Take = value; return this; }
    }

}

Java GetAllBookingQueue 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/user 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
		}
	}
]