BokaMera.API.Host

GetRebateCodeBySign

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

**GetRebateCodeBySign** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	query	Guid	Yes
RebateCodeSign	query	string	Yes
ServiceId	query	int	Yes
Date	query	DateTime	No	The datetime for when to check if the code is valid
IncludeConnectedServices	query	bool	Yes
IncludeConnectedDaysOfWeek	query	bool	No
IncludeConnectedCustomers	query	bool	No

**RebateCodeResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Id	form	int	No
CompanyId	form	Guid?	No
ValidFrom	form	DateTime	No
ValidTo	form	DateTime	No
FromTime	form	TimeSpan	No	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.
ToTime	form	TimeSpan	No	If the price is only valid for a specific time span during a time of day enter the FromTime and ToTime parameters.
CreatedBy	form	string	No
Created	form	DateTime	No
UpdatedBy	form	string	No
Updated	form	DateTime	No
PersonalNote	form	string	No
RebateCodeSign	form	string	No
RebateCodeValue	form	int	No
RebateCodeTypeId	form	int	No
Name	form	string	No
RebateCodeStatusId	form	int	No
StatusName	form	string	No
MaxNumberOfUses	form	int	No
MaxNumberOfUsesPerCustomer	form	int	No
NumberOfUsesUsed	form	int	No
NumberOfUsesPerCustomerUsed	form	int	No
DaysOfWeek	form	List<DaysOfWeekResponse>	No
Services	form	List<RebateCodeServiceResponse>	No
Customers	form	List<RebateCodeCustomerResponse>	No
RebateCodeTypesOptions	form	List<RebateCodeTypeResponse>	No
RebateCodeStatusOptions	form	List<RebateCodeStatusResponse>	No
ResponseStatus	form	ResponseStatus	No

**DaysOfWeekResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
DayOfWeek	form	string	No
DayOfWeekTranslation	form	string	No
DayOfWeekActive	form	bool?	No
DayOfWeekSortOrder	form	short?	No

**RebateCodeServiceResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Description	form	string	No
Active	form	bool	No

**RebateCodeCustomerResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	Guid	No
Firstname	form	string	No
Lastname	form	string	No
Email	form	string	No
Phone	form	string	No
ImageUrl	form	string	No

**RebateCodeTypeResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
RebateCodeTypeItems	form	List<RebateCodeTypeItem>	No

**RebateCodeTypeItem** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Name	form	string	No
Description	form	string	No

**RebateCodeStatusResponse** Parameters:
Name	Parameter	Data Type	Required	Description
ResponseStatus	form	ResponseStatus	No
RebateCodeStatusItems	form	List<RebateCodeStatusItem>	No

**RebateCodeStatusItem** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
RebateCodeStatusName	form	string	No
RebateCodeStatusDescription	form	string	No

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.

GET /rebatecodes/getbysign HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv

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,
	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
		}
	}
}