BokaMera.API.Host

<back to all web services

CreateArticleRebateCode

The following routes are available for this service:
POST/rebatecodes/fromarticleCreate RebateCode.Create RebateCode.
import java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
open class CreateArticleRebateCode : ICompany
{
    /**
    * 
    */
    @ApiMember(Description="")
    var CompanyId:UUID? = null

    /**
    * Article ID for the rebate code
    */
    @ApiMember(Description="Article ID for the rebate code", IsRequired=true)
    var ArticleId:Int? = null

    /**
    * Customer infomration
    */
    @ApiMember(Description="Customer infomration")
    var Customer:CustomerToHandle? = null

    /**
    * Promo code Receiver information
    */
    @ApiMember(Description="Promo code Receiver information")
    var Receiver:PromoCodeReceiver? = null
}

open class CustomerToHandle
{
    var CustomerId:UUID? = null
    var Firstname:String? = null
    var Lastname:String? = null
    var Email:String? = null
    var Phone:String? = null
    var SubscribedToNewsletter:Boolean? = null
}

open class PromoCodeReceiver
{
    var CustomerId:UUID? = null
    var Firstname:String? = null
    var Lastname:String? = null
    var Email:String? = null
    var ReceiverMessage:String? = null
}

open class RebateCodeResponse
{
    var Id:Int? = null
    var CompanyId:UUID? = null
    var ValidFrom:Date? = null
    var ValidTo:Date? = null
    /**
    * 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.")
    var FromTime:TimeSpan? = null

    /**
    * 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.")
    var ToTime:TimeSpan? = null

    var CreatedBy:String? = null
    var Created:Date? = null
    var UpdatedBy:String? = null
    var Updated:Date? = null
    var PersonalNote:String? = null
    var RebateCodeSign:String? = null
    var RebateCodeValue:Int? = null
    var RebateCodeTypeId:Int? = null
    var Name:String? = null
    var RebateCodeStatusId:Int? = null
    var StatusName:String? = null
    var MaxNumberOfUses:Int? = null
    var MaxNumberOfUsesPerCustomer:Int? = null
    var NumberOfUsesUsed:Int? = null
    var DaysOfWeek:ArrayList<DaysOfWeekResponse> = ArrayList<DaysOfWeekResponse>()
    var Services:ArrayList<RebateCodeServiceResponse> = ArrayList<RebateCodeServiceResponse>()
    var Article:ArticleResponse? = null
    var Transactions:ArrayList<RebateCodeTransactionQueryResponse> = ArrayList<RebateCodeTransactionQueryResponse>()
    var RemainingAmount:Double? = null
    var RemainingUsage:Int? = null
    var Customers:ArrayList<RebateCodeCustomerResponse> = ArrayList<RebateCodeCustomerResponse>()
    var ResponseStatus:ResponseStatus? = null
    var PaymentReceived:Boolean? = null
    var RebateCodeCurrencySign:String? = null
    var ActiveByStatus:Boolean? = null
    var PriceSign:String? = null
    var RebateCodeTypeName:String? = null
}

open class DaysOfWeekResponse
{
    var Id:Int? = null
    var DayOfWeek:String? = null
    var DayOfWeekTranslation:String? = null
    var DayOfWeekActive:Boolean? = null
    var DayOfWeekSortOrder:Short? = null
}

open class RebateCodeServiceResponse
{
    var Id:Int? = null
    var Name:String? = null
    var Description:String? = null
    var Active:Boolean? = null
}

open class ArticleResponse
{
    var CompanyId:UUID? = null
    var Id:Int? = null
    var Name:String? = null
    var ArticleTypeId:Int? = null
    var Description:String? = null
    var ImageUrl:String? = null
    var Active:Boolean? = null
    var Amount:Int? = null
    var Price:Double? = null
    var CurrencyId:String? = null
    var UpdatedDate:Date? = null
    var CreatedDate:Date? = null
    var Services:ArrayList<ArticleServiceRelation> = ArrayList<ArticleServiceRelation>()
    var ServiceIds:ArrayList<Int> = ArrayList<Int>()
    var PriceSign:String? = null
}

open class ArticleServiceRelation : BaseModel()
{
    @Required()
    var CompanyId:UUID? = null

    var Id:Int? = null
    @Required()
    var ServiceId:Int? = null

    @Required()
    var ArticleId:Int? = null
}

open class BaseModel
{
}

open class RebateCodeTransactionQueryResponse
{
    var Id:Int? = null
    var CompanyId:UUID? = null
    var Note:String? = null
    var RebateCodeId:Int? = null
    var RebateCodeSign:String? = null
    var RebateCodeTypeId:Int? = null
    var RebateCodeTypeName:String? = null
    var Amount:Double? = null
    var BookingId:Int? = null
    var UpdatedDate:Date? = null
    var CreatedDate:Date? = null
    var Service:RebateCodeServiceResponse? = null
    var Customer:RebateCodeCustomerResponse? = null
    var PriceSign:String? = null
}

open class RebateCodeCustomerResponse
{
    var Id:UUID? = null
    var Firstname:String? = null
    var Lastname:String? = null
    var Email:String? = null
    var Phone:String? = null
    var ImageUrl:String? = null
}

Kotlin CreateArticleRebateCode DTOs

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

HTTP + JSV

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

POST /rebatecodes/fromarticle HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	ArticleId: 0,
	Customer: 
	{
		CustomerId: 00000000-0000-0000-0000-000000000000,
		Firstname: String,
		Lastname: String,
		Email: String,
		Phone: String,
		SubscribedToNewsletter: False
	},
	Receiver: 
	{
		CustomerId: 00000000-0000-0000-0000-000000000000,
		Firstname: String,
		Lastname: String,
		Email: String,
		ReceiverMessage: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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