BokaMera.API.Host

<back to all web services

DeleteRebateCode

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
DELETE/rebatecodes/{Id}Delete RebateCode.Delete RebateCode.
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 DeleteRebateCode(ICompany):
    # @ApiMember(Description="")
    company_id: Optional[str] = None
    """
    
    """

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


    force_delete: bool = False

Python DeleteRebateCode DTOs

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

HTTP + JSV

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

DELETE /rebatecodes/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	CompanyId: 00000000-0000-0000-0000-000000000000,
	FromTime: PT0S,
	ToTime: PT0S,
	CreatedBy: String,
	UpdatedBy: String,
	PersonalNote: String,
	RebateCodeSign: String,
	RebateCodeValue: 0,
	RebateCodeTypeId: 0,
	Name: String,
	RebateCodeStatusId: 0,
	StatusName: String,
	MaxNumberOfUses: 0,
	MaxNumberOfUsesPerCustomer: 0,
	NumberOfUsesUsed: 0,
	NumberOfUsesPerCustomerUsed: 0,
	DaysOfWeek: 
	[
		{
			Id: 0,
			DayOfWeek: String,
			DayOfWeekTranslation: String,
			DayOfWeekActive: False,
			DayOfWeekSortOrder: 0
		}
	],
	Services: 
	[
		{
			Id: 0,
			Name: String,
			Description: String,
			Active: False
		}
	],
	Customers: 
	[
		{
			Firstname: String,
			Lastname: String,
			Email: String,
			Phone: String,
			ImageUrl: String
		}
	],
	RebateCodeTypesOptions: 
	[
		{
			ResponseStatus: 
			{
				ErrorCode: String,
				Message: String,
				StackTrace: String,
				Errors: 
				[
					{
						ErrorCode: String,
						FieldName: String,
						Message: String,
						Meta: 
						{
							String: String
						}
					}
				],
				Meta: 
				{
					String: String
				}
			},
			RebateCodeTypeItems: 
			[
				{
					Id: 0,
					Name: String,
					Description: String
				}
			]
		}
	],
	RebateCodeStatusOptions: 
	[
		{
			ResponseStatus: 
			{
				ErrorCode: String,
				Message: String,
				StackTrace: String,
				Errors: 
				[
					{
						ErrorCode: String,
						FieldName: String,
						Message: String,
						Meta: 
						{
							String: String
						}
					}
				],
				Meta: 
				{
					String: String
				}
			},
			RebateCodeStatusItems: 
			[
				{
					Id: 0,
					RebateCodeStatusName: String,
					RebateCodeStatusDescription: String
				}
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}