| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /rebatecodes | Create 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 BaseModel
{
public constructor(init?: Partial<BaseModel>) { (Object as any).assign(this, init); }
}
export class ArticleServiceRelation extends BaseModel
{
// @Required()
public CompanyId: string;
public Id: number;
// @Required()
public ServiceId: number;
// @Required()
public ArticleId: number;
public constructor(init?: Partial<ArticleServiceRelation>) { 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: ArticleServiceRelation[];
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); }
}
export class PromoCodeReceiver
{
public CustomerId?: string;
public Firstname: string;
public Lastname: string;
public Email: string;
public ReceiverMessage: string;
public constructor(init?: Partial<PromoCodeReceiver>) { (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, 3 - PunchTicket, 4 - ValueCard, 5 - GiftCard */
// @ApiMember(Description="1 - Percent, 2 - Сurrency, 3 - PunchTicket, 4 - ValueCard, 5 - GiftCard", IsRequired=true)
public RebateCodeTypeId: number;
/** @description If it's connected to an Article, add the Article Id here. */
// @ApiMember(Description="If it's connected to an Article, add the Article Id here.")
public ArticleId?: 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[];
/** @description The price */
// @ApiMember(Description="The price")
public PriceVat?: number;
/** @description The price currency */
// @ApiMember(Description="The price currency")
public CurrencyId: string;
/** @description Promo code Receiver infomration */
// @ApiMember(Description="Promo code Receiver infomration")
public PromoCodeReceiver: PromoCodeReceiver;
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 .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /rebatecodes HTTP/1.1
Host: api.bokamera.se
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateRebateCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<ArticleId>0</ArticleId>
<AutoGenerateRebateCodeSign>false</AutoGenerateRebateCodeSign>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CurrencyId>String</CurrencyId>
<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>
<MaxNumberOfUses>0</MaxNumberOfUses>
<MaxNumberOfUsesPerCustomer>0</MaxNumberOfUsesPerCustomer>
<PersonalNote>String</PersonalNote>
<PriceVat>0</PriceVat>
<PromoCodeReceiver>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<Email>String</Email>
<Firstname>String</Firstname>
<Lastname>String</Lastname>
<ReceiverMessage>String</ReceiverMessage>
</PromoCodeReceiver>
<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>
</CreateRebateCode>
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">
<ActiveByStatus>false</ActiveByStatus>
<Article>
<Active>false</Active>
<Amount>0</Amount>
<ArticleTypeId>0</ArticleTypeId>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<CurrencyId>String</CurrencyId>
<Description>String</Description>
<Id>0</Id>
<ImageUrl>String</ImageUrl>
<Name>String</Name>
<Price>0</Price>
<PriceSign>String</PriceSign>
<ServiceIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:int>0</d3p1:int>
</ServiceIds>
<Services xmlns:d3p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
<d3p1:ArticleServiceRelation>
<d3p1:ArticleId>0</d3p1:ArticleId>
<d3p1:CompanyId>00000000-0000-0000-0000-000000000000</d3p1:CompanyId>
<d3p1:Id>0</d3p1:Id>
<d3p1:ServiceId>0</d3p1:ServiceId>
</d3p1:ArticleServiceRelation>
</Services>
<UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
</Article>
<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>
<NumberOfUsesUsed>0</NumberOfUsesUsed>
<PaymentReceived>false</PaymentReceived>
<PersonalNote>String</PersonalNote>
<PriceSign>String</PriceSign>
<RebateCodeCurrencySign>String</RebateCodeCurrencySign>
<RebateCodeSign>String</RebateCodeSign>
<RebateCodeStatusId>0</RebateCodeStatusId>
<RebateCodeTypeId>0</RebateCodeTypeId>
<RebateCodeTypeName>String</RebateCodeTypeName>
<RebateCodeValue>0</RebateCodeValue>
<RemainingAmount>0</RemainingAmount>
<RemainingUsage>0</RemainingUsage>
<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>
<Transactions>
<RebateCodeTransactionQueryResponse>
<Amount>0</Amount>
<BookingId>0</BookingId>
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<Customer>
<Email>String</Email>
<Firstname>String</Firstname>
<Id>00000000-0000-0000-0000-000000000000</Id>
<ImageUrl>String</ImageUrl>
<Lastname>String</Lastname>
<Phone>String</Phone>
</Customer>
<Id>0</Id>
<Note>String</Note>
<PriceSign>String</PriceSign>
<RebateCodeId>0</RebateCodeId>
<RebateCodeSign>String</RebateCodeSign>
<RebateCodeTypeId>0</RebateCodeTypeId>
<RebateCodeTypeName>String</RebateCodeTypeName>
<Service>
<Active>false</Active>
<Description>String</Description>
<Id>0</Id>
<Name>String</Name>
</Service>
<UpdatedDate>0001-01-01T00:00:00</UpdatedDate>
</RebateCodeTransactionQueryResponse>
</Transactions>
<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>