Registrar Web Services

R_CreateBrandCommissionOrderRequest

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
OPTIONS, POST, GET	/R_CreateBrandCommissionOrder

**R_CreateBrandCommissionOrderRequest** Parameters:
Name	Parameter	Data Type	Required	Description
BrandId	body	long	Yes	BrandId is Commission Order
BrandCommissionPriceId	body	long	Yes	Id of mapping record which maps the Price plan and Brand
StartDateTime	body	DateTime	No	Start date time of order and by default it starts right away
EndDateTime	body	DateTime	No	End date time of order and by default there is no end date time for Order

**BaseAdminRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Requester	form	string	No	Identity of the caller

**R_CreateBrandCommissionOrderResponse** Parameters:
Name	Parameter	Data Type	Required	Description
BrandCommissionOrder	form	R_BrandCommissionOrder	No

**R_BrandCommissionOrder** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
BrandId	form	long	No
BrandCommissionPriceId	form	long	No
BrandCommissionStatusId	form	long	No
StartDateTime	form	DateTime	No
EndDateTime	form	DateTime?	No
TotalPrice	form	decimal	No
CreateDateTime	form	DateTime	No
UpdatedDateTime	form	DateTime?	No
CurrentIntervalCount	form	long	No
BrandCommissionTransactions	form	IEnumerable<R_BrandCommissionTransaction>	No
BrandCommissionPrice	form	R_BrandCommissionPrice	No
BrandOwners	form	IEnumerable<R_BrandOwner>	No
Brand	form	R_Brand	No

**R_BrandCommissionTransaction** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
BrandCommissionOrderId	form	long	No
BrandCommissionStatusId	form	long	No
Amount	form	decimal	No
Notes	form	string	No
StartDateTime	form	DateTime	No
EndDateTime	form	DateTime	No
CreateDateTime	form	DateTime	No
UpdatedDateTime	form	DateTime?	No
TotalNumberOfUnits	form	long	No
TotalNumberOfActiveSubscriptions	form	long	No
BrandCommissionOrder	form	R_BrandCommissionOrder	No

**R_BrandCommissionPrice** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
BrandId	form	long	No
CommissionPriceId	form	long	No
UpdatedDateTime	form	DateTime?	No
CreateDateTime	form	DateTime	No
CommissionBrands	form	List<R_Brand>	No
CommissionPrice	form	R_CommissionPrice	No

**R_Brand** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
ParentBrandId	form	long?	No
Name	form	string	No
BrandTypeId	form	long	No
BrandName	form	string	No
LogoUrl	form	string	No
LicenseUrl	form	string	No
ActivationUrl	form	string	No
CompanyInfo	form	R_Company	No
InvoicedEmailTemplate	form	string	No
PaymentConfirmationEmailTemplate	form	string	No
ReceiptEmailTemplate	form	string	No
RtuActivatedEmailTemplate	form	string	No
RtuDeactivatedEmailTemplate	form	string	No
CreditCardWarning1EmailTemplate	form	string	No
CreditCardWarning2EmailTemplate	form	string	No
CreditCardWarning3EmailTemplate	form	string	No
CreditCardUpdateUrl	form	string	No
PaymentFailureEmailTemplate	form	string	No
Dunning1EmailTemplate	form	string	No
Dunning2EmailTemplate	form	string	No
Dunning3EmailTemplate	form	string	No
Dunning4EmailTemplate	form	string	No
DunningUpdateUrl	form	string	No
RefundEmailTemplate	form	string	No
TransferUnitEmailTemplate	form	string	No
ResetCustomerPasswordEmailTemplate	form	string	No
TotalNumberOfRecords	form	long	No

**R_Company** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Url	form	string	No
LogoUrl	form	string	No
Street	form	string	No
City	form	string	No
State	form	string	No
Zip	form	string	No
Phone	form	string	No
Email	form	string	No
CustomerSupportPhoneNumber	form	string	No
CustomerSupportEmail	form	string	No
CustomerSupportHours	form	string	No

**R_CommissionPrice** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Name	form	string	No
Description	form	string	No
MinimumNumberOfDays	form	long	No
Price	form	decimal	No
Interval	form	long	No
IntervalCount	form	long	No
UpdatedDateTime	form	DateTime?	No
CreateDateTime	form	DateTime	No
BrandCommissionPrice	form	R_BrandCommissionPrice	No

