BokaMera.API.Host

CreateBookingReservation

The following routes are available for this service:
POST	/bookingreservations	Create a booking reservation (hold a slot)	Creates a reservation that holds the selected slot while the customer completes the booking flow. No booking is created yet. Only ServiceId, From and To are required so a bare "clicked a time" call works.

**CreateBookingReservation** Parameters:
Name	Parameter	Data Type	Required	Description
From	body	DateTime	Yes	The datetime you want to start the reservation.
To	body	DateTime	Yes	The datetime you want to end the reservation.
Quantities	body	QuantityToBook[]	Yes	Set the number of spots you want to reserve. You add number of spots per price category. Multiple spots require that the service has GroupBooking enabled. Default is one spot.

**CreateBookingBase** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	form	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
CustomerId	form	Guid?	No	If you want to book on an existing customer instead of CustomerToBook info set the CustomerId here. Set Empty Guid (00000000-0000-0000-0000-000000000000) if you want to book without any customer, this is only allowed by admin. The customer id is shown in the customer list named as id. When booking as customer (no admin) leave this field blank.
PinCode	form	string	Yes	If company requires to be authenticated or a pin code entered to book on a specific customer, enter it here.
Customer	form	CustomerToHandle	Yes	If you want to book with customer information instead of the Customer Id send the customer information here. Note: If customer profile already exists with the same email the information will not be changed, instead the provided information will be added as BookingsComments if it differs from the ordinary profile.
InvoiceAddress	form	InvoiceAddressToHandle	Yes	If you want to book with customer information instead of the Customer Id send the customer information here. Note: If customer profile already exists with the same email the information will not be changed, instead the provided information will be added as BookingsComments if it differs from the ordinary profile.
ServiceId	form	int	Yes	The service to be booked
BookedComments	form	string	Yes	If you want to add comments to a booking you can add them here, this comments are never shared with the customer
CommentsToCustomer	form	string	Yes	If you want to add comments to the booking that is sent to the customer, you can add them here. Comments will be sent in the booking confirmation
Resources	form	List<ResourceToBook>	Yes
RebateCodeIds	form	List<int>	No	Rebate codes applied to booking
Articles	form	ArticleToCreateBase[]	Yes	Article ids that should be booked with the service. The articles must be of type ServiceAddonArticle and connected to the service.
SendEmailReminder	form	bool?	No	If you want to send Email reminder
SendSmsReminder	form	bool?	No	If you want to send SMS reminder
SendSmsConfirmation	form	bool?	No	If you want to send SMS confirmation
SendEmailConfirmation	form	bool?	No	Only admins are allowed to not send an email confirmation. Default is true
PaymentOption	form	PaymentOptions	No	If payment is enabled and you're an administrator, optional to choose payment option, if empty then the default settings will be used. Following payment options exists. DefaultSetting = 0, BookWithoutPayment = 1 (will be direcyly booked without payment), BookWithPaymentMessageToCustomer = 2 (will set status AwaitingPayment and send payment instructions to customer), BookWithManualPayment = 3 (Will set status AwaitingPaymentNoTimeLimit and Admin will need to manually mark the booking as payed when recieved payment).
CustomFields	form	List<AddCustomField>	Yes	If Custom Fields are added to the booking, here you will send the id and the value for each custom field to be saved
CustomerCustomFields	form	List<AddCustomField>	Yes	If Custom Fields are added to the customer, here you will send the id and the value for each custom field to be updated
AllowBookingOutsideSchedules	form	bool	No	If want to allow to book outside the service schedules. This means you can book a time after the schedule opening hours as long as the resource are available. This is only allowed by administrators
TagIds	form	List<int>	Yes	Ids of tags to attach to the booking at creation time. Tags must have Scope = Booking and belong to the company.

