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 .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/GetBootCodes HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<GetBootCodes xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <MasterArming>false</MasterArming>
  <MasterUnlock>false</MasterUnlock>
  <RotateLockRequest>false</RotateLockRequest>
  <RotateUnlockTodayRequest>false</RotateUnlockTodayRequest>
  <RotateUnlockTomorrowRequest>false</RotateUnlockTomorrowRequest>
  <RotateUnlockYesterdayRequest>false</RotateUnlockYesterdayRequest>
  <SerialNumber>String</SerialNumber>
  <SetTimeRequest>false</SetTimeRequest>
  <StaticEnableDisableRequest>false</StaticEnableDisableRequest>
</GetBootCodes>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BootCodesResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <MasterArmingProgramming>String</MasterArmingProgramming>
  <MasterUnlockProgramming>String</MasterUnlockProgramming>
  <RotateLock>String</RotateLock>
  <RotateUnlockToday>String</RotateUnlockToday>
  <RotateUnlockTomorrow>String</RotateUnlockTomorrow>
  <RotateUnlockYesterday>String</RotateUnlockYesterday>
  <SetTimeProgramming>String</SetTimeProgramming>
  <StaticToggleProgramming>String</StaticToggleProgramming>
</BootCodesResult>