**R_BrandOwner** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
UserId	form	long	No
BrandId	form	long	No
FirstName	form	string	No
LastName	form	string	No
UpdatedDateTime	form	DateTime?	No
CreateDateTime	form	DateTime	No
AddressLine1	form	string	No
AddressLine2	form	string	No
City	form	string	No
State	form	string	No
Country	form	string	No
ZipCode	form	string	No
Email	form	string	No
Phone	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.

POST /jsv/reply/R_CreateBrandCommissionOrderRequest HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/jsv
Content-Length: length

{
	BrandId: 0,
	BrandCommissionPriceId: 0,
	StartDateTime: 0001-01-01,
	EndDateTime: 0001-01-01,
	Requester: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	BrandCommissionOrder: 
	{
		Id: 0,
		BrandId: 0,
		BrandCommissionPriceId: 0,
		BrandCommissionStatusId: 0,
		StartDateTime: 0001-01-01,
		EndDateTime: 0001-01-01,
		TotalPrice: 0,
		CreateDateTime: 0001-01-01,
		UpdatedDateTime: 0001-01-01,
		CurrentIntervalCount: 0,
		BrandCommissionPrice: 
		{
			Id: 0,
			BrandId: 0,
			CommissionPriceId: 0,
			UpdatedDateTime: 0001-01-01,
			CreateDateTime: 0001-01-01,
			CommissionBrands: 
			[
				{
					Id: 0,
					ParentBrandId: 0,
					Name: String,
					BrandTypeId: 0,
					BrandName: String,
					LogoUrl: String,
					LicenseUrl: String,
					ActivationUrl: String,
					CompanyInfo: 
					{
						Name: String,
						Url: String,
						LogoUrl: String,
						Street: String,
						City: String,
						State: String,
						Zip: String,
						Phone: String,
						Email: String,
						CustomerSupportPhoneNumber: String,
						CustomerSupportEmail: String,
						CustomerSupportHours: String
					},
					InvoicedEmailTemplate: String,
					PaymentConfirmationEmailTemplate: String,
					ReceiptEmailTemplate: String,
					RtuActivatedEmailTemplate: String,
					RtuDeactivatedEmailTemplate: String,
					CreditCardWarning1EmailTemplate: String,
					CreditCardWarning2EmailTemplate: String,
					CreditCardWarning3EmailTemplate: String,
					CreditCardUpdateUrl: String,
					PaymentFailureEmailTemplate: String,
					Dunning1EmailTemplate: String,
					Dunning2EmailTemplate: String,
					Dunning3EmailTemplate: String,
					Dunning4EmailTemplate: String,
					DunningUpdateUrl: String,
					RefundEmailTemplate: String,
					TransferUnitEmailTemplate: String,
					ResetCustomerPasswordEmailTemplate: String,
					TotalNumberOfRecords: 0
				}
			],
			CommissionPrice: 
			{
				Id: 0,
				Name: String,
				Description: String,
				MinimumNumberOfDays: 0,
				Price: 0,
				Interval: 0,
				IntervalCount: 0,
				UpdatedDateTime: 0001-01-01,
				CreateDateTime: 0001-01-01,
				BrandCommissionPrice: 
				{
					Id: 0,
					BrandId: 0,
					CommissionPriceId: 0,
					UpdatedDateTime: 0001-01-01,
					CreateDateTime: 0001-01-01,
					CommissionBrands: 
					[
						{
							Id: 0,
							ParentBrandId: 0,
							Name: String,
							BrandTypeId: 0,
							BrandName: String,
							LogoUrl: String,
							LicenseUrl: String,
							ActivationUrl: String,
							CompanyInfo: 
							{
								Name: String,
								Url: String,
								LogoUrl: String,
								Street: String,
								City: String,
								State: String,
								Zip: String,
								Phone: String,
								Email: String,
								CustomerSupportPhoneNumber: String,
								CustomerSupportEmail: String,
								CustomerSupportHours: String
							},
							InvoicedEmailTemplate: String,
							PaymentConfirmationEmailTemplate: String,
							ReceiptEmailTemplate: String,
							RtuActivatedEmailTemplate: String,
							RtuDeactivatedEmailTemplate: String,
							CreditCardWarning1EmailTemplate: String,
							CreditCardWarning2EmailTemplate: String,
							CreditCardWarning3EmailTemplate: String,
							CreditCardUpdateUrl: String,
							PaymentFailureEmailTemplate: String,
							Dunning1EmailTemplate: String,
							Dunning2EmailTemplate: String,
							Dunning3EmailTemplate: String,
							Dunning4EmailTemplate: String,
							DunningUpdateUrl: String,
							RefundEmailTemplate: String,
							TransferUnitEmailTemplate: String,
							ResetCustomerPasswordEmailTemplate: String,
							TotalNumberOfRecords: 0
						}
					],
					CommissionPrice: 
					{
						Id: 0,
						Name: String,
						Description: String,
						MinimumNumberOfDays: 0,
						Price: 0,
						Interval: 0,
						IntervalCount: 0,
						UpdatedDateTime: 0001-01-01,
						CreateDateTime: 0001-01-01,
						BrandCommissionPrice: 
						{
							Id: 0,
							BrandId: 0,
							CommissionPriceId: 0,
							UpdatedDateTime: 0001-01-01,
							CreateDateTime: 0001-01-01,
							CommissionBrands: 
							[
								{
									Id: 0,
									ParentBrandId: 0,
									Name: String,
									BrandTypeId: 0,
									BrandName: String,
									LogoUrl: String,
									LicenseUrl: String,
									ActivationUrl: String,
									CompanyInfo: 
									{
										Name: String,
										Url: String,
										LogoUrl: String,
										Street: String,
										City: String,
										State: String,
										Zip: String,
										Phone: String,
										Email: String,
										CustomerSupportPhoneNumber: String,
										CustomerSupportEmail: String,
										CustomerSupportHours: String
									},
									InvoicedEmailTemplate: String,
									PaymentConfirmationEmailTemplate: String,
									ReceiptEmailTemplate: String,
									RtuActivatedEmailTemplate: String,
									RtuDeactivatedEmailTemplate: String,
									CreditCardWarning1EmailTemplate: String,
									CreditCardWarning2EmailTemplate: String,
									CreditCardWarning3EmailTemplate: String,
									CreditCardUpdateUrl: String,
									PaymentFailureEmailTemplate: String,
									Dunning1EmailTemplate: String,
									Dunning2EmailTemplate: String,
									Dunning3EmailTemplate: String,
									Dunning4EmailTemplate: String,
									DunningUpdateUrl: String,
									RefundEmailTemplate: String,
									TransferUnitEmailTemplate: String,
									ResetCustomerPasswordEmailTemplate: String,
									TotalNumberOfRecords: 0
								}
							],
							CommissionPrice: 
							{
								Id: 0,
								Name: String,
								Description: String,
								MinimumNumberOfDays: 0,
								Price: 0,
								Interval: 0,
								IntervalCount: 0,
								UpdatedDateTime: 0001-01-01,
								CreateDateTime: 0001-01-01
							}
						}
					}
				}
			}
		},
		Brand: 
		{
			Id: 0,
			ParentBrandId: 0,
			Name: String,
			BrandTypeId: 0,
			BrandName: String,
			LogoUrl: String,
			LicenseUrl: String,
			ActivationUrl: String,
			CompanyInfo: 
			{
				Name: String,
				Url: String,
				LogoUrl: String,
				Street: String,
				City: String,
				State: String,
				Zip: String,
				Phone: String,
				Email: String,
				CustomerSupportPhoneNumber: String,
				CustomerSupportEmail: String,
				CustomerSupportHours: String
			},
			InvoicedEmailTemplate: String,
			PaymentConfirmationEmailTemplate: String,
			ReceiptEmailTemplate: String,
			RtuActivatedEmailTemplate: String,
			RtuDeactivatedEmailTemplate: String,
			CreditCardWarning1EmailTemplate: String,
			CreditCardWarning2EmailTemplate: String,
			CreditCardWarning3EmailTemplate: String,
			CreditCardUpdateUrl: String,
			PaymentFailureEmailTemplate: String,
			Dunning1EmailTemplate: String,
			Dunning2EmailTemplate: String,
			Dunning3EmailTemplate: String,
			Dunning4EmailTemplate: String,
			DunningUpdateUrl: String,
			RefundEmailTemplate: String,
			TransferUnitEmailTemplate: String,
			ResetCustomerPasswordEmailTemplate: String,
			TotalNumberOfRecords: 0
		}
	}
}