Registrar Web Services

<back to all web services

R_PublicBrands

The following routes are available for this service:
GET, OPTIONS/UserApi/R_Brands
GET, OPTIONS/UserApi/R_Brands/{Ids}
GET, OPTIONS/UserApi/R_Brands/BrandName/{BrandNames}
GET, OPTIONS/UserApi/R_Brands/Name/{Names}
R_PublicBrands Parameters:
NameParameterData TypeRequiredDescription
IdspathList<long>No
BrandNamespathList<string>No
NamespathList<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_PublicBrands HTTP/1.1 
Host: regapi.pumpalarm.com 
Content-Type: text/jsv
Content-Length: length

{
	Ids: 
	[
		0
	],
	BrandNames: 
	[
		String
	],
	Names: 
	[
		String
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

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