2.2.3.177.12 Status (ResolveRecipients)

  • Article

The Status element is a required child element of the ResolveRecipients element, the Response element, the Availability element, the Certificates element, and the Picture element in ResolveRecipients command responses.

All elements referenced in this section are defined in the ResolveRecipients namespace.

Command request/response

Parent elements

Child elements

Data type

Number allowed

ResolveRecipients command response (section 2.2.1.15)

ResolveRecipients (section 2.2.3.152)

Response (section 2.2.3.153.6)

Availability (section 2.2.3.16)

Certificates (section 2.2.3.23.1)

Picture (section 2.2.3.135.2)

None

integer ([MS-ASDTYPE] section 2.6)

1…1 (required)

As a child element of the ResolveRecipients element, the Status element indicates the success or failure of the ResolveRecipients command request. The following table shows valid values for the Status element when it is returned as a child of the ResolveRecipients element.

Value

Meaning

1

Success.

5

Protocol error. Either an invalid parameter was specified or the range exceeded limits.

6

An error occurred on the server. The client SHOULD retry the request.

As a child element of the Response element, the Status element provides the status of the ResolveRecipients command response Response element. The following table shows valid values for the Status element when it is returned as a child element of the Response element.

Value

Meaning

1

The recipient was resolved successfully. For more details about the Recipient element, see section 2.2.3.145.

2

The recipient was found to be ambiguous. The returned list of recipients are suggestions. No certificate nodes were returned. Prompt the user to select the intended recipient from the list returned.

3

The recipient was found to be ambiguous. The returned list is a partial list of suggestions. The total count of recipients can be obtained from the RecipientCount element (section 2.2.3.146). No certificate nodes were returned. Prompt the user to select the intended recipient from the list returned or to get more recipients.

4

The recipient did not resolve to any contact or GAL entry. No certificates were returned. Inform the user of the error and direct the user to check the spelling.

As a child element of the Availability element, the Status element provides the status of the ResolveRecipients command response Availability element. The following table shows valid values for the Status element when it is returned as a child element of the Availability element.

Value

Meaning

1

Free/busy data was successfully retrieved for a given recipient. This value does not indicate that the response is complete.

160

The command has exceeded the maximum number of exactly matched recipients for which it can request availability.<16>

161

The distribution group identified by the To element of the ResolveRecipient request included more than 20 recipients.

162

The free/busy data could not be retrieved by the server due to a temporary failure. The client SHOULD reissue the request. This error is caused by a timeout value being reached while requesting free/busy data for some users, but not others.

163

Free/busy data could not be retrieved from the server for a given recipient. Clients SHOULD NOT reissue the request as it is caused by a lack of permission to retrieve the data.

As a child element of the Certificates element, the Status element provides the status of the ResolveRecipients command response Certificates element. The following table shows valid values for the Status element when it is returned as a child element of the Certificates element.

Value

Meaning

1

One or more certificates were successfully returned.

7

The recipient does not have a valid S/MIME certificate. No certificates were returned.

8

The global certificate limit was reached and the recipient's certificate could not be returned. The count certificates not returned can be obtained from the CertificateCount element. Retry with fewer recipients if possible, otherwise prompt the user.

As a child element of the Picture element, the Status element provides the status of the ResolveRecipients command response Picture element. The following table shows valid values for the Status element when it is returned as a child element of the Picture element.

Value

Meaning

1

The contact photo was retrieved successfully.

173

The user does not have a contact photo.

174

The contact photo exceeded the size limit set by the MaxSize element (section 2.2.3.105.2).

175

The number of contact photos returned exceeded the size limit set by the MaxPictures element (section 2.2.3.104.2).

For information about Status values common to all ActiveSync commands, see section 2.2.2.

Protocol Versions

The following table specifies the protocol versions that support this element. The client indicates the protocol version being used by setting either the MS-ASProtocolVersion header, as specified in [MS-ASHTTP] section 2.2.1.1.2.6, or the Protocol version field, as specified in [MS-ASHTTP] section 2.2.1.1.1.1, in the request.

Protocol version

Element support, child of Availability

Element support, child of Picture

Element support, child of other elements

2.5

Yes

12.0

Yes

12.1

Yes

14.0

Yes

Yes

14.1

Yes

Yes

Yes

16.0

Yes

Yes

Yes

16.1

Yes

Yes

Yes

The following elements are supported as a parent element of the Status element when protocol version 2.5, 12.0, 12.1, 14.0, 14.1, 16.0, or 16.1 is used.

  • ResolveRecipients

  • Response

  • Certificates

The Availability element is supported as a parent of the Status element only when protocol version 14.0, 14.1, 16.0, or 16.1 is used.

The Picture element is supported as a parent of the Status element only when protocol version 14.1 16.0, or 16.1 is used.