Registrar Web Services

<back to all web services

R_BrandCommissionOrder

Insert, Update or Delete R_BrandCommissionOrder resource

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST/R_BrandCommissionOrder
PUT/R_BrandCommissionOrder/{Id}
DELETE/R_BrandCommissionOrder/{Id}
R_BrandCommissionOrder Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
BrandIdbodylongNo
BrandCommissionPriceIdbodylongNo
BrandCommissionStatusIdbodylongNo
StartDateTimebodyDateTimeNo
EndDateTimebodyDateTime?No
TotalPricebodydecimalNo
CreateDateTimebodyDateTimeNo
UpdatedDateTimebodyDateTime?No
CurrentIntervalCountbodylongNo
BrandCommissionTransactionsbodyIEnumerable<R_BrandCommissionTransaction>No
BrandCommissionPricebodyR_BrandCommissionPriceNo
BrandOwnersbodyIEnumerable<R_BrandOwner>No
BrandbodyR_BrandNo
R_BrandCommissionTransaction Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
BrandCommissionOrderIdformlongNo
BrandCommissionStatusIdformlongNo
AmountformdecimalNo
NotesformstringNo
StartDateTimeformDateTimeNo
EndDateTimeformDateTimeNo
CreateDateTimeformDateTimeNo
UpdatedDateTimeformDateTime?No
TotalNumberOfUnitsformlongNo
TotalNumberOfActiveSubscriptionsformlongNo
BrandCommissionOrderformR_BrandCommissionOrderNo
R_BrandCommissionPrice Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
BrandIdformlongNo
CommissionPriceIdformlongNo
UpdatedDateTimeformDateTime?No
CreateDateTimeformDateTimeNo
CommissionBrandsformList<R_Brand>No
CommissionPriceformR_CommissionPriceNo
R_Brand Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ParentBrandIdformlong?No
NameformstringNo
BrandTypeIdformlongNo
BrandNameformstringNo
LogoUrlformstringNo
LicenseUrlformstringNo
ActivationUrlformstringNo
CompanyInfoformR_CompanyNo
InvoicedEmailTemplateformstringNo
PaymentConfirmationEmailTemplateformstringNo
ReceiptEmailTemplateformstringNo
RtuActivatedEmailTemplateformstringNo
RtuDeactivatedEmailTemplateformstringNo
CreditCardWarning1EmailTemplateformstringNo
CreditCardWarning2EmailTemplateformstringNo
CreditCardWarning3EmailTemplateformstringNo
CreditCardUpdateUrlformstringNo
PaymentFailureEmailTemplateformstringNo
Dunning1EmailTemplateformstringNo
Dunning2EmailTemplateformstringNo
Dunning3EmailTemplateformstringNo
Dunning4EmailTemplateformstringNo
DunningUpdateUrlformstringNo
RefundEmailTemplateformstringNo
TransferUnitEmailTemplateformstringNo
ResetCustomerPasswordEmailTemplateformstringNo
TotalNumberOfRecordsformlongNo
R_Company Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
UrlformstringNo
LogoUrlformstringNo
StreetformstringNo
CityformstringNo
StateformstringNo
ZipformstringNo
PhoneformstringNo
EmailformstringNo
CustomerSupportPhoneNumberformstringNo
CustomerSupportEmailformstringNo
CustomerSupportHoursformstringNo
R_CommissionPrice Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
NameformstringNo
DescriptionformstringNo
MinimumNumberOfDaysformlongNo
PriceformdecimalNo
IntervalformlongNo
IntervalCountformlongNo
UpdatedDateTimeformDateTime?No
CreateDateTimeformDateTimeNo
BrandCommissionPriceformR_BrandCommissionPriceNo
R_BrandOwner Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
UserIdformlongNo
BrandIdformlongNo
FirstNameformstringNo
LastNameformstringNo
UpdatedDateTimeformDateTime?No
CreateDateTimeformDateTimeNo
AddressLine1formstringNo
AddressLine2formstringNo
CityformstringNo
StateformstringNo
CountryformstringNo
ZipCodeformstringNo
EmailformstringNo
PhoneformstringNo
R_BrandCommissionOrder Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
BrandIdbodylongNo
BrandCommissionPriceIdbodylongNo
BrandCommissionStatusIdbodylongNo
StartDateTimebodyDateTimeNo
EndDateTimebodyDateTime?No
TotalPricebodydecimalNo
CreateDateTimebodyDateTimeNo
UpdatedDateTimebodyDateTime?No
CurrentIntervalCountbodylongNo
BrandCommissionTransactionsbodyIEnumerable<R_BrandCommissionTransaction>No
BrandCommissionPricebodyR_BrandCommissionPriceNo
BrandOwnersbodyIEnumerable<R_BrandOwner>No
BrandbodyR_BrandNo

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_BrandCommissionOrder HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/jsv
Content-Length: length

{
	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
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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