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.
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BookedQuantity:
    # @ApiMember(Description="The quantity Id")
    id: int = 0
    """
    The quantity Id
    """


    # @ApiMember(Description="The quantity for booked on this price category")
    quantity: int = 0
    """
    The quantity for booked on this price category
    """


    # @ApiMember(Description="The price")
    price: Optional[float] = None
    """
    The price
    """


    # @ApiMember(Description="The price bofore rebate codes")
    price_before_rebate: Optional[float] = None
    """
    The price bofore rebate codes
    """


    # @ApiMember(Description="The price currency")
    currency_id: Optional[str] = None
    """
    The price currency
    """


    # @ApiMember(Description="The price sign")
    price_sign: Optional[str] = None
    """
    The price sign
    """


    # @ApiMember(Description="The price category")
    category: Optional[str] = None
    """
    The price category
    """


    # @ApiMember(Description="The price VAT in percent")
    vat: Optional[Decimal] = None
    """
    The price VAT in percent
    """


    # @ApiMember(Description="The price text to display")
    price_text: Optional[str] = None
    """
    The price text to display
    """


    # @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.")
    occupies_spot: bool = False
    """
    If the quantity you add should occupy a spot. Default is true. If no it will only be a row that includes price information.
    """


# @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)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateQuantity(ICompany):
    # @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    company_id: Optional[str] = None
    """
    The company id, if empty will use the company id for the user you are logged in with.
    """


    # @ApiMember(Description="Id of the booking", IsRequired=true, ParameterType="path")
    booking_id: Optional[int] = None
    """
    Id of the booking
    """


    # @ApiMember(Description="Id of the quantity", IsRequired=true, ParameterType="path")
    id: Optional[int] = None
    """
    Id of the quantity
    """


    # @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.")
    occupies_spot: Optional[bool] = None
    """
    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="The quantity for booked on this price category")
    quantity: int = 0
    """
    The quantity for booked on this price category
    """


    # @ApiMember(Description="The price")
    price: Optional[float] = None
    """
    The price
    """


    # @ApiMember(Description="The price currency")
    currency_id: Optional[str] = None
    """
    The price currency
    """


    # @ApiMember(Description="The price category")
    category: Optional[str] = None
    """
    The price category
    """


    # @ApiMember(Description="The price VAT in percent")
    vat: Optional[Decimal] = None
    """
    The price VAT in percent
    """


    # @ApiMember(Description="Any comments to be stored in the event log.")
    comments: Optional[str] = None
    """
    Any comments to be stored in the event log.
    """


    # @ApiMember(Description="If you want the amount to be refunded automatically if amount is lower than paid")
    refund: bool = False
    """
    If you want the amount to be refunded automatically if amount is lower than paid
    """

Python 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: api.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>