Registrar Web Services

<back to all web services

R_TransactionSummary

Requires Authentication
Required role:Admin
The following routes are available for this service:
OPTIONS/R_TransactionSummary
R_TransactionSummary Parameters:
NameParameterData TypeRequiredDescription
IdquerylongNo
ProductNamequerystringNo
TransactionsqueryList<R_Transaction>No
RegistrationqueryR_RegistrationNo
R_Transaction Parameters:
NameParameterData TypeRequiredDescription
SubscriptionIdformlongNo
GatewayTransactionIdformstringNo
TransactionTypeIdformlongNo
TransactionStatusIdformlongNo
AmountformdecimalNo
CardformstringNo
CurrencyIdformlongNo
CreateDateformDateTimeNo
InvoiceIdformlong?No
GatewayResponseformstringNo
TransactionNotificationStatusIdformlongNo
SettlementDateformDateTime?No
RelatedTransactionIdformlong?No
RelatedGatewayTransactionIdformstringNo
IdformlongNo
R_Registration Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
UnitIdformstringNo
MerchantIdformstringNo
CreationDateTimeformDateTime?No
RegistrationStatusformlongNo
AccountIdformlong?No
ProductIdformlongNo
ProductNameformstringNo
PlanIdformlong?No
PlanNameformstringNo
SubscriptionIdformlong?No
CellularServiceIdformlong?No
BrandIdformlongNo
BrandNameformstringNo
EligibleBundleIdformlong?No
BundleNameformstringNo
ResellerIdformlong?No
ResellerNameformstringNo
CellularServiceformR_CellularServiceNo
SubscriptionformR_SubscriptionNo
TotalNumberOfRecordsformlongNo
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_TransactionSummary Parameters:
NameParameterData TypeRequiredDescription
IdquerylongNo
ProductNamequerystringNo
TransactionsqueryList<R_Transaction>No
RegistrationqueryR_RegistrationNo

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

{
	Id: 0,
	ProductName: String,
	Transactions: 
	[
		{
			SubscriptionId: 0,
			GatewayTransactionId: String,
			TransactionTypeId: 0,
			TransactionStatusId: 0,
			Amount: 0,
			Card: String,
			CurrencyId: 0,
			CreateDate: 0001-01-01,
			InvoiceId: 0,
			GatewayResponse: String,
			TransactionNotificationStatusId: 0,
			SettlementDate: 0001-01-01,
			RelatedTransactionId: 0,
			RelatedGatewayTransactionId: String,
			Id: 0
		}
	],
	Registration: 
	{
		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,
	ProductName: String,
	Transactions: 
	[
		{
			SubscriptionId: 0,
			GatewayTransactionId: String,
			TransactionTypeId: 0,
			TransactionStatusId: 0,
			Amount: 0,
			Card: String,
			CurrencyId: 0,
			CreateDate: 0001-01-01,
			InvoiceId: 0,
			GatewayResponse: String,
			TransactionNotificationStatusId: 0,
			SettlementDate: 0001-01-01,
			RelatedTransactionId: 0,
			RelatedGatewayTransactionId: String,
			Id: 0
		}
	],
	Registration: 
	{
		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
	}
}