Error Messages

All service calls, except list_clients, expect a valid parameter to be passed along. If the parameter is missing, or if it is not valid, the service returns the following error messages:

Error	Code
Invalid parameter	4
Missing parameter	5

The following examples use the list_av_history service call, which requires the numeric deviceid to return the expected results. If these conditions are not met, the status attribute is set to FAIL and instead of the <items> node there is an <error> node with an indication of the problem.

Example 1 — Successful call

https://SERVER/api/?apikey=yourAPIkey&service=list_av_history&deviceid=DEVICEID

Example 1 response

<result created="2015-07-17T12:28:49-04:00" host="www.SERVER" status="OK">
<checks>
<name>Antivirus Update Check - Managed Antivirus</name>
</checks>
<days>
<day>
<date>2015-04-18</date>
<status>PASS</status>
</day>
...
<day>
<date>2015-07-17</date>
<status>PASS</status>
</day>
</days>
</result>

Example 2 — Missing parameter

https://SERVER/api/?apikey=yourAPIkey&service=list_av_history&deviceif=DEVICEID

Example 2 response

<result created="2015-07-17T11:16:37-05:00" host="www.SERVER" status="FAIL">
<error>
<errorcode>5</errorcode>
<message>Missing parameter: deviceid</message>
</error>
</result>

Example 3 — Invalid parameter

https://SERVER/api/?apikey=yourAPIkey&service=list_av_history&deviceid=workstation

Example 3 response

<result created="2015-07-17T11:16:37-05:00" host="www.SERVER" status="FAIL">
<error>
<errorcode>4</errorcode>
<message>Invalid value for parameter: deviceid</message>
</error>
</result>