Appendix C: License Information API : getDeviceLicenseList
 
getDeviceLicenseList
Use this request to obtain a list of device licenses.
Request Field
Description
<servicePass>
XML structure consists of username and password variables.
<userID>
The administrator user name.
<password>
Administrator password options:
Enter the administrator password.
Leave field blank for no password.
Example request:
<soapenv:Envelope xmlns:soapenv="http://..." xmlns:r20="http://.../">
<soapenv:Header/>
<soapenv:Body>
<r20:getDeviceLicenseList>
<!--Optional:-->
<servicePass>
<!--Optional:-->
<userID>admin</userID>
<!--Optional:-->
<password></password>
</servicePass>
</r20:getDeviceLicenseList>
</soapenv:Body>
</soapenv:Envelope>
The response includes the device serial number, support type, support level, and expiry date.
Response Field
Description
<serial_number>
The device serial number.
<support_type>
Support contract types include:
AVDB: Antivirus Signature Definition Update Support
AVEN: Antivirus Engine Update Support
COMP: Comprehensive Support
ENHN: Enhancement Support
FMWR: Firmware Update Support
FRVS: FortiScanner Database Update Support
FURL: Web Filtering Support
SPAM: AntiSpam Support
HDWR: Hardware Support
NIDS: Intrusion Detection Support
SPRT: Technical Support via Telephone
VCME: FortiGate Network scanner plugin
<support_level>
Support levels include:
99: Trial contract
10: 8x5 support contract
20: 24x7 support contract
<expiry_date>
Support contract expiry date.
Example response
<SOAP-ENV:Header/>
<SOAP-ENV:Body>
<ns3:getDeviceLicenseListResponse>
<return>
<device>
<serial_number>FE100C3909000002</serial_number>
<contract>
<support_type>AVDB</support_type>
<support_level>10</support_level>
<expiry_date>20120824</expiry_date>
</contract>
<contract>
<support_type>AVEN</support_type>
<support_level>10</support_level>
<expiry_date>20120824</expiry_date>
</contract>
<contract>
<support_type>NIDS</support_type>
<support_level>10</support_level>
<expiry_date>20120824</expiry_date>
</contract>
<contract>
<support_type>SPAM</support_type>
<support_level>10</support_level>
<expiry_date>20120824</expiry_date>
</contract>
<contract>
<support_type>SPRT</support_type>
<support_level>20</support_level>
<expiry_date>20120824</expiry_date>
</contract>
<contract>
<support_type>FRVS</support_type>
<support_level>10</support_level>
<expiry_date>20120824</expiry_date>
</contract>
</device>
</return>
</ns3:getDeviceLicenseListResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>