Studebaker Submetering API Services

<back to all web services

GetProperty

The following routes are available for this service:
All Verbs/getPropertyGet property information.All available property names will always be provided.
Addresses for all properties will be included if IncludeAddresses=true.
Additional details for a specific property will also be provided if PropertyId is specified.

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/GetProperty HTTP/1.1 
Host: gallifrey.studebakersubmetering.com 
Content-Type: text/jsv
Content-Length: length

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

{
	properties: 
	[
		{
			propertyId: 0,
			name: String,
			integrationCode: String,
			address1: String,
			address2: String,
			address3: String,
			city: String,
			state: String,
			zipCode: String,
			contact: 
			{
				contactName: String,
				email: String,
				companyName: String,
				phone: String,
				phoneExtension: String,
				mobile: String,
				fax: String,
				faxExtension: String
			},
			integrationBatches: 
			[
				{
					batchReference: String,
					dateSent: 0001-01-01,
					totalDollarAmount: 0,
					totalCount: 0
				}
			],
			isCollectable: False,
			rubsFilesAreAvailable: False,
			password: String
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String
			}
		]
	}
}