| 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 .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<CreateBookingUserQueue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Customer>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<Email>String</Email>
<Firstname>String</Firstname>
<Lastname>String</Lastname>
<Phone>String</Phone>
<SubscribedToNewsletter>false</SubscribedToNewsletter>
</Customer>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<From>0001-01-01T00:00:00</From>
<Quantities>
<QuantityToBook>
<OccupiesSpot>false</OccupiesSpot>
<PriceId>0</PriceId>
<Quantity>0</Quantity>
</QuantityToBook>
</Quantities>
<ServiceId>0</ServiceId>
<To>0001-01-01T00:00:00</To>
</CreateBookingUserQueue>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<BookingUserQueueItemResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<BookingUserQueueId>0</BookingUserQueueId>
<Company>
<Category>String</Category>
<City>String</City>
<CountryId>String</CountryId>
<Email>String</Email>
<HomePage>String</HomePage>
<Id>00000000-0000-0000-0000-000000000000</Id>
<Latitude>String</Latitude>
<LogoType i:nil="true" />
<Longitude>String</Longitude>
<Name>String</Name>
<Phone>String</Phone>
<SitePath>String</SitePath>
<Street1>String</Street1>
<Street2>String</Street2>
<ZipCode>String</ZipCode>
</Company>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<From>0001-01-01T00:00:00</From>
<Quantities>
<BookingUserQueuePriceResponse>
<BookingUserQueueId>0</BookingUserQueueId>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Id>0</Id>
<Quantity>0</Quantity>
<ServicePriceId>0</ServicePriceId>
</BookingUserQueuePriceResponse>
</Quantities>
<SendConfirmationTime>0001-01-01T00:00:00</SendConfirmationTime>
<Service>
<Description>String</Description>
<GroupBooking>
<Active>false</Active>
<Max>0</Max>
<Min>0</Min>
</GroupBooking>
<Id>0</Id>
<ImageUrl i:nil="true" />
<IsGroupBooking>false</IsGroupBooking>
<IsPaymentEnabled>false</IsPaymentEnabled>
<LengthInMinutes>0</LengthInMinutes>
<MaxNumberOfSpotsPerBooking>0</MaxNumberOfSpotsPerBooking>
<MinNumberOfSpotsPerBooking>0</MinNumberOfSpotsPerBooking>
<MultipleResource>
<Active>false</Active>
<Max>0</Max>
<Min>0</Min>
</MultipleResource>
<Name>String</Name>
</Service>
<ServiceId>0</ServiceId>
<StatusCode>0</StatusCode>
<StatusName>String</StatusName>
<To>0001-01-01T00:00:00</To>
</BookingUserQueueItemResponse>