Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
POST | /rebatecodes | Create RebateCode. | Create RebateCode. |
---|
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
namespace BokaMera.API.ServiceModel.Dtos
{
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
[ValidateRequest("IsAuthenticated")]
public partial class CreateRebateCode
{
public CreateRebateCode()
{
DaysOfWeek = new List<int>{};
Services = new List<int>{};
Customers = new List<Guid>{};
}
///<summary>
///
///</summary>
[ApiMember(Description="")]
public virtual Guid? CompanyId { get; set; }
///<summary>
///The default value is 9999
///</summary>
[ApiMember(Description="The default value is 9999")]
public virtual int? MaxNumberOfUses { get; set; }
///<summary>
///The default value is 1
///</summary>
[ApiMember(Description="The default value is 1")]
public virtual int? MaxNumberOfUsesPerCustomer { get; set; }
///<summary>
///
///</summary>
[ApiMember(Description="", IsRequired=true)]
public virtual DateTime ValidFrom { get; set; }
///<summary>
///
///</summary>
[ApiMember(Description="", IsRequired=true)]
public virtual DateTime ValidTo { get; set; }
///<summary>
///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.
///</summary>
[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 virtual TimeSpan? FromTime { get; set; }
///<summary>
///If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
///</summary>
[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 virtual TimeSpan? ToTime { get; set; }
///<summary>
///1 - Percent, 2 - Сurrency, 3 - PunchTicket, 4 - ValueCard, 5 - GiftCard
///</summary>
[ApiMember(Description="1 - Percent, 2 - Сurrency, 3 - PunchTicket, 4 - ValueCard, 5 - GiftCard", IsRequired=true)]
public virtual int RebateCodeTypeId { get; set; }
///<summary>
///
///</summary>
[ApiMember(Description="", IsRequired=true)]
public virtual int RebateCodeValue { get; set; }
///<summary>
///If AutoGenerateRebateCodeSign=false - more than four letters, unique among active codes
///</summary>
[ApiMember(Description="If AutoGenerateRebateCodeSign=false - more than four letters, unique among active codes")]
public virtual string RebateCodeSign { get; set; }
///<summary>
///AutoGenerateRebateCodeSign=true - random generate code
///</summary>
[ApiMember(Description="AutoGenerateRebateCodeSign=true - random generate code")]
public virtual bool AutoGenerateRebateCodeSign { get; set; }
///<summary>
///
///</summary>
[ApiMember(Description="")]
public virtual string PersonalNote { get; set; }
///<summary>
///
///</summary>
[ApiMember(Description="")]
public virtual List<int> DaysOfWeek { get; set; }
///<summary>
///
///</summary>
[ApiMember(Description="")]
public virtual List<int> Services { get; set; }
///<summary>
///
///</summary>
[ApiMember(Description="")]
public virtual List<Guid> Customers { get; set; }
}
public partial class DaysOfWeekResponse
{
public virtual int Id { get; set; }
public virtual string DayOfWeek { get; set; }
public virtual string DayOfWeekTranslation { get; set; }
public virtual bool? DayOfWeekActive { get; set; }
public virtual short? DayOfWeekSortOrder { get; set; }
}
public partial class RebateCodeCustomerResponse
{
public virtual Guid Id { get; set; }
public virtual string Firstname { get; set; }
public virtual string Lastname { get; set; }
public virtual string Email { get; set; }
public virtual string Phone { get; set; }
public virtual string ImageUrl { get; set; }
}
public partial class RebateCodeResponse
{
public RebateCodeResponse()
{
DaysOfWeek = new List<DaysOfWeekResponse>{};
Services = new List<RebateCodeServiceResponse>{};
Customers = new List<RebateCodeCustomerResponse>{};
RebateCodeTypesOptions = new List<RebateCodeTypeResponse>{};
RebateCodeStatusOptions = new List<RebateCodeStatusResponse>{};
}
public virtual int Id { get; set; }
public virtual Guid? CompanyId { get; set; }
public virtual DateTime ValidFrom { get; set; }
public virtual DateTime ValidTo { get; set; }
///<summary>
///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.
///</summary>
[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 virtual TimeSpan FromTime { get; set; }
///<summary>
///If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
///</summary>
[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 virtual TimeSpan ToTime { get; set; }
public virtual string CreatedBy { get; set; }
public virtual DateTime Created { get; set; }
public virtual string UpdatedBy { get; set; }
public virtual DateTime Updated { get; set; }
public virtual string PersonalNote { get; set; }
public virtual string RebateCodeSign { get; set; }
public virtual int RebateCodeValue { get; set; }
public virtual int RebateCodeTypeId { get; set; }
public virtual string Name { get; set; }
public virtual int RebateCodeStatusId { get; set; }
public virtual string StatusName { get; set; }
public virtual int MaxNumberOfUses { get; set; }
public virtual int MaxNumberOfUsesPerCustomer { get; set; }
public virtual int NumberOfUsesUsed { get; set; }
public virtual int NumberOfUsesPerCustomerUsed { get; set; }
public virtual List<DaysOfWeekResponse> DaysOfWeek { get; set; }
public virtual List<RebateCodeServiceResponse> Services { get; set; }
public virtual List<RebateCodeCustomerResponse> Customers { get; set; }
public virtual List<RebateCodeTypeResponse> RebateCodeTypesOptions { get; set; }
public virtual List<RebateCodeStatusResponse> RebateCodeStatusOptions { get; set; }
public virtual ResponseStatus ResponseStatus { get; set; }
}
public partial class RebateCodeServiceResponse
{
public virtual int Id { get; set; }
public virtual string Name { get; set; }
public virtual string Description { get; set; }
public virtual bool Active { get; set; }
}
public partial class RebateCodeStatusItem
{
public virtual int Id { get; set; }
public virtual string RebateCodeStatusName { get; set; }
public virtual string RebateCodeStatusDescription { get; set; }
}
public partial class RebateCodeStatusResponse
{
public RebateCodeStatusResponse()
{
RebateCodeStatusItems = new List<RebateCodeStatusItem>{};
}
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual List<RebateCodeStatusItem> RebateCodeStatusItems { get; set; }
}
public partial class RebateCodeTypeItem
{
public virtual int Id { get; set; }
public virtual string Name { get; set; }
public virtual string Description { get; set; }
}
public partial class RebateCodeTypeResponse
{
public RebateCodeTypeResponse()
{
RebateCodeTypeItems = new List<RebateCodeTypeItem>{};
}
public virtual ResponseStatus ResponseStatus { get; set; }
public virtual List<RebateCodeTypeItem> RebateCodeTypeItems { get; set; }
}
}
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: testapi.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">
<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>
<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>
</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"> <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>