The MAPI Statistics (MapiStats Web Service) performs one or more of the following actions:
-
getDroppedConnCount
-
getOptConnCount
-
getSessionCount
-
getUnaccelConnCount
-
retrieveClientConnCount
-
retrieveClientSecuredConnCount
-
retrieveDataReadStats
-
retrieveEncAndNonEncResponseStats
-
retrieveEncryptedAndNonEncryptedOptimizedConnCount
-
retrieveRequestTypeStats
-
retrieveResponseStats
getDroppedConnCount
Retrieves a list of dropped connection counts.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter MapiDroppedConnCount[] returns a MapiDroppedConnCount value that provides dropped connection counts.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
MapiStatsService.getDroppedConnCount:ERROR:Unable to get MapiDroppedConnCount=
|
Unknown exception. See the logs to view the error.
|
getOptConnCount
Retrieves a list of optimized connection counts.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter MapiOptConnCount[] returns a MapiClientSecuredConnCount value that provides optimized connection counts.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
MapiStatsService.getClientConnCount: ERROR:Invalid name=
|
Unknown exception. See the logs to view the error.
|
getSessionCount
Retrieves the number of MAPI sessions completed on either a WAE device, WAEs within a device group, or all WAEs system wide.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter MapiSessionCount[] returns a HttpsStats value that provides the number of sessions completed.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
MapiStatsService.getSessionCount: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
MapiStatsService.getSessionCount: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
MapiStatsService.getSessionCount: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
MapiStatsService.getSessionCount: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
MapiStatsService.getSessionCount: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
MapiStatsService.getSessionCount: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
MapiStatsService.getSessionCount: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
MapiStatsService.getSessionCount: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
MapiStatsService.getSessionCount: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
MapiStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
MapiStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
MapiStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
getSessionCount:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
getUnaccelConnCount
Retrieves a list of unaccelerated connection counts.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter MapiUnaccelConnCount[] returns a MapiUnaccelConnCount value that provides unaccelerated connection counts.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
MapiStatsService.getUnaccelConnCount:ERROR:Unable to get MapiUnaccelConnCount=
|
Unknown exception. See the logs to view the error.
|
retrieveClientConnCount
Retrieves the number of past connections from each client type on either a WAE device, WAEs within a device group, or all
WAEs system wide.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter MapiClientConnCount[] returns a MapiClientConnCount value that provides the number of past connections from each client type.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
MapiStatsService.retrieveClientConnCount: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
MapiStatsService.retrieveClientConnCount: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
MapiStatsService.retrieveClientConnCount: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
MapiStatsService.retrieveClientConnCount: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
MapiStatsService.retrieveClientConnCount: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
MapiStatsService.retrieveClientConnCount: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
MapiStatsService.retrieveClientConnCount: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
MapiStatsService.retrieveClientConnCount: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
MapiStatsService.retrieveClientConnCount: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
MapiStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
MapiStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
MapiStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveClientConnCount:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveClientSecuredConnCount
Retrieves the number of secured client connections from each Outlook version on either a WAE device, WAEs within a device
group, or all WAEs system wide.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter MapiClientSecuredConnCount[] returns MapiClientSecuredConnCount value that provides the count of encrypted client connections for each version of Outlook.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
MapiStatsService.retrieveClientSecuredConnCount: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
MapiStatsService.retrieveClientSecuredConnCount: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
MapiStatsService.retrieveClientSecuredConnCount: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
MapiStatsService.retrieveClientSecuredConnCount: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
MapiStatsService.retrieveClientSecuredConnCount: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
MapiStatsService.retrieveClientSecuredConnCount: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
MapiStatsService.retrieveClientSecuredConnCount: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
MapiStatsService.retrieveClientSecuredConnCount: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
MapiStatsService.retrieveClientSecuredConnCount: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
MapiStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
MapiStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
MapiStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveClientSecuredConnCount:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveDataReadStats
Retrieves the MAPI date read statistics collected on either a WAE device, WAEs within a device group, or all WAEs system
wide.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter MapiDataReadStats[] returns a MapiDataReadStats value that provides the minimum, maximum, and average size of the SychronizationGetBuffer, the
ReadStream, and the accumulated read ahead.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
MapiStatsService.retrieveDataReadStats: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
MapiStatsService.retrieveDataReadStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
MapiStatsService.retrieveDataReadStats: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
MapiStatsService.retrieveDataReadStats: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
MapiStatsService.retrieveDataReadStats: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
MapiStatsService.retrieveDataReadStats: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
MapiStatsService.retrieveDataReadStats: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
MapiStatsService.retrieveDataReadStats: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
MapiStatsService.retrieveDataReadStats: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
MapiStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
MapiStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
MapiStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveDataReadStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveEncAndNonEncResponseStats
Retrieves encrypted and unencrypted connection count and response time information.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter MAPIEncAndNonEncResponseStats[] returns a MapiEncAndNonEncResponseStats value that specifies the number of encrypted and unencrypted connections, along with
the average local and response times for encrypted and unencrypted connections.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
MapiStatsService.retrieveEncAndNonEncResponseStats: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
MapiStatsService.retrieveEncAndNonEncResponseStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
MapiStatsService.retrieveEncAndNonEncResponseStats: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
MapiStatsService.retrieveEncAndNonEncResponseStats: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
MapiStatsService.retrieveEncAndNonEncResponseStats: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
MapiStatsService.retrieveEncAndNonEncResponseStats: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
MapiStatsService.retrieveEncAndNonEncResponseStats: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
MapiStatsService.retrieveEncAndNonEncResponseStats: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
MapiStatsService.retrieveEncAndNonEncResponseStats: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
MapiStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
MapiStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
MapiStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveEncAndNonEncResponseStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveEncryptedAndNonEncryptedOptimizedConnCount
Retrieves counts of the encrypted and unencrypted connections optimized by the MAPI Application Optimizer.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter MAPIEncAndNonEncOptimizedConnCount[] returns a MapiEncAndNonEncOptimizedConnCount value that provides the number of encrypted and unencrypted connections that
have been optimized by the MAPI AO.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
MapiStatsService.retrieveEncryptedAndNonEncryptedOptimizedConnCount: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
MapiStatsService.retrieveEncryptedAndNonEncryptedOptimizedConnCount: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
MapiStatsService.retrieveEncryptedAndNonEncryptedOptimizedConnCount: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
MapiStatsService.retrieveEncryptedAndNonEncryptedOptimizedConnCount: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
MapiStatsService.retrieveEncryptedAndNonEncryptedOptimizedConnCount: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
MapiStatsService.retrieveEncryptedAndNonEncryptedOptimizedConnCount: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
MapiStatsService.retrieveEncryptedAndNonEncryptedOptimizedConnCount: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
MapiStatsService.retrieveEncryptedAndNonEncryptedOptimizedConnCount: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
MapiStatsService.retrieveEncryptedAndNonEncryptedOptimizedConnCount: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
MapiStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
MapiStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
MapiStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveEncryptedAndNonEncryptedOptimizedConnCount:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveRequestTypeStats
Retrieves the MAPI request type statistics collected on either a WAE device, WAEs within a device group, or all WAEs system
wide.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter MapiRequestTypeStats[] returns a MapiRequestTypeStats value that provides the request type statistics.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
MapiStatsService.retrieveRequestTypeStats: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
MapiStatsService.retrieveRequestTypeStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
MapiStatsService.retrieveRequestTypeStats: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
MapiStatsService.retrieveRequestTypeStats: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
MapiStatsService.retrieveRequestTypeStats: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
MapiStatsService.retrieveRequestTypeStats: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
MapiStatsService.retrieveRequestTypeStats: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
MapiStatsService.retrieveRequestTypeStats: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
MapiStatsService.retrieveRequestTypeStats: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
MapiStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
MapiStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
MapiStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveRequestTypeStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|
retrieveResponseStats
Retrieves the MAPI response statistics collected on either a WAE device, WAEs within a device group, or all WAEs system wide.
Input Parameters
Parameter
|
Description
|
name
|
A string that describes the name of the WAE, WAE group, or system.
|
objType
|
A string that describes the object type. Valid values include the following:
|
timeframe
|
A TimeFrameFilter value that includes the time interval, time zone, and frequency.
|
Return
The output parameter MapiResponseStats[] returns a MapiResponseStats value that provides the number of local and remote responses, the average local response time,
and the average remote response time.
Exceptions
Type
|
String
|
Description
|
RemoteException
|
MapiStatsService.retrieveResponseStats: ERROR:Invalid name=
|
The device name is invalid.
|
RemoteException
|
MapiStatsService.retrieveResponseStats: ERROR:Invalid objType=
|
The object type name is invalid.
|
RemoteException
|
MapiStatsService.retrieveResponseStats: ERROR:Invalid TimeFrame
|
The timeframe is invalid.
|
RemoteException
|
MapiStatsService.retrieveResponseStats: ERROR:Device does not exist.DeviceName=
|
The device name is not found.
|
RemoteException
|
MapiStatsService.retrieveResponseStats: ERROR:Device Group does not exist.DeviceGroup=
|
The device group name is not found.
|
RemoteException
|
MapiStatsService.retrieveResponseStats: ERROR:Invalid frequency=
|
The frequency is invalid.
|
RemoteException
|
MapiStatsService.retrieveResponseStats: ERROR:Invalid startTime=
|
The start time is invalid.
|
RemoteException
|
MapiStatsService.retrieveResponseStats: ERROR:Invalid endTime=
|
The end time is invalid.
|
RemoteException
|
MapiStatsService.retrieveResponseStats: ERROR:startTime should be less than endTime startTime=
|
The start time is less than the end time.
|
AxisFault
|
MapiStats:The Method Name is not supported. MethodName=
|
The method name is not supported for a given service.
|
AxisFault
|
MapiStats:The SOAP Envelope Body is Null
|
The SOAP envelope is missing for a given service.
|
AxisFault
|
MapiStats:The Requested WebService is not available
|
The service requested is not supported.
|
AxisFault
|
retrieveResponseStats:The SOAP Body doesn’t have all the required elements
|
The SOAP body does not have all the required elements.
|