POST | /bookinguserqueue | Join user to the booking queue |
---|
export class BookingUserQueuePriceResponse
{
public CompanyId: string;
public Id: number;
public BookingUserQueueId: number;
public ServicePriceId?: number;
public Quantity?: number;
public constructor(init?: Partial<BookingUserQueuePriceResponse>) { (Object as any).assign(this, init); }
}
export class GroupBookingSettings
{
public Active: boolean;
public Min: number;
public Max: number;
public constructor(init?: Partial<GroupBookingSettings>) { (Object as any).assign(this, init); }
}
export class MultipleResourceSettings
{
public Active: boolean;
public Min: number;
public Max: number;
public constructor(init?: Partial<MultipleResourceSettings>) { (Object as any).assign(this, init); }
}
export class ServiceInfoResponse
{
public Id: number;
public Name: string;
public Description: string;
public ImageUrl: string;
public LengthInMinutes?: number;
public MaxNumberOfSpotsPerBooking: number;
public MinNumberOfSpotsPerBooking: number;
public GroupBooking: GroupBookingSettings;
public MultipleResource: MultipleResourceSettings;
public IsGroupBooking: boolean;
public IsPaymentEnabled: boolean;
public constructor(init?: Partial<ServiceInfoResponse>) { (Object as any).assign(this, init); }
}
export class CompanyInfoResponse
{
public Id: string;
public Name: string;
public LogoType: string;
public Category: string;
public Street1: string;
public Street2: string;
public ZipCode: string;
public City: string;
public CountryId: string;
public Longitude: string;
public Latitude: string;
public Phone: string;
public Email: string;
public HomePage: string;
public SitePath: string;
public constructor(init?: Partial<CompanyInfoResponse>) { (Object as any).assign(this, init); }
}
export class BookingUserQueueItemResponse
{
public BookingUserQueueId: number;
public CompanyId: string;
public CustomerId: string;
public ServiceId: number;
public From: string;
public To: string;
public StatusCode: number;
public StatusName: string;
public SendConfirmationTime?: string;
public Quantities: BookingUserQueuePriceResponse[];
public Service: ServiceInfoResponse;
public Company: CompanyInfoResponse;
public constructor(init?: Partial<BookingUserQueueItemResponse>) { (Object as any).assign(this, init); }
}
export class CustomerToHandle
{
public CustomerId?: string;
public Firstname: string;
public Lastname: string;
public Email: string;
public Phone: string;
public SubscribedToNewsletter: boolean;
public constructor(init?: Partial<CustomerToHandle>) { (Object as any).assign(this, init); }
}
export class QuantityToBook
{
/** @description If service has a price, enter the price id for that price. If no price exists for the service set 0 as PriceId. If you put 0 and a price exists, it will use that price (only works if just one price exists for the current selected date to book) */
// @ApiMember(Description="If service has a price, enter the price id for that price. If no price exists for the service set 0 as PriceId. If you put 0 and a price exists, it will use that price (only works if just one price exists for the current selected date to book)", IsRequired=true)
public PriceId: number;
/** @description Set the number of spots or resources you want to book on the specific price category */
// @ApiMember(Description="Set the number of spots or resources you want to book on the specific price category", IsRequired=true)
public Quantity: number;
/** @description If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information. */
// @ApiMember(Description="If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information.")
public OccupiesSpot: boolean;
public constructor(init?: Partial<QuantityToBook>) { (Object as any).assign(this, init); }
}
export class CreateBookingUserQueue
{
public CompanyId?: string;
public CustomerId?: string;
public Customer: CustomerToHandle;
public ServiceId: number;
public From: string;
public To: string;
public Quantities: QuantityToBook[];
public constructor(init?: Partial<CreateBookingUserQueue>) { (Object as any).assign(this, init); }
}
TypeScript CreateBookingUserQueue DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /bookinguserqueue HTTP/1.1
Host: api.bokamera.se
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
CustomerId: 00000000-0000-0000-0000-000000000000,
Customer:
{
CustomerId: 00000000-0000-0000-0000-000000000000,
Firstname: String,
Lastname: String,
Email: String,
Phone: String,
SubscribedToNewsletter: False
},
ServiceId: 0,
Quantities:
[
{
PriceId: 0,
Quantity: 0,
OccupiesSpot: False
}
]
}
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 } ], 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 } }