SOAP Common Objects and Types

There are several structures which are common, in that they are used by several SOAP calls.

Common Objects

FaultData

This structure is contained in all top-level structures returned by SOAP functions.  If this object is not null then an error occurred.

Field
Type Description
faultCode int integer error code, usually 0
faultString String The error message
invalidSession boolean True if the auth string passed to the SOAP call was invalid or expired.  If this is true then the user needs to call getLogin() again.

IdData

This structure is used to return an object ID to the client application.

Field
Type Description
fault FaultData Optional fault object
id int Object ID

StatusData

This structure is used to return a status code to the client application.

Field
Type Description
fault FaultData Optional fault object
status int Application-defined status code. Usually 0 (OK)

StringData

This structure is used to return a string value to the client application.

Field
Type Description
data String The string value
fault FaultData Optional fault object



Enumerated Data Types

AccessRestrictionType

Contains the access restriction types, used in pool setup.

Value
Description
E Exclude email/domain
I Include email/domain


LicenseType

Contains the possible types of license.

Value
Description
D Demo license
F Floating license
L Checked-out license
Q
Queued license made available to the next person in queue.


PoolStatusType

Contains the possible pool statuses.

Value
Description
A Active
E Expired
P Pending confirmation


QueueType

Contains the possible types of queueing allowed in pool setup.

Value
Description
A Automatically queue
R Request confirmation that a request should be queued


OutputTypeType

Contains the possible types of report output.

Value
Description
CSV Output as CSV (Comma-Separated Values) suitable for importing into a spreadsheet.
XML Output as XML data


MailTypeType

Contains the possible types User Registration confirmation emails. Used by the createLMUser() call.

Value
Description
LINKONLY Sends an email that contains a link to click on to confirm registration.
CODEONLY Sends an email that contains a confirmation code to be passed in to the confirmLMUser() call.
BOTH Sends both of the above emails. (default)
AUTO Does not send any email, but confirms the user immediately. Should only be used when you are certain that this is a valid user.



Comments