beautypg.com

Errors, Return values – Google Message Security Batch Reference Guide User Manual

Page 272

background image

Batch Commands

275

This is a positional parameter and is optional. If used, the parameter must be
at the end of the command. There is no numeric equivalent.

EZCommand Description for suspenduser

See the Batch Interface Description for suspenduser for general usage details.

When used as an EZCommand, the command must be URL-escaped in order to
properly submitted. For example:

suspenduser [email protected], notify

changes to

suspenduser%20msmith%40jumboinc.com%20notify

Errors

Batch command interface errors:

Possible errors include:

‘No such user ‘username’ (unknown administrator address supplied).’

‘String authorization failed.’

‘No commands to process.’

‘Command not recognized: command.’

‘You don’t have permission to insert users into org name.’

‘No such organization ‘org name’.’

‘No default user available for organization org name.’

‘No secret key in database.’

If suspending the user was not successful, possible errors are:

‘No arguments supplied.’

‘No user ‘username.’

‘You don’t have permission to suspend user name.’

Return Values

Batch command interface return values:

If

[email protected]

was suspended, this string is returned:

‘Suspended user [email protected].’

If a particular delivery was included, a <

delivery_status

> would be included

after the user’s name in the return value.

When used as an EZCommand, the HTTP response will contain a two-part
return value: