beautypg.com

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

Page 30

background image

28

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

See Also

“AutomatedBatch Reference Basics” on page 36, “About the User Sync API” on
page 39.

Operation

GetServiceEndpoint

Request: GetServiceEndpoint

Response:

Description

Performs a lookup using the specified email address. The operation maps the
cluster returned into the appropriate endpoint URI.

apiKey -- A global unique 48 character string identifying the customer and the
client application. For more information, see “API License Key” on page 19.

email -- A user’s email address as type string, for example
[email protected].

service -- v2AutomatedBatch. For more information about AutomatedBatch,
see “AutomatedBatch Reference Basics” on page 36.

Note:

The Endpoint Resolver web service is not recommended for use with

JAX.WS 2.0.

Response

Either an Endpoint URL is returned or an exception.

Description

EndpointURI returns a string:

( | )

Exceptions

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

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

UnknownEmailException -- Specified email cannot be located in our
system. See “Validating a Domain” on page 26

UnknownInternalException -- Exceptions caused by unhandled server-side
problems

See “Exception Management” on page 20.