Error Messages
Apart from list_clients all other service calls expect a valid parameter to be passed along. If the parameter is missing, or it is not valid, the service will return the following error messages.
|
Invalid parameters |
4 |
|
Missing parameters |
5 |
The following examples user the list_av_history service call, this requires the numeric deviceid to return the expected results. Where these conditions are not met the status attribute is set to FAIL and instead of the <items> node there is now an <error> node with an indication of the problem.
|
Example Service Call - Success |
|
https://SERVER/api/?apikey=yourAPItoken&service=list_av_history&deviceid=DEVICEID |
|
Example 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 Service Call - Missing Parameter |
|
https://SERVER/api/?apikey=yourAPItoken&service=list_av_history&deviceif=DEVICEID |
|
Example 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 Service Call - Invalid Parameter |
|
https://SERVER/api/?apikey=yourAPItoken&service=list_av_history&deviceid=workstation |
|
Example 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> |