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.

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); }
}

// @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")
export class UpdateAllQuantities 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 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 Quantities: QuantityToUpdate[];

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

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

export class QuantityToUpdate
{
    /** @description Id of the quantity */
    // @ApiMember(Description="Id of the quantity", IsRequired=true)
    public Id: number;

    /** @description The quantity for booked on this price category */
    // @ApiMember(Description="The quantity for booked on this price category", IsRequired=true)
    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 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<QuantityToUpdate>) { (Object as any).assign(this, init); }
}

TypeScript UpdateAllQuantities 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 /bookings/{BookingId}/quantity/ HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length

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