Studebaker Submetering API Services

<back to all web services

Login

The following routes are available for this service:
All Verbs/login/Log the user in, and retrieve a login tokenAn invalid username/password will return an empty response

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

{
	requestIpAddress: String,
	username: String,
	password: String,
	passwordHash: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	loginToken: String,
	lastLogin: 0001-01-01,
	lastLoginUtc: 0001-01-01,
	formattedLastLogin: String,
	userType: 0,
	userId: String,
	name: String,
	newPasswordRequired: False,
	emailAddress: String,
	updatePasswordId: String,
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String
			}
		]
	}
}