Registrar Web Services

<back to all web services

R_ProtectedBrandCommissionPrices

Returns a list of R_BrandCommissionPrices resource for given filters

Requires Authentication
Required role:BrandOwner
The following routes are available for this service:
GET/UserApi/R_BrandCommissionPrices
R_ProtectedBrandCommissionPrices Parameters:
NameParameterData TypeRequiredDescription
IdsqueryList<long>No
IncludeCommissionPricequeryboolNo
StartIndexquerylong?No
NumberOfRecordsquerylong?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_ProtectedBrandCommissionPrices HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/jsv
Content-Length: length

{
	Ids: 
	[
		0
	],
	IncludeCommissionPrice: False,
	StartIndex: 0,
	NumberOfRecords: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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