BokaMera.API.Host

<back to all web services

CreateRebateCode

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
POST/rebatecodesCreate RebateCode.Create RebateCode.

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 CreateRebateCode
{
    /** @description  */
    // @ApiMember(Description="")
    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  */
    // @ApiMember(Description="", IsRequired=true)
    public ValidFrom: string;

    /** @description  */
    // @ApiMember(Description="", IsRequired=true)
    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;

    /** @description 1 - Percent, 2 - Сurrency */
    // @ApiMember(Description="1 - Percent, 2 - Сurrency", IsRequired=true)
    public RebateCodeTypeId: number;

    /** @description  */
    // @ApiMember(Description="", IsRequired=true)
    public RebateCodeValue: number;

    /** @description If AutoGenerateRebateCodeSign=false - more than four letters, unique among active codes */
    // @ApiMember(Description="If AutoGenerateRebateCodeSign=false - more than four letters, unique among active codes")
    public RebateCodeSign: string;

    /** @description AutoGenerateRebateCodeSign=true - random generate code */
    // @ApiMember(Description="AutoGenerateRebateCodeSign=true - random generate code")
    public AutoGenerateRebateCodeSign: boolean;

    /** @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<CreateRebateCode>) { (Object as any).assign(this, init); }
}

TypeScript CreateRebateCode DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /rebatecodes HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","MaxNumberOfUses":0,"MaxNumberOfUsesPerCustomer":0,"FromTime":"00:00:00","ToTime":"00:00:00","RebateCodeTypeId":0,"RebateCodeValue":0,"RebateCodeSign":"String","AutoGenerateRebateCodeSign":false,"PersonalNote":"String","DaysOfWeek":[0],"Services":[0],"Customers":["00000000-0000-0000-0000-000000000000"]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":0,"CompanyId":"00000000-0000-0000-0000-000000000000","FromTime":"00:00:00","ToTime":"00:00:00","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"}}}