beautypg.com

Google Apps Security and Compliance Services Web Services Application Programming Interface Guide, Early Access Version 1.5 User Manual

Page 46

background image

44

Message Security and Compliance Application Programming Interface Guide RELEASE EA version 1.5

Exceptions

When handling exceptions, use the exception name (example:
AdminBlockException). Some exceptions also have text strings. Any exception
string should not be used to identify an exception. These strings are subject to
change across releases.

test Operation Exception

StatusException -- This exception is used to trigger an exception without a real
problem in the system. This exception is used by the User Sync API’s test
utility. If the test utility is called with a ‘false’ value to test the exception
connection between the web service and your application, the StatusException
is returned for a successful round-trip connection.

GetUsers Operation Exception

InvalidCriteriaException -- The search criteria could not possibly return any
results, or conflicting search criteria where specified. For more information, see
the GetUsers operation’s “Exceptions” on page 51.

API Infrastructure Exceptions

AdminBlockException -- Specified API license key blocked for
Administrative Reasons

InternalException -- Internal exceptions caused by server-side problems

InvalidValueException -- One or more element values does not validate.

MalformedKeyException -- Malformed API license key

MissingElementException -- One or more required elements is missing
from the input.

NoSuchKeyException -- Specified API license key does not Exist

UnknownInternalException -- Exceptions caused by unhandled server-side
problems

For more information about the Infrastructure exceptions, see “Exception
Management” on page 20.