BokaMera.API.Host

<back to all web services

AddQuantity

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/bookings/{BookingId}/quantity/Add an booking quantityUpdates an booking quantity if you are authorized to do so. Note: Add quantity wont update the number of booked resources.
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
    // @ApiResponse(Description="You have too low privilegies to call this service", StatusCode=403)
    @ValidateRequest(Validator="IsAuthenticated")
    public static class AddQuantity implements 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.")
        public UUID CompanyId = null;

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

        /**
        * The quantity for booked on this price category
        */
        @ApiMember(Description="The quantity for booked on this price category", IsRequired=true)
        public Integer Quantity = null;

        /**
        * The price
        */
        @ApiMember(Description="The price")
        public Double Price = null;

        /**
        * The price currency
        */
        @ApiMember(Description="The price currency")
        public String CurrencyId = null;

        /**
        * The price category
        */
        @ApiMember(Description="The price category")
        public String Category = null;

        /**
        * The price VAT in percent
        */
        @ApiMember(Description="The price VAT in percent")
        public BigDecimal VAT = 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.")
        public Boolean OccupiesSpot = null;

        /**
        * Any comments to be stored in the event log.
        */
        @ApiMember(Description="Any comments to be stored in the event log.")
        public String Comments = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public AddQuantity setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getBookingId() { return BookingId; }
        public AddQuantity setBookingId(Integer value) { this.BookingId = value; return this; }
        public Integer getQuantity() { return Quantity; }
        public AddQuantity setQuantity(Integer value) { this.Quantity = value; return this; }
        public Double getPrice() { return Price; }
        public AddQuantity setPrice(Double value) { this.Price = value; return this; }
        public String getCurrencyId() { return CurrencyId; }
        public AddQuantity setCurrencyId(String value) { this.CurrencyId = value; return this; }
        public String getCategory() { return Category; }
        public AddQuantity setCategory(String value) { this.Category = value; return this; }
        public BigDecimal getVat() { return VAT; }
        public AddQuantity setVat(BigDecimal value) { this.VAT = value; return this; }
        public Boolean isOccupiesSpot() { return OccupiesSpot; }
        public AddQuantity setOccupiesSpot(Boolean value) { this.OccupiesSpot = value; return this; }
        public String getComments() { return Comments; }
        public AddQuantity setComments(String value) { this.Comments = value; return this; }
    }

    public static class BookedQuantity
    {
        /**
        * The quantity Id
        */
        @ApiMember(Description="The quantity Id")
        public Integer Id = null;

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

        /**
        * The price
        */
        @ApiMember(Description="The price")
        public Double Price = null;

        /**
        * The price bofore rebate codes
        */
        @ApiMember(Description="The price bofore rebate codes")
        public Double PriceBeforeRebate = null;

        /**
        * The price currency
        */
        @ApiMember(Description="The price currency")
        public String CurrencyId = null;

        /**
        * The price sign
        */
        @ApiMember(Description="The price sign")
        public String PriceSign = null;

        /**
        * The price category
        */
        @ApiMember(Description="The price category")
        public String Category = null;

        /**
        * The price VAT in percent
        */
        @ApiMember(Description="The price VAT in percent")
        public BigDecimal VAT = null;

        /**
        * The price text to display
        */
        @ApiMember(Description="The price text to display")
        public String PriceText = 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.")
        public Boolean OccupiesSpot = null;
        
        public Integer getId() { return Id; }
        public BookedQuantity setId(Integer value) { this.Id = value; return this; }
        public Integer getQuantity() { return Quantity; }
        public BookedQuantity setQuantity(Integer value) { this.Quantity = value; return this; }
        public Double getPrice() { return Price; }
        public BookedQuantity setPrice(Double value) { this.Price = value; return this; }
        public Double getPriceBeforeRebate() { return PriceBeforeRebate; }
        public BookedQuantity setPriceBeforeRebate(Double value) { this.PriceBeforeRebate = value; return this; }
        public String getCurrencyId() { return CurrencyId; }
        public BookedQuantity setCurrencyId(String value) { this.CurrencyId = value; return this; }
        public String getPriceSign() { return PriceSign; }
        public BookedQuantity setPriceSign(String value) { this.PriceSign = value; return this; }
        public String getCategory() { return Category; }
        public BookedQuantity setCategory(String value) { this.Category = value; return this; }
        public BigDecimal getVat() { return VAT; }
        public BookedQuantity setVat(BigDecimal value) { this.VAT = value; return this; }
        public String getPriceText() { return PriceText; }
        public BookedQuantity setPriceText(String value) { this.PriceText = value; return this; }
        public Boolean isOccupiesSpot() { return OccupiesSpot; }
        public BookedQuantity setOccupiesSpot(Boolean value) { this.OccupiesSpot = value; return this; }
    }

}

Java AddQuantity 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.

POST /bookings/{BookingId}/quantity/ HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddQuantity 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>
  <OccupiesSpot>false</OccupiesSpot>
  <Price>0</Price>
  <Quantity>0</Quantity>
  <VAT>0</VAT>
</AddQuantity>
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>