BokaMera.API.Host

<back to all web services

GetRebateCodeBySign

The following routes are available for this service:
GET/rebatecodes/getbysignGet RebateCode by RebateCodeBySignGet RebateCode RebateCodeBySign (for example XMAS20)

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 BaseModel
{

    public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}

export class ArticleServiceDb extends BaseModel
{
    // @Required()
    public CompanyId: string;

    public Id: number;
    // @Required()
    public ServiceId: number;

    // @Required()
    public ArticleId: number;

    public constructor(init?: Partial<ArticleServiceDb>) { super(init); (Object as any).assign(this, init); }
}

export class ArticleResponse
{
    public CompanyId: string;
    public Id: number;
    public Name: string;
    public ArticleTypeId: number;
    public Description: string;
    public ImageUrl: string;
    public Active: boolean;
    public Amount: number;
    public Price: number;
    public CurrencyId: string;
    public UpdatedDate: string;
    public CreatedDate: string;
    public Services: ArticleServiceDb[];
    public ServiceIds: number[];
    public PriceSign: string;

    public constructor(init?: Partial<ArticleResponse>) { (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 RebateCodeTransactionQueryResponse
{
    public Id: number;
    public CompanyId: string;
    public Note: string;
    public RebateCodeId: number;
    public RebateCodeSign: string;
    public RebateCodeTypeId?: number;
    public RebateCodeTypeName: string;
    public Amount: number;
    public BookingId?: number;
    public UpdatedDate: string;
    public CreatedDate: string;
    public Service: RebateCodeServiceResponse;
    public Customer: RebateCodeCustomerResponse;
    public PriceSign: string;

    public constructor(init?: Partial<RebateCodeTransactionQueryResponse>) { (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 DaysOfWeek: DaysOfWeekResponse[];
    public Services: RebateCodeServiceResponse[];
    public Article: ArticleResponse;
    public Transactions: RebateCodeTransactionQueryResponse[];
    public RemainingAmount?: number;
    public RemainingUsage?: number;
    public Customers: RebateCodeCustomerResponse[];
    public ResponseStatus: ResponseStatus;
    public PaymentReceived: boolean;
    public RebateCodeCurrencySign: string;
    public ActiveByStatus: boolean;
    public PriceSign: string;
    public RebateCodeTypeName: string;

    public constructor(init?: Partial<RebateCodeResponse>) { (Object as any).assign(this, init); }
}

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
export class GetRebateCodeBySign
{
    /** @description  */
    // @ApiMember(Description="", IsRequired=true)
    public CompanyId: string;

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

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

    /** @description The datetime for when to check if the code is valid */
    // @ApiMember(Description="The datetime for when to check if the code is valid")
    public Date: string;

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

    /** @description  */
    // @ApiMember(Description="")
    public IncludeConnectedDaysOfWeek: boolean;

    /** @description  */
    // @ApiMember(Description="")
    public IncludeConnectedCustomers: boolean;

    /** @description  */
    // @ApiMember(Description="")
    public CustomerEmail: string;

    public constructor(init?: Partial<GetRebateCodeBySign>) { (Object as any).assign(this, init); }
}

TypeScript GetRebateCodeBySign 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.

GET /rebatecodes/getbysign HTTP/1.1 
Host: api.bokamera.se 
Accept: application/json
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,"DaysOfWeek":[{"Id":0,"DayOfWeek":"String","DayOfWeekTranslation":"String","DayOfWeekActive":false,"DayOfWeekSortOrder":0}],"Services":[{"Id":0,"Name":"String","Description":"String","Active":false}],"Article":{"Id":0,"Name":"String","ArticleTypeId":0,"Description":"String","ImageUrl":"String","Active":false,"Amount":0,"Price":0,"CurrencyId":"String","Services":[{"Id":0,"ServiceId":0,"ArticleId":0}],"ServiceIds":[0],"PriceSign":"String"},"Transactions":[{"Id":0,"Note":"String","RebateCodeId":0,"RebateCodeSign":"String","RebateCodeTypeId":0,"RebateCodeTypeName":"String","Amount":0,"BookingId":0,"Service":{"Id":0,"Name":"String","Description":"String","Active":false},"Customer":{"Firstname":"String","Lastname":"String","Email":"String","Phone":"String","ImageUrl":"String"},"PriceSign":"String"}],"RemainingAmount":0,"RemainingUsage":0,"Customers":[{"Firstname":"String","Lastname":"String","Email":"String","Phone":"String","ImageUrl":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"PaymentReceived":false,"RebateCodeCurrencySign":"String","ActiveByStatus":false,"PriceSign":"String","RebateCodeTypeName":"String"}