BootView WebApi

<back to all web services

GetBootCodes

The following routes are available for this service:
GET/gencodeReturns The Requested Code (s)
GetBootCodes Parameters:
NameParameterData TypeRequiredDescription
SerialNumberbodyStringYesThe serial # of the Boot for which codes are being requested
MasterArmingbodybooleanNoMaster Arming Request
MasterUnlockbodybooleanNoMaster Unlock Request
RotateUnlockYesterdayRequestbodybooleanNoRotate Unlock Yesterday Request
RotateUnlockTodayRequestbodybooleanNoRotate Unlock Today Request
RotateUnlockTomorrowRequestbodybooleanNoRotate Unlock Tomorrow Request
RotateLockRequestbodybooleanNoRotate Lock
StaticEnableDisableRequestbodybooleanNoStatic enable/disable
SetTimeRequestbodybooleanNoSet Time
BootCodesResult Parameters:
NameParameterData TypeRequiredDescription
MasterArmingProgrammingformstringNo
MasterUnlockProgrammingformstringNo
StaticToggleProgrammingformstringNo
SetTimeProgrammingformstringNo
RotateUnlockYesterdayformstringNo
RotateUnlockTodayformstringNo
RotateUnlockTomorrowformstringNo
RotateLockformstringNo

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/GetBootCodes HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/jsv
Content-Length: length

{
	serialNumber: String,
	masterArming: False,
	masterUnlock: False,
	rotateUnlockYesterdayRequest: False,
	rotateUnlockTodayRequest: False,
	rotateUnlockTomorrowRequest: False,
	rotateLockRequest: False,
	staticEnableDisableRequest: False,
	setTimeRequest: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	masterArmingProgramming: String,
	masterUnlockProgramming: String,
	staticToggleProgramming: String,
	setTimeProgramming: String,
	rotateUnlockYesterday: String,
	rotateUnlockToday: String,
	rotateUnlockTomorrow: String,
	rotateLock: String
}