**CustomerBase** Parameters:
Name	Parameter	Data Type	Required
CustomerId	form	Guid?	No
Firstname	form	string	Yes
Lastname	form	string	Yes
Email	form	string	Yes
Phone	form	string	Yes
SubscribedToNewsletter	form	bool	No
PersonalIdentityNumber	form	string	Yes

**InvoiceAddressToHandle** Parameters:
Name	Parameter	Data Type	Required
CorporateIdentityNumber	form	string	Yes
InvoiceAddress1	form	string	Yes
InvoiceAddress2	form	string	Yes
InvoiceCity	form	string	Yes
InvoicePostalCode	form	string	Yes
InvoiceCountryCode	form	string	Yes

**ResourceToBook** Parameters:
Name	Parameter	Data Type	Required	Description
ResourceTypeId	form	int	No
ResourceId	form	int	No

**ArticleToCreateBase** Parameters:
Name	Parameter	Data Type	Required	Description
ArticleId	form	int	No
Quantity	form	int	No

**PaymentOptions** Enum:
DefaultSetting
BookWithoutPayment
BookWithPaymentMessageToCustomer
BookWithManualPayment

**AddCustomField** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
Value	form	string	Yes

**QuantityToBook** Parameters:
Name	Parameter	Data Type	Required	Description
PriceId	form	int	Yes	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)
Quantity	form	int	Yes	Set the number of spots or resources you want to book on the specific price category
OccupiesSpot	form	bool	No	If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information.

**BookingReservationResponse** Parameters:
Name	Parameter	Data Type	Required	Description
SessionKey	form	Guid	No	The opaque session key that identifies the reservation.
CompanyId	form	Guid	No	The company id.
ServiceId	form	int	No	The reserved service id.
From	form	DateTime	No	The reservation start.
To	form	DateTime	No	The reservation end.
StatusCode	form	int	No	The BookingReservationStatus value.
StatusName	form	string	Yes	The BookingReservationStatus name.
ExpirationDatetime	form	DateTime	No	When the hold expires (company-local time).
NumberOfBookedSpots	form	int	No	Number of reserved spots.
Price	form	decimal?	No	The computed price of the reservation, if any.
CurrencyId	form	string	Yes	The currency of the price, if any.
ResourceIds	form	List<int>	Yes	Ids of the resources held by the reservation.
SelectionPayload	form	string	Yes	The full in-progress selection payload (wizard/session state) as JSON.
ResponseStatus	form	ResponseStatus	Yes

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /bookingreservations HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Quantities":[{"PriceId":0,"Quantity":0,"OccupiesSpot":false}],"CompanyId":"00000000-0000-0000-0000-000000000000","CustomerId":"00000000-0000-0000-0000-000000000000","PinCode":"String","Customer":{"CustomerId":"00000000-0000-0000-0000-000000000000","Firstname":"String","Lastname":"String","Email":"String","Phone":"String","SubscribedToNewsletter":false,"PersonalIdentityNumber":"String"},"InvoiceAddress":{"CorporateIdentityNumber":"String","InvoiceAddress1":"String","InvoiceAddress2":"String","InvoiceCity":"String","InvoicePostalCode":"String","InvoiceCountryCode":"String"},"ServiceId":0,"BookedComments":"String","CommentsToCustomer":"String","Resources":[{"ResourceTypeId":0,"ResourceId":0}],"RebateCodeIds":[0],"Articles":[{"ArticleId":0,"Quantity":0}],"SendEmailReminder":false,"SendSmsReminder":false,"SendSmsConfirmation":false,"SendEmailConfirmation":false,"PaymentOption":"DefaultSetting","CustomFields":[{"Id":0,"Value":"String"}],"CustomerCustomFields":[{"Id":0,"Value":"String"}],"AllowBookingOutsideSchedules":false,"TagIds":[0]}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ServiceId":0,"StatusCode":0,"StatusName":"String","NumberOfBookedSpots":0,"Price":0,"CurrencyId":"String","ResourceIds":[0],"SelectionPayload":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}