Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /rebatecodes/{Id} | Update RebateCode by Id | Update RebateCode by Id) |
---|
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 DaysOfWeekResponse:
id: int = 0
day_of_week: Optional[str] = None
day_of_week_translation: Optional[str] = None
day_of_week_active: Optional[bool] = None
day_of_week_sort_order: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RebateCodeServiceResponse:
id: int = 0
name: Optional[str] = None
description: Optional[str] = None
active: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RebateCodeCustomerResponse:
id: Optional[str] = None
firstname: Optional[str] = None
lastname: Optional[str] = None
email: Optional[str] = None
phone: Optional[str] = None
image_url: Optional[str] = None
@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 RebateCodeTypeResponse:
response_status: Optional[ResponseStatus] = None
rebate_code_type_items: Optional[List[RebateCodeTypeItem]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RebateCodeStatusItem:
id: int = 0
rebate_code_status_name: Optional[str] = None
rebate_code_status_description: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RebateCodeStatusResponse:
response_status: Optional[ResponseStatus] = None
rebate_code_status_items: Optional[List[RebateCodeStatusItem]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RebateCodeResponse:
id: int = 0
company_id: Optional[str] = None
valid_from: datetime.datetime = datetime.datetime(1, 1, 1)
valid_to: datetime.datetime = datetime.datetime(1, 1, 1)
# @ApiMember(Description="If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.")
from_time: datetime.timedelta = datetime.timedelta()
"""
If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
"""
# @ApiMember(Description="If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.")
to_time: datetime.timedelta = datetime.timedelta()
"""
If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
"""
created_by: Optional[str] = None
created: datetime.datetime = datetime.datetime(1, 1, 1)
updated_by: Optional[str] = None
updated: datetime.datetime = datetime.datetime(1, 1, 1)
personal_note: Optional[str] = None
rebate_code_sign: Optional[str] = None
rebate_code_value: int = 0
rebate_code_type_id: int = 0
name: Optional[str] = None
rebate_code_status_id: int = 0
status_name: Optional[str] = None
max_number_of_uses: int = 0
max_number_of_uses_per_customer: int = 0
number_of_uses_used: int = 0
number_of_uses_per_customer_used: int = 0
days_of_week: Optional[List[DaysOfWeekResponse]] = None
services: Optional[List[RebateCodeServiceResponse]] = None
customers: Optional[List[RebateCodeCustomerResponse]] = None
rebate_code_types_options: Optional[List[RebateCodeTypeResponse]] = None
rebate_code_status_options: Optional[List[RebateCodeStatusResponse]] = None
response_status: Optional[ResponseStatus] = None
# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
# @ValidateRequest(Validator="IsAuthenticated")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateRebateCode(ICompany):
# @ApiMember(Description="Id of the rebate code", IsRequired=true, ParameterType="path")
id: Optional[int] = None
"""
Id of the rebate code
"""
company_id: Optional[str] = None
# @ApiMember(Description="The default value is 9999")
max_number_of_uses: Optional[int] = None
"""
The default value is 9999
"""
# @ApiMember(Description="The default value is 1")
max_number_of_uses_per_customer: Optional[int] = None
"""
The default value is 1
"""
# @ApiMember(Description="AutoGenerateRebateCodeSign=true - random generate code")
auto_generate_rebate_code_sign: bool = False
"""
AutoGenerateRebateCodeSign=true - random generate code
"""
# @ApiMember(Description="")
valid_from: Optional[datetime.datetime] = None
"""
"""
# @ApiMember(Description="")
valid_to: Optional[datetime.datetime] = None
"""
"""
# @ApiMember(Description="If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.")
from_time: Optional[datetime.timedelta] = None
"""
If the price is only valid for specific days in week add a comma separated list of which days this day price belongs to, 1 = Monday .. 7 = Sunday. All old days connected will be removed on update.
"""
# @ApiMember(Description="If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.")
to_time: Optional[datetime.timedelta] = None
"""
If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
"""
rebate_code_value: Optional[int] = None
# @ApiMember(Description="Is empty - random generate code, is not empty - more than four letters, unique among active codes")
rebate_code_sign: Optional[str] = None
"""
Is empty - random generate code, is not empty - more than four letters, unique among active codes
"""
# @ApiMember(Description="")
personal_note: Optional[str] = None
"""
"""
# @ApiMember(Description="")
days_of_week: Optional[List[int]] = None
"""
"""
# @ApiMember(Description="")
services: Optional[List[int]] = None
"""
"""
# @ApiMember(Description="")
customers: Optional[List[str]] = None
"""
"""
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 /rebatecodes/{Id} HTTP/1.1
Host: testapi.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateRebateCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<AutoGenerateRebateCodeSign>false</AutoGenerateRebateCodeSign>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Customers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</Customers>
<DaysOfWeek xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</DaysOfWeek>
<FromTime>PT0S</FromTime>
<Id>0</Id>
<MaxNumberOfUses>0</MaxNumberOfUses>
<MaxNumberOfUsesPerCustomer>0</MaxNumberOfUsesPerCustomer>
<PersonalNote>String</PersonalNote>
<RebateCodeSign>String</RebateCodeSign>
<RebateCodeValue>0</RebateCodeValue>
<Services xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</Services>
<ToTime>PT0S</ToTime>
<ValidFrom>0001-01-01T00:00:00</ValidFrom>
<ValidTo>0001-01-01T00:00:00</ValidTo>
</UpdateRebateCode>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <RebateCodeResponse 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> <Created>0001-01-01T00:00:00</Created> <CreatedBy>String</CreatedBy> <Customers> <RebateCodeCustomerResponse> <Email>String</Email> <Firstname>String</Firstname> <Id>00000000-0000-0000-0000-000000000000</Id> <ImageUrl>String</ImageUrl> <Lastname>String</Lastname> <Phone>String</Phone> </RebateCodeCustomerResponse> </Customers> <DaysOfWeek> <DaysOfWeekResponse> <DayOfWeek>String</DayOfWeek> <DayOfWeekActive>false</DayOfWeekActive> <DayOfWeekSortOrder>0</DayOfWeekSortOrder> <DayOfWeekTranslation>String</DayOfWeekTranslation> <Id>0</Id> </DaysOfWeekResponse> </DaysOfWeek> <FromTime>PT0S</FromTime> <Id>0</Id> <MaxNumberOfUses>0</MaxNumberOfUses> <MaxNumberOfUsesPerCustomer>0</MaxNumberOfUsesPerCustomer> <Name>String</Name> <NumberOfUsesPerCustomerUsed>0</NumberOfUsesPerCustomerUsed> <NumberOfUsesUsed>0</NumberOfUsesUsed> <PersonalNote>String</PersonalNote> <RebateCodeSign>String</RebateCodeSign> <RebateCodeStatusId>0</RebateCodeStatusId> <RebateCodeStatusOptions> <RebateCodeStatusResponse> <RebateCodeStatusItems> <RebateCodeStatusItem> <Id>0</Id> <RebateCodeStatusDescription>String</RebateCodeStatusDescription> <RebateCodeStatusName>String</RebateCodeStatusName> </RebateCodeStatusItem> </RebateCodeStatusItems> <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types"> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:Message>String</d4p1:Message> <d4p1:StackTrace>String</d4p1:StackTrace> <d4p1:Errors> <d4p1:ResponseError> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:FieldName>String</d4p1:FieldName> <d4p1:Message>String</d4p1:Message> <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:KeyValueOfstringstring> <d7p1:Key>String</d7p1:Key> <d7p1:Value>String</d7p1:Value> </d7p1:KeyValueOfstringstring> </d4p1:Meta> </d4p1:ResponseError> </d4p1:Errors> <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d4p1:Meta> </ResponseStatus> </RebateCodeStatusResponse> </RebateCodeStatusOptions> <RebateCodeTypeId>0</RebateCodeTypeId> <RebateCodeTypesOptions> <RebateCodeTypeResponse> <RebateCodeTypeItems> <RebateCodeTypeItem> <Description>String</Description> <Id>0</Id> <Name>String</Name> </RebateCodeTypeItem> </RebateCodeTypeItems> <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types"> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:Message>String</d4p1:Message> <d4p1:StackTrace>String</d4p1:StackTrace> <d4p1:Errors> <d4p1:ResponseError> <d4p1:ErrorCode>String</d4p1:ErrorCode> <d4p1:FieldName>String</d4p1:FieldName> <d4p1:Message>String</d4p1:Message> <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d7p1:KeyValueOfstringstring> <d7p1:Key>String</d7p1:Key> <d7p1:Value>String</d7p1:Value> </d7p1:KeyValueOfstringstring> </d4p1:Meta> </d4p1:ResponseError> </d4p1:Errors> <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d4p1:Meta> </ResponseStatus> </RebateCodeTypeResponse> </RebateCodeTypesOptions> <RebateCodeValue>0</RebateCodeValue> <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types"> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:Message>String</d2p1:Message> <d2p1:StackTrace>String</d2p1:StackTrace> <d2p1:Errors> <d2p1:ResponseError> <d2p1:ErrorCode>String</d2p1:ErrorCode> <d2p1:FieldName>String</d2p1:FieldName> <d2p1:Message>String</d2p1:Message> <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d5p1:KeyValueOfstringstring> <d5p1:Key>String</d5p1:Key> <d5p1:Value>String</d5p1:Value> </d5p1:KeyValueOfstringstring> </d2p1:Meta> </d2p1:ResponseError> </d2p1:Errors> <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:KeyValueOfstringstring> <d3p1:Key>String</d3p1:Key> <d3p1:Value>String</d3p1:Value> </d3p1:KeyValueOfstringstring> </d2p1:Meta> </ResponseStatus> <Services> <RebateCodeServiceResponse> <Active>false</Active> <Description>String</Description> <Id>0</Id> <Name>String</Name> </RebateCodeServiceResponse> </Services> <StatusName>String</StatusName> <ToTime>PT0S</ToTime> <Updated>0001-01-01T00:00:00</Updated> <UpdatedBy>String</UpdatedBy> <ValidFrom>0001-01-01T00:00:00</ValidFrom> <ValidTo>0001-01-01T00:00:00</ValidTo> </RebateCodeResponse>