2.2.3.177.11 Status (Ping)
The Status element is a required child element of the Ping element in Ping command responses that indicates the success or failure of the Ping command request (section 2.2.1.13). If the command failed, the Status element contains a code that indicates the type of failure. Certain status codes have additional information that is included in the response.
All elements referenced in this section are defined in the Ping namespace.
|
Command request/response |
Parent elements |
Child elements |
Data type |
Number allowed |
|---|---|---|---|---|
|
Ping command response |
Ping (section 2.2.3.136) |
None |
integer ([MS-ASDTYPE] section 2.6) |
1…1 (required) |
The following table lists the status codes for the Ping command (section 2.2.1.13). For information about the scope of the status value and for status values common to all ActiveSync commands, see section 2.2.2.
|
Value |
Meaning |
Cause |
Scope |
Resolution |
|---|---|---|---|---|
|
1 |
The heartbeat interval expired before any changes occurred in the folders being monitored. |
|
Global |
Reissue the Ping command request. |
|
2 |
Changes occurred in at least one of the monitored folders. The response specifies the changed folders. |
|
Global |
Issue a Sync command request (section 2.2.1.21) for each folder that was specified in the Ping command response to retrieve the server changes. Reissue the Ping command when the Sync command completes to stay up to date. |
|
3 |
The Ping command request omitted required parameters. |
The Ping command request did not specify all the necessary parameters. The client MUST issue a Ping request that includes both the heartbeat interval and the folder list at least once. The server saves the heartbeat interval value (section 2.2.3.88.1), so only the folder list is required on subsequent requests. |
Global |
Reissue the Ping command request with the entire XML body. |
|
4 |
Syntax error in Ping command request. |
Frequently caused by poorly formatted WBXML. |
Global |
Double-check the request for accuracy. |
|
5 |
The specified heartbeat interval is outside the allowed range. For intervals that were too short, the response contains the shortest allowed interval. For intervals that were too long, the response contains the longest allowed interval. |
The client sent a Ping command request with a heartbeat interval that was either too long or too short. |
Global |
Reissue the Ping command by using a heartbeat interval inside the allowed range. Setting the interval to the value returned in the Ping response will most closely accommodate the original value specified. |
|
6 |
The Ping command request specified more than the allowed number of folders to monitor. The response indicates the allowed number in the MaxFolders element (section 2.2.3.102). |
The client sent a Ping command request that specified more folders than the server is configured to monitor. |
Global |
Direct the user to select fewer folders to monitor. Resend the Ping command request with the new, shorter list. |
|
7 |
Folder hierarchy sync required. |
The folder hierarchy is out of date; a folder hierarchy sync is required. |
Global |
Issue a FolderSync command (section 2.2.1.5) to get the new hierarchy and prompt the user, if it is necessary, for new folders to monitor. Reissue the Ping command. |
|
8 |
An error occurred on the server. |
Server misconfiguration, temporary system issue, or bad item. This is frequently a transient condition. |
Global |
Retry the Ping command. |
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 |
|---|---|
|
2.5 |
Yes |
|
12.0 |
Yes |
|
12.1 |
Yes |
|
14.0 |
Yes |
|
14.1 |
Yes |
|
16.0 |
Yes |
|
16.1 |
Yes |