| PUT | /services/{Id}/calculateprice | Calculate price on service | Calculate an price on a service. |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class CalculateTotalPriceOnService : ICompany
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
var CompanyId:UUID? = null
/**
* Id of the service
*/
@ApiMember(Description="Id of the service", IsRequired=true, ParameterType="path")
var Id:Int? = null
/**
* The price interval to be used for calculations
*/
@ApiMember(Description="The price interval to be used for calculations", IsRequired=true)
var Interval:PriceInterval? = null
/**
* Rebate codes applied to booking
*/
@ApiMember(Description="Rebate codes applied to booking")
var RebateCodeIdsWithAmount:ArrayList<RebateCodeAppliedWithAmount> = ArrayList<RebateCodeAppliedWithAmount>()
/**
* If you have selected to include the prices, here you can include the quantities to book to get the correct total price.
*/
@ApiMember(Description="If you have selected to include the prices, here you can include the quantities to book to get the correct total price.")
var Quantities:ArrayList<QuantityToBook>? = null
}
open class PriceInterval
{
/**
* The start date and time for the price to be calculated. Normally the booking start datetime.
*/
@ApiMember(Description="The start date and time for the price to be calculated. Normally the booking start datetime.", IsRequired=true)
var From:Date? = null
/**
* 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.
*/
@ApiMember(Description="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.")
var To:Date? = null
}
open class RebateCodeAppliedWithAmount
{
var Id:Int? = null
}
open class QuantityToBook
{
/**
* 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)
var PriceId:Int? = null
/**
* 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)
var Quantity:Int? = null
/**
* 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.")
var OccupiesSpot:Boolean? = null
}
open class TotalPriceInformationResponse
{
var PriceSign:String? = null
var CurrencyId:String? = null
var TotalPrice:Double? = null
var TotalVatAmount:Double? = null
var TotalPriceBeforeRebate:Double? = null
var AppliedCodes:ArrayList<AppliedRebateCodesResponse> = ArrayList<AppliedRebateCodesResponse>()
var PriceDetails:ArrayList<TotalPricePriceDetail> = ArrayList<TotalPricePriceDetail>()
}
open class AppliedRebateCodesResponse
{
var RebateCodeSign:String? = null
var RebateCodeValue:Int? = null
var RebateCodeType:RebateCodeTypeItem? = null
var RebateCodeId:Int? = null
var RebateAmount:Double? = null
}
open class RebateCodeTypeItem
{
var Id:Int? = null
var Name:String? = null
var Description:String? = null
}
open class TotalPricePriceDetail
{
var Quantity:Int? = null
var Price:Double? = null
var VatAmount:Double? = null
var Description:String? = null
}
Kotlin CalculateTotalPriceOnService 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.
PUT /services/{Id}/calculateprice HTTP/1.1
Host: testapi.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>
<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>
<RebateCodeIdsWithAmount>
<RebateCodeAppliedWithAmount>
<Id>0</Id>
</RebateCodeAppliedWithAmount>
</RebateCodeIdsWithAmount>
</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>