Registrar Web Services

<back to all web services

R_CanActivateRegistrationRequest

The following routes are available for this service:
OPTIONS, POST/PublicApi/R_CanActivateRegistrationRequest
OPTIONS, POST/R_CanActivateRegistrationRequest
R_CanActivateRegistrationRequest Parameters:
NameParameterData TypeRequiredDescription
UnitIdbodystringNo
AccountIdbodylong?No
R_CanActivateRegistrationResponse Parameters:
NameParameterData TypeRequiredDescription
CanActivateformboolNo
IsExchangeableformboolNo
RegistrationIdformlongNo
BrandformR_BrandNo
ExchangeReasonformstringNo
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

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

{
	UnitId: String,
	AccountId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CanActivate: False,
	IsExchangeable: False,
	RegistrationId: 0,
	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
	},
	ExchangeReason: String
}