BokaMera.API.Host

<back to all web services

CalculateTotalPriceOnService

The following routes are available for this service:
PUT/services/{Id}/calculatepriceCalculate price on serviceCalculate 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 RebateCodeIds:ArrayList<Int> = ArrayList<Int>()

    /**
    * 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

    /**
    * 
    */
    @ApiMember(Description="")
    var CustomerEmail:String? = 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 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:RebateCodeTypeResponse? = null
    var RebateCodeId:Int? = null
    var RebateAmount:Double? = null
}

open class RebateCodeTypeResponse
{
    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 .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.

PUT /services/{Id}/calculateprice HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"Interval":{"To":"0001-01-01T00:00:00"},"RebateCodeIds":[0],"Quantities":[{"PriceId":0,"Quantity":0,"OccupiesSpot":false}],"CustomerEmail":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"PriceSign":"String","CurrencyId":"String","TotalPrice":0,"TotalVatAmount":0,"TotalPriceBeforeRebate":0,"AppliedCodes":[{"RebateCodeSign":"String","RebateCodeValue":0,"RebateCodeType":{"Id":0,"Name":"String","Description":"String"},"RebateCodeId":0,"RebateAmount":0}],"PriceDetails":[{"Quantity":0,"Price":0,"VatAmount":0,"Description":"String"}]}