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.

export class BookedQuantity
{
    /** @description The quantity Id */
    // @ApiMember(Description="The quantity Id")
    public Id: number;

    /** @description The quantity for booked on this price category */
    // @ApiMember(Description="The quantity for booked on this price category")
    public Quantity: number;

    /** @description The price */
    // @ApiMember(Description="The price")
    public Price?: number;

    /** @description The price bofore rebate codes */
    // @ApiMember(Description="The price bofore rebate codes")
    public PriceBeforeRebate?: number;

    /** @description The price currency */
    // @ApiMember(Description="The price currency")
    public CurrencyId: string;

    /** @description The price sign */
    // @ApiMember(Description="The price sign")
    public PriceSign: string;

    /** @description The price category */
    // @ApiMember(Description="The price category")
    public Category: string;

    /** @description The price VAT in percent */
    // @ApiMember(Description="The price VAT in percent")
    public VAT?: number;

    /** @description The price text to display */
    // @ApiMember(Description="The price text to display")
    public PriceText: string;

    /** @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. */
    // @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 OccupiesSpot: boolean;

    public constructor(init?: Partial<BookedQuantity>) { (Object as any).assign(this, init); }
}

// @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)
export class UpdateQuantity implements ICompany
{
    /** @description 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 CompanyId?: string;

    /** @description Id of the booking */
    // @ApiMember(Description="Id of the booking", IsRequired=true, ParameterType="path")
    public BookingId: number;

    /** @description Id of the quantity */
    // @ApiMember(Description="Id of the quantity", IsRequired=true, ParameterType="path")
    public Id: number;

    /** @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. */
    // @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 OccupiesSpot?: boolean;

    /** @description The quantity for booked on this price category */
    // @ApiMember(Description="The quantity for booked on this price category")
    public Quantity: number;

    /** @description The price */
    // @ApiMember(Description="The price")
    public Price?: number;

    /** @description The price currency */
    // @ApiMember(Description="The price currency")
    public CurrencyId: string;

    /** @description The price category */
    // @ApiMember(Description="The price category")
    public Category: string;

    /** @description The price VAT in percent */
    // @ApiMember(Description="The price VAT in percent")
    public VAT?: number;

    /** @description Any comments to be stored in the event log. */
    // @ApiMember(Description="Any comments to be stored in the event log.")
    public Comments: string;

    /** @description 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")
    public Refund: boolean;

    public constructor(init?: Partial<UpdateQuantity>) { (Object as any).assign(this, init); }
}

TypeScript 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
}