Registrar Web Services

<back to all web services

R_ProtectedAccountHolder

Requires Authentication
Required role:User
The following routes are available for this service:
PUT/UserApi/R_AccountHolders
R_ProtectedAccountHolder Parameters:
NameParameterData TypeRequiredDescription
DatabodyR_AccountHolderNo
R_AccountHolder Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AccountIdformlongNo
CreationDateTimeformDateTime?No
EmailformstringNo
PhoneNumberformstringNo
FirstNameformstringNo
LastNameformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateProvinceformstringNo
ZipCodeformstringNo
CountryformstringNo
CreditCardNumberformstringNo
CardCodeformstringNo
ExpirationMonthformint?No
ExpirationYearformint?No
NeedToUpdatePaymentInfoformboolNo
UpdatePaymentInfoDateformDateTime?No
TotalNumberOfRecordsformlongNo
R_AccountHolder Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
AccountIdformlongNo
CreationDateTimeformDateTime?No
EmailformstringNo
PhoneNumberformstringNo
FirstNameformstringNo
LastNameformstringNo
Address1formstringNo
Address2formstringNo
CityformstringNo
StateProvinceformstringNo
ZipCodeformstringNo
CountryformstringNo
CreditCardNumberformstringNo
CardCodeformstringNo
ExpirationMonthformint?No
ExpirationYearformint?No
NeedToUpdatePaymentInfoformboolNo
UpdatePaymentInfoDateformDateTime?No
TotalNumberOfRecordsformlongNo

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

{
	Data: 
	{
		Id: 0,
		AccountId: 0,
		CreationDateTime: 0001-01-01,
		Email: String,
		PhoneNumber: String,
		FirstName: String,
		LastName: String,
		Address1: String,
		Address2: String,
		City: String,
		StateProvince: String,
		ZipCode: String,
		Country: String,
		CreditCardNumber: String,
		CardCode: String,
		ExpirationMonth: 0,
		ExpirationYear: 0,
		NeedToUpdatePaymentInfo: False,
		UpdatePaymentInfoDate: 0001-01-01,
		TotalNumberOfRecords: 0
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	AccountId: 0,
	CreationDateTime: 0001-01-01,
	Email: String,
	PhoneNumber: String,
	FirstName: String,
	LastName: String,
	Address1: String,
	Address2: String,
	City: String,
	StateProvince: String,
	ZipCode: String,
	Country: String,
	CreditCardNumber: String,
	CardCode: String,
	ExpirationMonth: 0,
	ExpirationYear: 0,
	NeedToUpdatePaymentInfo: False,
	UpdatePaymentInfoDate: 0001-01-01,
	TotalNumberOfRecords: 0
}