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.
"use strict";
export class BookedQuantity {
    /** @param {{Id?:number,Quantity?:number,Price?:number,PriceBeforeRebate?:number,CurrencyId?:string,PriceSign?:string,Category?:string,VAT?:number,PriceText?:string,OccupiesSpot?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {number}
     * @description The quantity Id */
    Id;
    /**
     * @type {number}
     * @description The quantity for booked on this price category */
    Quantity;
    /**
     * @type {?number}
     * @description The price */
    Price;
    /**
     * @type {?number}
     * @description The price bofore rebate codes */
    PriceBeforeRebate;
    /**
     * @type {string}
     * @description The price currency */
    CurrencyId;
    /**
     * @type {string}
     * @description The price sign */
    PriceSign;
    /**
     * @type {string}
     * @description The price category */
    Category;
    /**
     * @type {?number}
     * @description The price VAT in percent */
    VAT;
    /**
     * @type {string}
     * @description The price text to display */
    PriceText;
    /**
     * @type {boolean}
     * @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. */
    OccupiesSpot;
}
export class UpdateQuantity {
    /** @param {{CompanyId?:string,BookingId?:number,Id?:number,OccupiesSpot?:boolean,Quantity?:number,Price?:number,CurrencyId?:string,Category?:string,VAT?:number,Comments?:string,Refund?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {number}
     * @description Id of the booking */
    BookingId;
    /**
     * @type {number}
     * @description Id of the quantity */
    Id;
    /**
     * @type {?boolean}
     * @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. */
    OccupiesSpot;
    /**
     * @type {number}
     * @description The quantity for booked on this price category */
    Quantity;
    /**
     * @type {?number}
     * @description The price */
    Price;
    /**
     * @type {string}
     * @description The price currency */
    CurrencyId;
    /**
     * @type {string}
     * @description The price category */
    Category;
    /**
     * @type {?number}
     * @description The price VAT in percent */
    VAT;
    /**
     * @type {string}
     * @description Any comments to be stored in the event log. */
    Comments;
    /**
     * @type {boolean}
     * @description If you want the amount to be refunded automatically if amount is lower than paid */
    Refund;
}

JavaScript UpdateQuantity DTOs

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

HTTP + XML

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: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateQuantity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BookingId>0</BookingId>
  <Category>String</Category>
  <Comments>String</Comments>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CurrencyId>String</CurrencyId>
  <Id>0</Id>
  <OccupiesSpot>false</OccupiesSpot>
  <Price>0</Price>
  <Quantity>0</Quantity>
  <Refund>false</Refund>
  <VAT>0</VAT>
</UpdateQuantity>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BookedQuantity xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Category>String</Category>
  <CurrencyId>String</CurrencyId>
  <Id>0</Id>
  <OccupiesSpot>false</OccupiesSpot>
  <Price>0</Price>
  <PriceBeforeRebate>0</PriceBeforeRebate>
  <PriceSign>String</PriceSign>
  <PriceText>String</PriceText>
  <Quantity>0</Quantity>
  <VAT>0</VAT>
</BookedQuantity>