BokaMera.API.Host

<back to all web services

UpdateQuantity

Requires Authentication
The following routes are available for this service:
PUT/bookings/{BookingId}/quantity/{Id}Update an existing booking quantityUpdates an existing booking quantity if you are authorized to do so. Note: Updating quantity wont updated the number of booked resources.
import java.math.*
import java.util.*
import net.servicestack.client.*


@ValidateRequest(Validator="IsAuthenticated")
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
open class UpdateQuantity : 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 booking
    */
    @ApiMember(Description="Id of the booking", IsRequired=true, ParameterType="path")
    var BookingId:Int? = null

    /**
    * Id of the quantity
    */
    @ApiMember(Description="Id of the quantity", IsRequired=true, ParameterType="path")
    var Id: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

    /**
    * The quantity for booked on this price category
    */
    @ApiMember(Description="The quantity for booked on this price category")
    var Quantity:Int? = null

    /**
    * The price
    */
    @ApiMember(Description="The price")
    var Price:Double? = null

    /**
    * The price currency
    */
    @ApiMember(Description="The price currency")
    var CurrencyId:String? = null

    /**
    * The price category
    */
    @ApiMember(Description="The price category")
    var Category:String? = null

    /**
    * The price VAT in percent
    */
    @ApiMember(Description="The price VAT in percent")
    var VAT:BigDecimal? = null

    /**
    * Any comments to be stored in the event log.
    */
    @ApiMember(Description="Any comments to be stored in the event log.")
    var Comments:String? = null

    /**
    * If you want the amount to be refunded automatically if amount is lower than paid
    */
    @ApiMember(Description="If you want the amount to be refunded automatically if amount is lower than paid")
    var Refund:Boolean? = null
}

open class BookedQuantity
{
    /**
    * The quantity Id
    */
    @ApiMember(Description="The quantity Id")
    var Id:Int? = null

    /**
    * The quantity for booked on this price category
    */
    @ApiMember(Description="The quantity for booked on this price category")
    var Quantity:Int? = null

    /**
    * The price
    */
    @ApiMember(Description="The price")
    var Price:Double? = null

    /**
    * The price bofore rebate codes
    */
    @ApiMember(Description="The price bofore rebate codes")
    var PriceBeforeRebate:Double? = null

    /**
    * The price currency
    */
    @ApiMember(Description="The price currency")
    var CurrencyId:String? = null

    /**
    * The price sign
    */
    @ApiMember(Description="The price sign")
    var PriceSign:String? = null

    /**
    * The price category
    */
    @ApiMember(Description="The price category")
    var Category:String? = null

    /**
    * The price VAT in percent
    */
    @ApiMember(Description="The price VAT in percent")
    var VAT:BigDecimal? = null

    /**
    * The price text to display
    */
    @ApiMember(Description="The price text to display")
    var PriceText:String? = 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
}

Kotlin UpdateQuantity DTOs

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

HTTP + JSV

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

PUT /bookings/{BookingId}/quantity/{Id} HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	BookingId: 0,
	Id: 0,
	OccupiesSpot: False,
	Quantity: 0,
	Price: 0,
	CurrencyId: String,
	Category: String,
	VAT: 0,
	Comments: String,
	Refund: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Quantity: 0,
	Price: 0,
	PriceBeforeRebate: 0,
	CurrencyId: String,
	PriceSign: String,
	Category: String,
	VAT: 0,
	PriceText: String,
	OccupiesSpot: False
}