status

Description

A status code returned by Connect Enterprise in the response to all actions in the Web Services XML API.

Response structure

<?xml version="1.0" encoding="utf-8" ?> 
<results> 
    <status code=allowedValue > 
</results>

<?xml version="1.0" encoding="utf-8" ?> 
<results> 
    <status code=allowedValue> 
        <invalid field=string type=allowedValue subcode=allowedValue /> 
    </status> 
</results>

Attributes

code The status of the response.

Value	Description
`invalid`	Indicates that a call is invalid in some way. The `invalid` element provides more detail.
`no-access`	Indicates that you don't have permission to call the action. The `subcode` attribute provides more details.
`no-data`	Indicates that there is no data available (in response to an action that would normally result in returning data). Usually indicates that there is no item with the ID you specified. To resolve the error, change the specified ID to that of an item that exists.
`ok`	Indicates that the action has completed successfully.
`too-much-data`	Indicates that the action should have returned a single result but is actually returning multiple results. For example, if there are multiple users with the same user name and password, and you call the `login` action using that user name and password as parameters, the system cannot determine which user to log you in as, so it returns a `too-much-data` error.

subcode If present, provides more detail describing the status of the response. For example, subcode values are used to differentiate between different situations in which code is set to no-access.

Value	Description
`account-expired`	The customer account has expired.
`denied`	Based on the supplied credentials, you don't have permission to call the action.
`no-login`	The user is not logged in. To resolve the error, log in (using the `login` action) before you make the call. For more information, see login.
`no-quota`	The account limits have been reached or exceeded.
`not-available`	The required resource is unavailable.
`not-secure`	You must use SSL to call this action.
`pending-activation`	The account is not yet activated.
`pending-license`	The account's license agreement has not been settled.
`sco-expired`	The course or tracking content has expired.
`sco-not-started`	The meeting or course has not started.

The invalid element

An element that gives information describing a status code of invalid.

Element	Attribute	Type	Description
`invalid`		Empty, with attributes	Information about why the call was invalid.
	`field`	String	The name of the request parameter that was incorrect or missing.
	`type`	Allowed value	The type of the incorrect or missing field.
	`subcode`	Allowed value	A code explaining why the request was invalid (see the following table for values).

The following table shows the allowed values for subcode when code is invalid.

Value	Description
`duplicate`	The call attempted to add a duplicate item in a context where uniqueness is required.
`format`	A passed parameter had the wrong format.
`illegal-operation`	The requested operation violates integrity rules (for example, moving a folder into itself).
`missing`	A required parameter is missing.
`no-such-item`	The requested information does not exist.
`range`	The value is outside the permitted range of values.

Returned by

All actions in the Connect Enterprise Web Services XML API.

Samples

This is a successful response:

<status code="ok" />

This is an invalid response:

<status code="invalid">
  <invalid field="principal-id" type="id" subcode="missing" /> 
</status>

Send me an e-mail when comments are added to this page | Comment Report

Current page: http://livedocs.adobe.com/breeze/6/xml_api/06_elem9.htm