WebServices Error Codes - PaperCutSoftware/PaperCutExamples GitHub Wiki
Web Services API Error codes
XML-RPC calls can return either application data, or an XML error payload. The error payload has two fields -- an error code and an error string (message). See the XML-RPC specification for more details
In PaperCut MF 19.2 and above web service API calls return distinct error codes if something goes wrong. This provides a simple way to handle errors in your script or program (instead of parsing error strings).
(Note: in PaperCut MF 19.1 and below you will need to use the legacy approach and inspect the error strings)
You can check the PaperCut MF application server version using the system health API (Base System Health).
The current error codes are:
Error code | Error String |
---|---|
257 | General/Unknown error |
258 | Password cannot be blank |
259 | Username cannot be blank |
260 | Property name cannot be blank |
261 | The property is invalid |
262 | User cannot be found |
263 | Group cannot be found |
264 | The overdraft value is invalid |
265 | Invalid printer cost adjustment rate (i.e less than 0) |
266 | Invalid home directory path |
267 | User alias is not unique |
268 | Email is not unique |
269 | Email is not valid |
270 | Password can only be set on internal users |
271 | PIN is invalid |
272 | PIN is not unique |
273 | PIN doesn’t contain enough characters |
274 | Cannot set balance using this method with multiple-personal-accounts enabled |
275 | Balance value not valid |
276 | ID is blank |
277 | User alias is blank |
278 | Full name is blank |
279 | Email address is blank |
280 | Group name was blank |
281 | Specified server name is blank |
282 | Printer/Device name is blank |
283 | Printer/Device was not found |
284 | No printers were found on the specified server |
285 | Cost model type is invalid |
286 | No devices were found on the server. |
287 | Authentication password was less than 8 characters(SNMPv3) |
288 | Privacy password was less than 8 characters(SNMPv3) |
289 | Authentication was the wrong protocol (SNMPv3) |
290 | Privacy password was the wrong protocol (SNMPv3) |
291 | Invalid page cost |
292 | Printer was not configured in cost model type simple |
293 | Group is already listed in the printer group access list. |
294 | The supplied schedule period is blank. |
295 | Invalid schedule period |
296 | Custom schedule period is not supported |
297 | Invalid quota amount |
298 | The specified group is special and cannot be deleted |
299 | Username must be unique |
300 | Unexpected error creating internal user |
301 | Shared account name is blank |
302 | The new shared account name is blank |
303 | The parent account was not found |
304 | Shared account name is not unique |
305 | Account Comment Option is invalid |
306 | Account Invoice Option is invalid |
307 | Internal users feature is not enabled. |
308 | Parent account cannot be renamed to sub account |
309 | Shared accounts cannot be moved between parents |
310 | Sub shared account name cannot be blank. |
311 | Shared account name is not unique |
312 | Error processing job details |
313 | Error processing job |
314 | Invalid job details item |
315 | Job details missing required field |
316 | Shared account not found |
317 | Personal account not found |
318 | Authentication token is blank |
319 | Invalid authentication token supplied |
320 | User does not have an account of this type. |
321 | Supplied path name is blank. |
322 | Cannot find file at given path. |
323 | Cannot read file at given path |
324 | Cannot access file. |
325 | Invalid overdraft mode |
326 | Error saving report. |
327 | Error processing data parameters |
328 | User with that username already exists. |
329 | Error sending confirmation email, provided email is blank. |