Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
PUT | /rebatecodes/{Id} | Update RebateCode by Id | Update RebateCode by Id) |
---|
export class DaysOfWeekResponse
{
public Id: number;
public DayOfWeek: string;
public DayOfWeekTranslation: string;
public DayOfWeekActive?: boolean;
public DayOfWeekSortOrder?: number;
public constructor(init?: Partial<DaysOfWeekResponse>) { (Object as any).assign(this, init); }
}
export class RebateCodeServiceResponse
{
public Id: number;
public Name: string;
public Description: string;
public Active: boolean;
public constructor(init?: Partial<RebateCodeServiceResponse>) { (Object as any).assign(this, init); }
}
export class RebateCodeCustomerResponse
{
public Id: string;
public Firstname: string;
public Lastname: string;
public Email: string;
public Phone: string;
public ImageUrl: string;
public constructor(init?: Partial<RebateCodeCustomerResponse>) { (Object as any).assign(this, init); }
}
export class RebateCodeTypeItem
{
public Id: number;
public Name: string;
public Description: string;
public constructor(init?: Partial<RebateCodeTypeItem>) { (Object as any).assign(this, init); }
}
export class RebateCodeTypeResponse
{
public ResponseStatus: ResponseStatus;
public RebateCodeTypeItems: RebateCodeTypeItem[];
public constructor(init?: Partial<RebateCodeTypeResponse>) { (Object as any).assign(this, init); }
}
export class RebateCodeStatusItem
{
public Id: number;
public RebateCodeStatusName: string;
public RebateCodeStatusDescription: string;
public constructor(init?: Partial<RebateCodeStatusItem>) { (Object as any).assign(this, init); }
}
export class RebateCodeStatusResponse
{
public ResponseStatus: ResponseStatus;
public RebateCodeStatusItems: RebateCodeStatusItem[];
public constructor(init?: Partial<RebateCodeStatusResponse>) { (Object as any).assign(this, init); }
}
export class RebateCodeResponse
{
public Id: number;
public CompanyId?: string;
public ValidFrom: string;
public ValidTo: string;
/** @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. */
// @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.")
public FromTime: string;
/** @description If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters. */
// @ApiMember(Description="If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.")
public ToTime: string;
public CreatedBy: string;
public Created: string;
public UpdatedBy: string;
public Updated: string;
public PersonalNote: string;
public RebateCodeSign: string;
public RebateCodeValue: number;
public RebateCodeTypeId: number;
public Name: string;
public RebateCodeStatusId: number;
public StatusName: string;
public MaxNumberOfUses: number;
public MaxNumberOfUsesPerCustomer: number;
public NumberOfUsesUsed: number;
public NumberOfUsesPerCustomerUsed: number;
public DaysOfWeek: DaysOfWeekResponse[];
public Services: RebateCodeServiceResponse[];
public Customers: RebateCodeCustomerResponse[];
public RebateCodeTypesOptions: RebateCodeTypeResponse[];
public RebateCodeStatusOptions: RebateCodeStatusResponse[];
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<RebateCodeResponse>) { (Object as any).assign(this, init); }
}
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class UpdateRebateCode implements ICompany
{
/** @description Id of the rebate code */
// @ApiMember(Description="Id of the rebate code", IsRequired=true, ParameterType="path")
public Id: number;
public CompanyId?: string;
/** @description The default value is 9999 */
// @ApiMember(Description="The default value is 9999")
public MaxNumberOfUses?: number;
/** @description The default value is 1 */
// @ApiMember(Description="The default value is 1")
public MaxNumberOfUsesPerCustomer?: number;
/** @description AutoGenerateRebateCodeSign=true - random generate code */
// @ApiMember(Description="AutoGenerateRebateCodeSign=true - random generate code")
public AutoGenerateRebateCodeSign: boolean;
/** @description 1 - Percent, 2 - Сurrency */
// @ApiMember(Description="1 - Percent, 2 - Сurrency")
public RebateCodeTypeId: number;
/** @description */
// @ApiMember(Description="")
public ValidFrom?: string;
/** @description */
// @ApiMember(Description="")
public ValidTo?: string;
/** @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. */
// @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.")
public FromTime?: string;
/** @description If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters. */
// @ApiMember(Description="If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.")
public ToTime?: string;
public RebateCodeValue?: number;
/** @description Is empty - random generate code, is not empty - more than four letters, unique among active codes */
// @ApiMember(Description="Is empty - random generate code, is not empty - more than four letters, unique among active codes")
public RebateCodeSign: string;
/** @description */
// @ApiMember(Description="")
public PersonalNote: string;
/** @description */
// @ApiMember(Description="")
public DaysOfWeek: number[];
/** @description */
// @ApiMember(Description="")
public Services: number[];
/** @description */
// @ApiMember(Description="")
public Customers: string[];
public constructor(init?: Partial<UpdateRebateCode>) { (Object as any).assign(this, init); }
}
TypeScript UpdateRebateCode 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 /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>
<RebateCodeTypeId>0</RebateCodeTypeId>
<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>