BokaMera.API.Host

<back to all web services

UpdateAllQuantities

Requires Authentication
The following routes are available for this service:
PUT/bookings/{BookingId}/quantity/Update all quantities on a booking. Note: all quantity needs to be added, all existing quantities on the booking will be deletedUpdate all quantities on a booking. You will need to provide all quantities in this call to be added/updated. Note: all quantity needs to be added, all existing quantities on the booking will be deleted.
import Foundation
import ServiceStack

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ApiResponse(Description="You have too low privileges to call this service", StatusCode=403)
// @ValidateRequest(Validator="IsAuthenticated")
public class UpdateAllQuantities : ICompany, Codable
{
    /**
    * 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.")
    public var companyId:String?

    /**
    * Id of the booking
    */
    // @ApiMember(Description="Id of the booking", IsRequired=true, ParameterType="path")
    public var bookingId:Int

    /**
    * Set the number of spots you want to book. You add number of spots per price category. Multiple spots require that the service has GroupBooking enabled. Default is one spot.
    */
    // @ApiMember(Description="Set the number of spots you want to book. You add number of spots per price category. Multiple spots require that the service has GroupBooking enabled. Default is one spot.")
    public var quantities:[QuantityToUpdate] = []

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

    required public init(){}
}

public class QuantityToUpdate : Codable
{
    /**
    * Id of the quantity
    */
    // @ApiMember(Description="Id of the quantity", IsRequired=true)
    public var id:Int?

    /**
    * The quantity for booked on this price category
    */
    // @ApiMember(Description="The quantity for booked on this price category", IsRequired=true)
    public var quantity:Int?

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

    /**
    * The price currency
    */
    // @ApiMember(Description="The price currency")
    public var currencyId:String

    /**
    * The price category
    */
    // @ApiMember(Description="The price category")
    public var category:String

    /**
    * The price VAT in percent
    */
    // @ApiMember(Description="The price VAT in percent")
    public var vat:Double?

    /**
    * 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.")
    public var occupiesSpot:Bool?

    required public init(){}
}

public class BookedQuantity : Codable
{
    /**
    * The quantity Id
    */
    // @ApiMember(Description="The quantity Id")
    public var id:Int

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

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

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

    /**
    * The price currency
    */
    // @ApiMember(Description="The price currency")
    public var currencyId:String

    /**
    * The price sign
    */
    // @ApiMember(Description="The price sign")
    public var priceSign:String

    /**
    * The price category
    */
    // @ApiMember(Description="The price category")
    public var category:String

    /**
    * The price VAT in percent
    */
    // @ApiMember(Description="The price VAT in percent")
    public var vat:Double?

    /**
    * The price text to display
    */
    // @ApiMember(Description="The price text to display")
    public var priceText:String

    /**
    * 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.")
    public var occupiesSpot:Bool

    required public init(){}
}


Swift UpdateAllQuantities 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/ HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	BookingId: 0,
	Quantities: 
	[
		{
			Id: 0,
			Quantity: 0,
			Price: 0,
			CurrencyId: String,
			Category: String,
			VAT: 0,
			OccupiesSpot: False
		}
	],
	Comments: String
}
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
}