Studebaker Submetering API Services

<back to all web services

GetAllDelinquencyLetters

The following routes are available for this service:
All Verbs/getAllDelinquencyLettersGets all the delinquency letters for a specified property
Parameters:
NameParameterData TypeRequiredDescription
PropertyIdpathstringYesProperty id

To override the Content-type in your clients 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/GetAllDelinquencyLetters HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: text/jsv
Content-Length: length

{
	propertyId: 0,
	minimumDaysOverdue: 0,
	daysThresholdValue: 0,
	minimumValueOverdue: 0,
	returnRawData: False,
	requestIpAddress: String,
	token: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	letters: 
	[
		{
			tenantId: 0,
			tenantName: 
			{
				prefix: String,
				firstName: String,
				lastName: String,
				suffix: String
			},
			letterText: String,
			rawData: 
			{
				todaysDate: String,
				tenantId: 0,
				account: 0,
				namePrefix: String,
				firstName: String,
				lastName: String,
				nameSuffix: String,
				headCount: 0,
				serviceAddress1: String,
				serviceAddress2: String,
				serviceAddress3: String,
				serviceCity: String,
				serviceState: String,
				serviceZip: String,
				billingaddress1: String,
				billingaddress2: String,
				billingaddress3: String,
				billingcity: String,
				billingstate: String,
				billingzip: String,
				phone1: String,
				phone2: String,
				fax: String,
				email: String,
				moveInDate: String,
				moveOutDate: String,
				balance: 0,
				lastPaymentDate: String,
				lastPaymentAmount: 0,
				adminFeeAmount: 0,
				billingStartDate: String,
				printBill: False,
				isExempt: False,
				pmsAccount: String,
				totalAmountOverdue: 0,
				maximumDaysLate: 0,
				minimumDaysLate: 0,
				noOfOverdueInvoices: 0,
				fullBillingAddress: String
			}
		}
	]
}