| PUT | /services/{Id}/calculateprice | Calculate price on service | Calculate an price on a service. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| CompanyId | body | Guid? | No | The company id, if empty will use the company id for the user you are logged in with. |
| Id | path | int | Yes | Id of the service |
| Interval | body | PriceInterval | Yes | The price interval to be used for calculations |
| RebateCodeIds | body | List<int> | Yes | Rebate codes applied to booking |
| Quantities | body | QuantityToBook[] | Yes | If you have selected to include the prices, here you can include the quantities to book to get the correct total price. |
| CustomerEmail | body | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| From | form | DateTime | Yes | The start date and time for the price to be calculated. Normally the booking start datetime. |
| To | form | DateTime? | No | The end date and time for the price to be calculated.Normally the booking end datetime. If nothing entered it will use the service length. |
| 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. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PriceSign | form | string | Yes | |
| CurrencyId | form | string | Yes | |
| TotalPrice | form | double | No | |
| TotalVatAmount | form | double | No | |
| TotalPriceBeforeRebate | form | double | No | |
| AppliedCodes | form | List<AppliedRebateCodesResponse> | Yes | |
| PriceDetails | form | List<TotalPricePriceDetail> | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RebateCodeSign | form | string | Yes | |
| RebateCodeValue | form | int | No | |
| RebateCodeType | form | RebateCodeTypeResponse | Yes | |
| RebateCodeId | form | int | No | |
| RebateAmount | form | double | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | int | No | |
| Name | form | string | Yes | |
| Description | form | string | Yes |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Quantity | form | int | No | |
| Price | form | double | No | |
| VatAmount | form | double | No | |
| Description | form | string | Yes |
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.
PUT /services/{Id}/calculateprice HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CalculateTotalPriceOnService 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>
<CustomerEmail>String</CustomerEmail>
<Id>0</Id>
<Interval>
<From>0001-01-01T00:00:00</From>
<To>0001-01-01T00:00:00</To>
</Interval>
<Quantities>
<QuantityToBook>
<OccupiesSpot>false</OccupiesSpot>
<PriceId>0</PriceId>
<Quantity>0</Quantity>
</QuantityToBook>
</Quantities>
<RebateCodeIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</RebateCodeIds>
</CalculateTotalPriceOnService>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<TotalPriceInformationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<AppliedCodes>
<AppliedRebateCodesResponse>
<RebateAmount>0</RebateAmount>
<RebateCodeId>0</RebateCodeId>
<RebateCodeSign>String</RebateCodeSign>
<RebateCodeType>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</RebateCodeType>
<RebateCodeValue>0</RebateCodeValue>
</AppliedRebateCodesResponse>
</AppliedCodes>
<CurrencyId>String</CurrencyId>
<PriceDetails>
<TotalPricePriceDetail>
<Description>String</Description>
<Price>0</Price>
<Quantity>0</Quantity>
<VatAmount>0</VatAmount>
</TotalPricePriceDetail>
</PriceDetails>
<PriceSign>String</PriceSign>
<TotalPrice>0</TotalPrice>
<TotalPriceBeforeRebate>0</TotalPriceBeforeRebate>
<TotalVatAmount>0</TotalVatAmount>
</TotalPriceInformationResponse>