BokaMera.API.Host

<back to all web services

UpdateVossDiscountAgreements

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/voss/discountAgreementsPUT Discount agreements
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


class PeriodKindEnum(str, Enum):
    FIXED_TIME = 'FixedTime'
    ALIGNED_TO_BINDING_PERIOD = 'AlignedToBindingPeriod'
    ALIGNED_TO_SUBSCRIPTION_BILLING_PERIOD = 'AlignedToSubscriptionBillingPeriod'


class UnitEnum(str, Enum):
    DAY = 'Day'
    MONTH = 'Month'
    YEAR = 'Year'


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DiscountAgreementTimeLengthRequestDto:
    unit: Optional[UnitEnum] = None
    value: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateDiscountPeriodRequestDto:
    period_kind: Optional[PeriodKindEnum] = None
    length: Optional[DiscountAgreementTimeLengthRequestDto] = None
    period_iteration_count: Optional[int] = None


class DiscountAgreementStatusEnum(str, Enum):
    DRAFT = 'Draft'
    STAGED = 'Staged'
    PUBLISHED = 'Published'
    ARCHIVED = 'Archived'
    DISCARDED = 'Discarded'


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateVossDiscountAgreements:
    # @ApiMember(Description="Discount agreement data", IsRequired=true)
    discount_agreement_id: Optional[str] = None
    """
    Discount agreement data
    """


    # @ApiMember(Description="Discount agreement period data. Iteration count must be added", IsRequired=true)
    discount_period: Optional[UpdateDiscountPeriodRequestDto] = None
    """
    Discount agreement period data. Iteration count must be added
    """


    # @ApiMember(Description="Discount agreement status. Published is default.", IsRequired=true)
    discount_agreement_status: Optional[DiscountAgreementStatusEnum] = None
    """
    Discount agreement status. Published is default.
    """


    name: Optional[str] = None
    description: Optional[str] = None
    valid_from: datetime.datetime = datetime.datetime(1, 1, 1)
    valid_to: Optional[datetime.datetime] = None

Python UpdateVossDiscountAgreements DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /voss/discountAgreements HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DiscountAgreementStatus":"Draft","Name":"String","Description":"String","ValidTo":"0001-01-01T00:00:00"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{}