| PUT | /services/{Id}/calculateprice | Calculate price on service | Calculate an price on a service. |
|---|
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 RebateCodeTypeItem:
id: int = 0
name: Optional[str] = None
description: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AppliedRebateCodesResponse:
rebate_code_sign: Optional[str] = None
rebate_code_value: int = 0
rebate_code_type: Optional[RebateCodeTypeItem] = None
rebate_code_id: int = 0
rebate_amount: float = 0.0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TotalPricePriceDetail:
quantity: int = 0
price: float = 0.0
vat_amount: float = 0.0
description: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TotalPriceInformationResponse:
price_sign: Optional[str] = None
currency_id: Optional[str] = None
total_price: float = 0.0
total_vat_amount: float = 0.0
total_price_before_rebate: float = 0.0
applied_codes: Optional[List[AppliedRebateCodesResponse]] = None
price_details: Optional[List[TotalPricePriceDetail]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class PriceInterval:
# @ApiMember(Description="The start date and time for the price to be calculated. Normally the booking start datetime.", IsRequired=true)
from_: datetime.datetime = field(metadata=config(field_name='from'), default=datetime.datetime(1, 1, 1))
"""
The start date and time for the price to be calculated. Normally the booking start datetime.
"""
# @ApiMember(Description="The end date and time for the price to be calculated.Normally the booking end datetime. If nothing entered it will use the service length.")
to: Optional[datetime.datetime] = None
"""
The end date and time for the price to be calculated.Normally the booking end datetime. If nothing entered it will use the service length.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RebateCodeAppliedWithAmount:
id: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CalculateTotalPriceOnService(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 service", IsRequired=true, ParameterType="path")
id: int = 0
"""
Id of the service
"""
# @ApiMember(Description="The price interval to be used for calculations", IsRequired=true)
interval: Optional[PriceInterval] = None
"""
The price interval to be used for calculations
"""
# @ApiMember(Description="Rebate codes applied to booking")
rebate_code_ids_with_amount: Optional[List[RebateCodeAppliedWithAmount]] = None
"""
Rebate codes applied to booking
"""
# @ApiMember(Description="If you have selected to include the prices, here you can include the quantities to book to get the correct total price.")
quantities: Optional[List[QuantityToBook]] = None
"""
If you have selected to include the prices, here you can include the quantities to book to get the correct total price.
"""
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QuantityToBook:
# @ApiMember(Description="If service has a price, enter the price id for that price. If no price exists for the service set 0 as PriceId. If you put 0 and a price exists, it will use that price (only works if just one price exists for the current selected date to book)", IsRequired=true)
price_id: int = 0
"""
If service has a price, enter the price id for that price. If no price exists for the service set 0 as PriceId. If you put 0 and a price exists, it will use that price (only works if just one price exists for the current selected date to book)
"""
# @ApiMember(Description="Set the number of spots or resources you want to book on the specific price category", IsRequired=true)
quantity: int = 0
"""
Set the number of spots or resources you want to book on the specific price category
"""
# @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.
"""
Python CalculateTotalPriceOnService DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /services/{Id}/calculateprice HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CalculateTotalPriceOnService xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Id>0</Id>
<Interval>
<From>0001-01-01T00:00:00</From>
<To>0001-01-01T00:00:00</To>
</Interval>
<Quantities>
<QuantityToBook>
<OccupiesSpot>false</OccupiesSpot>
<PriceId>0</PriceId>
<Quantity>0</Quantity>
</QuantityToBook>
</Quantities>
<RebateCodeIdsWithAmount>
<RebateCodeAppliedWithAmount>
<Id>0</Id>
</RebateCodeAppliedWithAmount>
</RebateCodeIdsWithAmount>
</CalculateTotalPriceOnService>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<TotalPriceInformationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<AppliedCodes>
<AppliedRebateCodesResponse>
<RebateAmount>0</RebateAmount>
<RebateCodeId>0</RebateCodeId>
<RebateCodeSign>String</RebateCodeSign>
<RebateCodeType>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</RebateCodeType>
<RebateCodeValue>0</RebateCodeValue>
</AppliedRebateCodesResponse>
</AppliedCodes>
<CurrencyId>String</CurrencyId>
<PriceDetails>
<TotalPricePriceDetail>
<Description>String</Description>
<Price>0</Price>
<Quantity>0</Quantity>
<VatAmount>0</VatAmount>
</TotalPricePriceDetail>
</PriceDetails>
<PriceSign>String</PriceSign>
<TotalPrice>0</TotalPrice>
<TotalPriceBeforeRebate>0</TotalPriceBeforeRebate>
<TotalVatAmount>0</TotalVatAmount>
</TotalPriceInformationResponse>