Registrar Web Services

<back to all web services

R_Registration

Requires Authentication
Required role:Admin
The following routes are available for this service:
POST,OPTIONS/R_Registrations
PUT,OPTIONS/R_Registrations/{Id}
DELETE,OPTIONS/R_Registrations/{Id}
R_Registration Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
UnitIdbodystringNo
MerchantIdbodystringNo
CreationDateTimebodyDateTime?No
RegistrationStatusbodylongNo
AccountIdbodylong?No
ProductIdbodylongNo
ProductNamebodystringNo
PlanIdbodylong?No
PlanNamebodystringNo
SubscriptionIdbodylong?No
CellularServiceIdbodylong?No
BrandIdbodylongNo
BrandNamebodystringNo
EligibleBundleIdbodylong?No
BundleNamebodystringNo
ResellerIdbodylong?No
ResellerNamebodystringNo
CellularServicebodyR_CellularServiceNo
SubscriptionbodyR_SubscriptionNo
TotalNumberOfRecordsbodylongNo
R_CellularService Parameters:
NameParameterData TypeRequiredDescription
RegistrationIdformlongNo
UnitIdformstringNo
ProductNameformstringNo
CellDeviceIdformstringNo
DeviceSerialNumberformstringNo
PhoneNumberformstringNo
BrandNameformstringNo
ProfileIdformlongNo
CellularDeviceStateIdformlongNo
CreateDateTimeformDateTimeNo
LastUpdatDateTimeformDateTimeNo
ContactEmailformstringNo
IdformlongNo
TotalNumberOfRecordsformlongNo
R_Subscription Parameters:
NameParameterData TypeRequiredDescription
AccountHolderIdformlongNo
RegistrationIdformlongNo
UnitIdformstringNo
SubscriptionStatusTypeIdformlongNo
BrandIdformlongNo
StartDateformDateTimeNo
PreviousBillDateformDateTime?No
CurrentBillDateformDateTime?No
NextBillDateformDateTime?No
PaidUntilformDateTime?No
NumberOfOccurrencesformintNo
BillingIntervalformintNo
BillingIntervalTimeUnitIdformlongNo
TrialOccurrencesformint?No
TrialBillingIntervalformint?No
TrialBillingIntervalTimeUnitIdformlong?No
SubscriptionBillingStatusIdformlong?No
IdformlongNo
R_Registration Parameters:
NameParameterData TypeRequiredDescription
IdpathlongNo
UnitIdbodystringNo
MerchantIdbodystringNo
CreationDateTimebodyDateTime?No
RegistrationStatusbodylongNo
AccountIdbodylong?No
ProductIdbodylongNo
ProductNamebodystringNo
PlanIdbodylong?No
PlanNamebodystringNo
SubscriptionIdbodylong?No
CellularServiceIdbodylong?No
BrandIdbodylongNo
BrandNamebodystringNo
EligibleBundleIdbodylong?No
BundleNamebodystringNo
ResellerIdbodylong?No
ResellerNamebodystringNo
CellularServicebodyR_CellularServiceNo
SubscriptionbodyR_SubscriptionNo
TotalNumberOfRecordsbodylongNo

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

{
	Id: 0,
	UnitId: String,
	MerchantId: String,
	CreationDateTime: 0001-01-01,
	RegistrationStatus: 0,
	AccountId: 0,
	ProductId: 0,
	ProductName: String,
	PlanId: 0,
	PlanName: String,
	SubscriptionId: 0,
	CellularServiceId: 0,
	BrandId: 0,
	BrandName: String,
	EligibleBundleId: 0,
	BundleName: String,
	ResellerId: 0,
	ResellerName: String,
	CellularService: 
	{
		RegistrationId: 0,
		UnitId: String,
		ProductName: String,
		CellDeviceId: String,
		DeviceSerialNumber: String,
		PhoneNumber: String,
		BrandName: String,
		ProfileId: 0,
		CellularDeviceStateId: 0,
		CreateDateTime: 0001-01-01,
		LastUpdatDateTime: 0001-01-01,
		ContactEmail: String,
		Id: 0,
		TotalNumberOfRecords: 0
	},
	Subscription: 
	{
		AccountHolderId: 0,
		RegistrationId: 0,
		UnitId: String,
		SubscriptionStatusTypeId: 0,
		BrandId: 0,
		StartDate: 0001-01-01,
		PreviousBillDate: 0001-01-01,
		CurrentBillDate: 0001-01-01,
		NextBillDate: 0001-01-01,
		PaidUntil: 0001-01-01,
		NumberOfOccurrences: 0,
		BillingInterval: 0,
		BillingIntervalTimeUnitId: 0,
		TrialOccurrences: 0,
		TrialBillingInterval: 0,
		TrialBillingIntervalTimeUnitId: 0,
		SubscriptionBillingStatusId: 0,
		Id: 0
	},
	TotalNumberOfRecords: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	UnitId: String,
	MerchantId: String,
	CreationDateTime: 0001-01-01,
	RegistrationStatus: 0,
	AccountId: 0,
	ProductId: 0,
	ProductName: String,
	PlanId: 0,
	PlanName: String,
	SubscriptionId: 0,
	CellularServiceId: 0,
	BrandId: 0,
	BrandName: String,
	EligibleBundleId: 0,
	BundleName: String,
	ResellerId: 0,
	ResellerName: String,
	CellularService: 
	{
		RegistrationId: 0,
		UnitId: String,
		ProductName: String,
		CellDeviceId: String,
		DeviceSerialNumber: String,
		PhoneNumber: String,
		BrandName: String,
		ProfileId: 0,
		CellularDeviceStateId: 0,
		CreateDateTime: 0001-01-01,
		LastUpdatDateTime: 0001-01-01,
		ContactEmail: String,
		Id: 0,
		TotalNumberOfRecords: 0
	},
	Subscription: 
	{
		AccountHolderId: 0,
		RegistrationId: 0,
		UnitId: String,
		SubscriptionStatusTypeId: 0,
		BrandId: 0,
		StartDate: 0001-01-01,
		PreviousBillDate: 0001-01-01,
		CurrentBillDate: 0001-01-01,
		NextBillDate: 0001-01-01,
		PaidUntil: 0001-01-01,
		NumberOfOccurrences: 0,
		BillingInterval: 0,
		BillingIntervalTimeUnitId: 0,
		TrialOccurrences: 0,
		TrialBillingInterval: 0,
		TrialBillingIntervalTimeUnitId: 0,
		SubscriptionBillingStatusId: 0,
		Id: 0
	},
	TotalNumberOfRecords: 0
}