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 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.
    """


# @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")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AddQuantity(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="The quantity for booked on this price category", IsRequired=true)
    quantity: Optional[int] = None
    """
    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="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.
    """


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

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

POST /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,"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}