The Provisioning category contains the following public
procedures for the provisioning of Hosted Exchange Mobility
Services
CancelActiveSyncDeviceWipe |
Cancel an in-progress mobile device wipe if it is not yet
complete.
Syntax
C#
public CancelActiveSyncDeviceWipeResponse CancelActiveSyncDeviceWipe(CancelActiveSyncDeviceWipeRequest request) {
}
Parameters
request
The CancelActiveSyncDeviceWipeRequest contains
the data used in execution of CancelActiveSyncDeviceWipe.This class
is an XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
CancelActiveSyncDeviceWipeRequest.xsd is shipped
with the WES and located in the root of the WES Virtual Directory.
The following shows the basic Xml format of the class:
Xml
Message Format |
<CancelActiveSyncDeviceWipeRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
<deviceID>xs:string</deviceID>
<deviceType>xs:string</deviceType>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</CancelActiveSyncDeviceWipeRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- deviceID - (minOccurs=1, maxOccurs=1). The
device id.
- deviceType - (minOccurs=1, maxOccurs=1).
Values are: [SmartPhone | PocketPC].
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The CancelActiveSyncDeviceWipeResponse class
contains the data returned after execution of
CancelActiveSyncDeviceWipe.This class is an XmlSerialization
compliant class generated from an Xml Schema Definition.The Xml
Schema Definition document
CancelActiveSyncDeviceWipeResponse.xsd is shipped
with the WES and located in the root of the WES Virtual Directory.
The following shows the basic Xml format of the class:
Xml
Message Format |
<CancelActiveSyncDeviceWipeResponse>
<Data>xs:string</Data>
</CancelActiveSyncDeviceWipeResponse>
|
|
ClearUserPolicy |
Clears a users policy
Syntax
C#
public ClearUserPolicyResponse ClearUserPolicy(ClearUserPolicyRequest request) {
}
Parameters
request
The ClearUserPolicyRequest contains the data
used in execution of ClearUserPolicy.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
ClearUserPolicyRequest.xsd is shipped with the WES
and located in the root of the WES Virtual Directory. The following
shows the basic Xml format of the class:
Xml
Message Format |
<ClearUserPolicyRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</ClearUserPolicyRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The ClearUserPolicyResponse class contains the
data returned after execution of ClearUserPolicy.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
ClearUserPolicyResponse.xsd is shipped with the
WES and located in the root of the WES Virtual Directory. The
following shows the basic Xml format of the class:
Xml
Message Format |
<ClearUserPolicyResponse>
<Data>xs:string</Data>
</ClearUserPolicyResponse>
|
|
ClearUserPolicyExemption |
Clears a users mobile policy exemption.
Syntax
C#
public ClearUserPolicyExemptionResponse ClearUserPolicyExemption(ClearUserPolicyExemptionRequest request) {
}
Parameters
request
The ClearUserPolicyExemptionRequest contains
the data used in execution of ClearUserPolicyExemption.This class
is an XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
ClearUserPolicyExemptionRequest.xsd is shipped
with the WES and located in the root of the WES Virtual Directory.
The following shows the basic Xml format of the class:
Xml
Message Format |
<ClearUserPolicyExemptionRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</ClearUserPolicyExemptionRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The ClearUserPolicyExemptionResponse class
contains the data returned after execution of
ClearUserPolicyExemption.This class is an XmlSerialization
compliant class generated from an Xml Schema Definition.The Xml
Schema Definition document
ClearUserPolicyExemptionResponse.xsd is shipped
with the WES and located in the root of the WES Virtual Directory.
The following shows the basic Xml format of the class:
Xml
Message Format |
<ClearUserPolicyExemptionResponse>
<Data>xs:string</Data>
</ClearUserPolicyExemptionResponse>
|
|
CreatePolicy |
Create a mobile device policy for a specified organization.
Syntax
C#
public CreatePolicyResponse CreatePolicy(CreatePolicyRequest request) {
}
Parameters
request
The CreatePolicyRequest contains the data used
in execution of CreatePolicy.This class is an XmlSerialization
compliant class generated from an Xml Schema Definition.The Xml
Schema Definition document CreatePolicyRequest.xsd
is shipped with the WES and located in the root of the WES Virtual
Directory. The following shows the basic Xml format of the
class:
Xml
Message Format |
<CreatePolicyRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
<policyName>xs:string</policyName>
<policyDescription>xs:string</policyDescription>
<aeFrequencyValue>xs:int</aeFrequencyValue>
<deviceWipeThreshold>xs:int</deviceWipeThreshold>
<codewordFrequency>xs:int</codewordFrequency>
<minimumPasswordLength>xs:int</minimumPasswordLength>
<passwordComplexity>xs:string</passwordComplexity>
<aeFrequencyType>xs:string</aeFrequencyType>
<refreshInterval>xs:int</refreshInterval>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</CreatePolicyRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the organization.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- policyName - (minOccurs=1, maxOccurs=1). The
unique name of the policy.
- policyDescription - (minOccurs=1,
maxOccurs=1). Description of the policy.
- aeFrequencyValue - (minOccurs=1, maxOccurs=1).
Number of minutes of inactivity before the device locks itself
(meaningless if AEFrequencyType=0)
- deviceWipeThreshold - (minOccurs=1,
maxOccurs=1). The number of failed PIN entry attempts before the
device wipes itself. If set to '-1', this feature is disabled.
- codewordFrequency - (minOccurs=1,
maxOccurs=1). To prevent accidental button presses from triggering
the local wipe feature enabled by 'DeviceWipeThreshold', the device
will prompt for a specific codeword every X attempts. This
parameter sets the number of failed attempts before prompting for
the codeword. ESM doesn't have a UI for this setting, which
automatically sets this value to half of the "DeviceWipeThreshold"
value.
- minimumPasswordLength - (minOccurs=1,
maxOccurs=1). Sets the minimum personal identification number (PIN)
length the user can enter.
- passwordComplexity - (minOccurs=1,
maxOccurs=1). Sets the complexity of the PIN.
- aeFrequencyType - (minOccurs=1, maxOccurs=1).
0 = the device will not lock itself after inactivity. 1 = the
device will lock itself after X minutes of inactivity (X determined
by aeFrequencyValue).
- refreshInterval - (minOccurs=1, maxOccurs=1).
The number of minutes for refresh interval.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The CreatePolicyResponse class contains the
data returned after execution of CreatePolicy.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
CreatePolicyResponse.xsd is shipped with the WES
and located in the root of the WES Virtual Directory. The following
shows the basic Xml format of the class:
|
DeletePolicy |
Delete a mobile device policy for a specified organization.
Syntax
C#
public DeletePolicyResponse DeletePolicy(DeletePolicyRequest request) {
}
Parameters
request
The DeletePolicyRequest contains the data used
in execution of DeletePolicy.This class is an XmlSerialization
compliant class generated from an Xml Schema Definition.The Xml
Schema Definition document DeletePolicyRequest.xsd
is shipped with the WES and located in the root of the WES Virtual
Directory. The following shows the basic Xml format of the
class:
Xml
Message Format |
<DeletePolicyRequest>
<Data>
<path>xs:string</path>
<policyName>xs:string</policyName>
<preferredDomainController>xs:string</preferredDomainController>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</DeletePolicyRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the organization.
- policyName - (minOccurs=1, maxOccurs=1). The
unique name of the policy.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The DeletePolicyResponse class contains the
data returned after execution of DeletePolicy.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
DeletePolicyResponse.xsd is shipped with the WES
and located in the root of the WES Virtual Directory. The following
shows the basic Xml format of the class:
|
GetActiveSyncDevices |
Gets a list of ActiveSync devices.
Syntax
C#
public GetActiveSyncDevicesResponse GetActiveSyncDevices(GetActiveSyncDevicesRequest request) {
}
Parameters
request
The GetActiveSyncDevicesRequest contains the
data used in execution of GetActiveSyncDevices.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
GetActiveSyncDevicesRequest.xsd is shipped with
the WES and located in the root of the WES Virtual Directory. The
following shows the basic Xml format of the class:
Xml
Message Format |
<GetActiveSyncDevicesRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</GetActiveSyncDevicesRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The GetActiveSyncDevicesResponse class contains
the data returned after execution of GetActiveSyncDevices.This
class is an XmlSerialization compliant class generated from an Xml
Schema Definition.The Xml Schema Definition document
GetActiveSyncDevicesResponse.xsd is shipped with
the WES and located in the root of the WES Virtual Directory. The
following shows the basic Xml format of the class:
Xml
Message Format |
<GetActiveSyncDevicesResponse>
<Data>
<devices>
<device>
<wipeInitiated>xs:string</wipeInitiated>
<deviceId>xs:string</deviceId>
<deviceType>xs:string</deviceType>
</device>
</devices>
</Data>
</GetActiveSyncDevicesResponse>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- devices - (minOccurs=1, maxOccurs=1).
- device - (minOccurs=1, maxOccurs=1).
- wipeInitiated - (minOccurs=1, maxOccurs=1).
- deviceId - (minOccurs=0, maxOccurs=1). insert
documentation for this item here...
- deviceType - (minOccurs=1, maxOccurs=1).
Values are: [SmartPhone | PocketPC].
|
|
GetPolicies |
Retrieve a listing of device polices for a specified
organization.
Syntax
C#
public GetPoliciesResponse GetPolicies(GetPoliciesRequest request) {
}
Parameters
request
The GetPoliciesRequest contains the data used
in execution of GetPolicies.This class is an XmlSerialization
compliant class generated from an Xml Schema Definition.The Xml
Schema Definition document GetPoliciesRequest.xsd
is shipped with the WES and located in the root of the WES Virtual
Directory. The following shows the basic Xml format of the
class:
Xml
Message Format |
<GetPoliciesRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</GetPoliciesRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the organization.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The GetPoliciesResponse class contains the data
returned after execution of GetPolicies.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
GetPoliciesResponse.xsd is shipped with the WES
and located in the root of the WES Virtual Directory. The following
shows the basic Xml format of the class:
Xml
Message Format |
<GetPoliciesResponse>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
<policies>
<policy>
<policyName>xs:string</policyName>
<policyDescription>xs:string</policyDescription>
<dateCreated>xs:dateTime</dateCreated>
<dateLastUpdated>xs:dateTime</dateLastUpdated>
</policy>
</policies>
</Data>
</GetPoliciesResponse>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- policies - (minOccurs=1, maxOccurs=1).
- policy - (minOccurs=1, maxOccurs=unbounded).
- policyName - (minOccurs=1, maxOccurs=1). The
unique name of the policy.
- policyDescription - (minOccurs=1,
maxOccurs=1). Description of the policy.
- dateCreated - (minOccurs=1, maxOccurs=1).
- dateLastUpdated - (minOccurs=1, maxOccurs=1).
|
|
GetPolicyDetail |
Retrieve the details of a specified device policy.
Syntax
C#
public GetPolicyDetailResponse GetPolicyDetail(GetPolicyDetailRequest request) {
}
Parameters
request
The GetPolicyDetailRequest contains the data
used in execution of GetPolicyDetail.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
GetPolicyDetailRequest.xsd is shipped with the WES
and located in the root of the WES Virtual Directory. The following
shows the basic Xml format of the class:
Xml
Message Format |
<GetPolicyDetailRequest>
<Data>
<path>xs:string</path>
<policyName>xs:string</policyName>
<preferredDomainController>xs:string</preferredDomainController>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</GetPolicyDetailRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the organization.
- policyName - (minOccurs=1, maxOccurs=1). The
unique name of the policy.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The GetPolicyDetailResponse class contains the
data returned after execution of GetPolicyDetail.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
GetPolicyDetailResponse.xsd is shipped with the
WES and located in the root of the WES Virtual Directory. The
following shows the basic Xml format of the class:
Xml
Message Format |
<GetPolicyDetailResponse>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
<policyName>xs:string</policyName>
<policyTypeName>xs:string</policyTypeName>
<aeFrequencyValue>xs:unsignedByte</aeFrequencyValue>
<deviceWipeThreshold>xs:string</deviceWipeThreshold>
<codewordFrequency>xs:string</codewordFrequency>
<minimumPasswordLength>xs:string</minimumPasswordLength>
<passwordComplexity>xs:string</passwordComplexity>
<aeFrequencyType>xs:string</aeFrequencyType>
<refreshInterval>xs:string</refreshInterval>
</Data>
</GetPolicyDetailResponse>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- policyName - (minOccurs=1, maxOccurs=1). The
unique name of the policy.
- policyTypeName - (minOccurs=1, maxOccurs=1).
- aeFrequencyValue - (minOccurs=0, maxOccurs=1).
The number of minutes of inactivity before the device locks itself
(meaningless if AEFrequencyType=0).
- deviceWipeThreshold - (minOccurs=0,
maxOccurs=1). The number of failed personal identification number
(PIN) entry attempts before the device wipes itself. If set to
'-1', this feature is disabled.
- codewordFrequency - (minOccurs=0,
maxOccurs=1). To prevent accidental button presses from
accidentally triggering the local wipe feature enabled by
'DeviceWipeThreshold', the device will prompt for a specific
codeword every 'X' number of attempts. This parameter sets the
number of failed attempts before prompting for the codeword. ESM
does not have a UI for this setting; it is set to half of the
'DeviceWipeThreshold' value.
- minimumPasswordLength - (minOccurs=0,
maxOccurs=1). The minimum PIN length the user can enter.
- passwordComplexity - (minOccurs=0,
maxOccurs=1). Complexity required for the PIN. 0=alpha-numeric,
1=requires numeric, 2=unrestricted.
- aeFrequencyType - (minOccurs=0, maxOccurs=1).
0 = the device will not lock itself after inactivity. 1 = the
device will lock itself after X minutes of inactivity (X determined
by aeFrequencyValue).
- refreshInterval - (minOccurs=0, maxOccurs=1).
The number of minutes for refresh interval.
|
|
GetUserPolicy |
Get a specified user device policy.
Syntax
C#
public GetUserPolicyResponse GetUserPolicy(GetUserPolicyRequest request) {
}
Parameters
request
The GetUserPolicyRequest contains the data used
in execution of GetUserPolicy.This class is an XmlSerialization
compliant class generated from an Xml Schema Definition.The Xml
Schema Definition document
GetUserPolicyRequest.xsd is shipped with the WES
and located in the root of the WES Virtual Directory. The following
shows the basic Xml format of the class:
Xml
Message Format |
<GetUserPolicyRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</GetUserPolicyRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The GetUserPolicyResponse class contains the
data returned after execution of GetUserPolicy.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
GetUserPolicyResponse.xsd is shipped with the WES
and located in the root of the WES Virtual Directory. The following
shows the basic Xml format of the class:
Xml
Message Format |
<GetUserPolicyResponse>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
<policyName>xs:string</policyName>
<policyDescription>xs:string</policyDescription>
</Data>
</GetUserPolicyResponse>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- policyName - (minOccurs=1, maxOccurs=1). The
unique name of the policy.
- policyDescription - (minOccurs=1,
maxOccurs=1). Description of the policy.
|
|
GetUserPolicyExemption |
Get a specified user device policy exemption status.
Syntax
C#
public GetUserPolicyExemptionResponse GetUserPolicyExemption(GetUserPolicyExemptionRequest request) {
}
Parameters
request
The GetUserPolicyExemptionRequest contains the
data used in execution of GetUserPolicyExemption.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
GetUserPolicyExemptionRequest.xsd is shipped with
the WES and located in the root of the WES Virtual Directory. The
following shows the basic Xml format of the class:
Xml
Message Format |
<GetUserPolicyExemptionRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</GetUserPolicyExemptionRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The GetUserPolicyExemptionResponse class
contains the data returned after execution of
GetUserPolicyExemption.This class is an XmlSerialization compliant
class generated from an Xml Schema Definition.The Xml Schema
Definition document
GetUserPolicyExemptionResponse.xsd is shipped with
the WES and located in the root of the WES Virtual Directory. The
following shows the basic Xml format of the class:
Xml
Message Format |
<GetUserPolicyExemptionResponse>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
<exempt>xs:string</exempt>
</Data>
</GetUserPolicyExemptionResponse>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- exempt - (minOccurs=1, maxOccurs=1).
|
|
InitializeExchangeMobility |
Initialize types for the mobility provisioning system.
Syntax
C#
public InitializeExchangeMobilityResponse InitializeExchangeMobility(InitializeExchangeMobilityRequest request) {
}
Parameters
request
The InitializeExchangeMobilityRequest contains
the data used in execution of InitializeExchangeMobility.This class
is an XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
InitializeExchangeMobilityRequest.xsd is shipped
with the WES and located in the root of the WES Virtual Directory.
The following shows the basic Xml format of the class:
Xml
Message Format |
<InitializeExchangeMobilityRequest>
<Data>
<preferredDomainController>xs:string</preferredDomainController>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</InitializeExchangeMobilityRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The InitializeExchangeMobilityResponse class
contains the data returned after execution of
InitializeExchangeMobility.This class is an XmlSerialization
compliant class generated from an Xml Schema Definition.The Xml
Schema Definition document
InitializeExchangeMobilityResponse.xsd is shipped
with the WES and located in the root of the WES Virtual Directory.
The following shows the basic Xml format of the class:
Xml
Message Format |
<InitializeExchangeMobilityResponse>
<Data>xs:string</Data>
</InitializeExchangeMobilityResponse>
|
|
ModifyPolicy |
Modify a device policy definition for a specified device policy
within a specified organization.
Syntax
C#
public ModifyPolicyResponse ModifyPolicy(ModifyPolicyRequest request) {
}
Parameters
request
The ModifyPolicyRequest contains the data used
in execution of ModifyPolicy.This class is an XmlSerialization
compliant class generated from an Xml Schema Definition.The Xml
Schema Definition document ModifyPolicyRequest.xsd
is shipped with the WES and located in the root of the WES Virtual
Directory. The following shows the basic Xml format of the
class:
Xml
Message Format |
<ModifyPolicyRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
<currentPolicyName>xs:string</currentPolicyName>
<newPolicyName>xs:string</newPolicyName>
<policyDescription>xs:string</policyDescription>
<aeFrequencyValue>xs:int</aeFrequencyValue>
<deviceWipeThreshold>xs:int</deviceWipeThreshold>
<codewordFrequency>xs:int</codewordFrequency>
<minimumPasswordLength>xs:int</minimumPasswordLength>
<passwordComplexity>xs:string</passwordComplexity>
<aeFrequencyType>xs:string</aeFrequencyType>
<refreshInterval>xs:int</refreshInterval>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</ModifyPolicyRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the organization.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- currentPolicyName - (minOccurs=1,
maxOccurs=1). The unique name of the policy.
- newPolicyName - (minOccurs=1, maxOccurs=1).
The unique name of the new policy.
- policyDescription - (minOccurs=1,
maxOccurs=1). Description of the policy.
- aeFrequencyValue - (minOccurs=0, maxOccurs=1).
Number of minutes of inactivity before the device locks itself
(meaningless if AEFrequencyType=0)
- deviceWipeThreshold - (minOccurs=0,
maxOccurs=1). The number of failed PIN entry attempts before the
device wipes itself. If set to '-1', this feature is disabled.
- codewordFrequency - (minOccurs=0,
maxOccurs=1). To prevent accidental button presses from triggering
the local wipe feature enabled by 'DeviceWipeThreshold', the device
will prompt for a specific codeword every X attempts. This
parameter sets the number of failed attempts before prompting for
the codeword. ESM doesn't have a UI for this setting, which
automatically sets this value to half of the "DeviceWipeThreshold"
value.
- minimumPasswordLength - (minOccurs=0,
maxOccurs=1). Sets the minimum personal identification number (PIN)
length the user can enter.
- passwordComplexity - (minOccurs=0,
maxOccurs=1). Sets the complexity of the PIN.
- aeFrequencyType - (minOccurs=0, maxOccurs=1).
0 = the device will not lock itself after inactivity. 1 = the
device will lock itself after X minutes of inactivity (X determined
by aeFrequencyValue).
- refreshInterval - (minOccurs=0, maxOccurs=1).
The number of minutes for refresh interval.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The ModifyPolicyResponse class contains the
data returned after execution of ModifyPolicy.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
ModifyPolicyResponse.xsd is shipped with the WES
and located in the root of the WES Virtual Directory. The following
shows the basic Xml format of the class:
|
QueryPolicyEventsByUser |
Retrieve a report of device policy event history for a specified
user.
Syntax
C#
public QueryPolicyEventsByUserResponse QueryPolicyEventsByUser(QueryPolicyEventsByUserRequest request) {
}
Parameters
request
The QueryPolicyEventsByUserRequest contains the
data used in execution of QueryPolicyEventsByUser.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
QueryPolicyEventsByUserRequest.xsd is shipped with
the WES and located in the root of the WES Virtual Directory. The
following shows the basic Xml format of the class:
Xml
Message Format |
<QueryPolicyEventsByUserRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
<beginningDate>xs:string</beginningDate>
<endingDate>xs:string</endingDate>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</QueryPolicyEventsByUserRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- beginningDate - (minOccurs=1, maxOccurs=1).
Date to start the query.
- endingDate - (minOccurs=1, maxOccurs=1). Date
to end the query.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The QueryPolicyEventsByUserResponse class
contains the data returned after execution of
QueryPolicyEventsByUser.This class is an XmlSerialization compliant
class generated from an Xml Schema Definition.The Xml Schema
Definition document
QueryPolicyEventsByUserResponse.xsd is shipped
with the WES and located in the root of the WES Virtual Directory.
The following shows the basic Xml format of the class:
Xml
Message Format |
<QueryPolicyEventsByUserResponse>
<Data>
<events>
<event>
<policyName>xs:string</policyName>
<eventTypeName>xs:string</eventTypeName>
<securityTrustee>xs:string</securityTrustee>
<authenticatedUser>xs:string</authenticatedUser>
<timeStamp>xs:string</timeStamp>
</event>
</events>
</Data>
</QueryPolicyEventsByUserResponse>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- events - (minOccurs=1, maxOccurs=1).
- event - (minOccurs=1, maxOccurs=1).
- policyName - (minOccurs=1, maxOccurs=1). The
unique name of the policy.
- eventTypeName - (minOccurs=1, maxOccurs=1).
- securityTrustee - (minOccurs=1, maxOccurs=1).
- authenticatedUser - (minOccurs=1,
maxOccurs=1).
- timeStamp - (minOccurs=1, maxOccurs=1).
|
|
QueryPolicyUsageByOrganization |
Retrieve a report of device policy usage for a specified
organization.
Syntax
C#
public QueryPolicyUsageByOrganizationResponse QueryPolicyUsageByOrganization(QueryPolicyUsageByOrganizationRequest request) {
}
Parameters
request
The QueryPolicyUsageByOrganizationRequest
contains the data used in execution of
QueryPolicyUsageByOrganization.This class is an XmlSerialization
compliant class generated from an Xml Schema Definition.The Xml
Schema Definition document
QueryPolicyUsageByOrganizationRequest.xsd is
shipped with the WES and located in the root of the WES Virtual
Directory. The following shows the basic Xml format of the
class:
Xml
Message Format |
<QueryPolicyUsageByOrganizationRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</QueryPolicyUsageByOrganizationRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the organization.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The QueryPolicyUsageByOrganizationResponse
class contains the data returned after execution of
QueryPolicyUsageByOrganization.This class is an XmlSerialization
compliant class generated from an Xml Schema Definition.The Xml
Schema Definition document
QueryPolicyUsageByOrganizationResponse.xsd is
shipped with the WES and located in the root of the WES Virtual
Directory. The following shows the basic Xml format of the
class:
Xml
Message Format |
<QueryPolicyUsageByOrganizationResponse>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
<users>
<user>
<policyName>xs:string</policyName>
<path>xs:string</path>
</user>
</users>
<exemptList>
<users>
<user>
<path>xs:string</path>
</user>
</users>
</exemptList>
</Data>
</QueryPolicyUsageByOrganizationResponse>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- users - (minOccurs=1, maxOccurs=1).
- user - (minOccurs=1, maxOccurs=1).
- policyName - (minOccurs=1, maxOccurs=1). The
unique name of the policy.
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- exemptList - (minOccurs=1, maxOccurs=1).
- users - (minOccurs=1, maxOccurs=1).
- user - (minOccurs=1, maxOccurs=1).
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
|
|
QueryWipeEventsByUser |
Retrieve a listing of mobile device wipe events for a specified
user.
Syntax
C#
public QueryWipeEventsByUserResponse QueryWipeEventsByUser(QueryWipeEventsByUserRequest request) {
}
Parameters
request
The QueryWipeEventsByUserRequest contains the
data used in execution of QueryWipeEventsByUser.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
QueryWipeEventsByUserRequest.xsd is shipped with
the WES and located in the root of the WES Virtual Directory. The
following shows the basic Xml format of the class:
Xml
Message Format |
<QueryWipeEventsByUserRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
<beginningdate>xs:string</beginningdate>
<endingdate>xs:string</endingdate>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</QueryWipeEventsByUserRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- beginningdate - (minOccurs=1, maxOccurs=1).
Date to start the query.
- endingdate - (minOccurs=1, maxOccurs=1). Date
to end the query.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The QueryWipeEventsByUserResponse class
contains the data returned after execution of
QueryWipeEventsByUser.This class is an XmlSerialization compliant
class generated from an Xml Schema Definition.The Xml Schema
Definition document
QueryWipeEventsByUserResponse.xsd is shipped with
the WES and located in the root of the WES Virtual Directory. The
following shows the basic Xml format of the class:
Xml
Message Format |
<QueryWipeEventsByUserResponse>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
<events>
<event>
<deviceID>xs:unsignedLong</deviceID>
<deviceType>xs:string</deviceType>
<eventTypeName>xs:string</eventTypeName>
<securityTrustee>xs:string</securityTrustee>
<authenticatedUser>xs:string</authenticatedUser>
<timeStamp>xs:string</timeStamp>
</event>
</events>
</Data>
</QueryWipeEventsByUserResponse>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- events - (minOccurs=1, maxOccurs=1).
- event - (minOccurs=1, maxOccurs=1).
- deviceID - (minOccurs=1, maxOccurs=1). The
device id.
- deviceType - (minOccurs=1, maxOccurs=1).
Values are: [SmartPhone | PocketPC].
- eventTypeName - (minOccurs=1, maxOccurs=1).
- securityTrustee - (minOccurs=1, maxOccurs=1).
- authenticatedUser - (minOccurs=1,
maxOccurs=1).
- timeStamp - (minOccurs=1, maxOccurs=1).
|
|
SetUserPolicy |
Sets a users mobile policy
Syntax
C#
public SetUserPolicyResponse SetUserPolicy(SetUserPolicyRequest request) {
}
Parameters
request
The SetUserPolicyRequest contains the data used
in execution of SetUserPolicy.This class is an XmlSerialization
compliant class generated from an Xml Schema Definition.The Xml
Schema Definition document
SetUserPolicyRequest.xsd is shipped with the WES
and located in the root of the WES Virtual Directory. The following
shows the basic Xml format of the class:
Xml
Message Format |
<SetUserPolicyRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
<policyName>xs:string</policyName>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</SetUserPolicyRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- policyName - (minOccurs=1, maxOccurs=1). The
unique name of the policy.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The SetUserPolicyResponse class contains the
data returned after execution of SetUserPolicy.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
SetUserPolicyResponse.xsd is shipped with the WES
and located in the root of the WES Virtual Directory. The following
shows the basic Xml format of the class:
Xml
Message Format |
<SetUserPolicyResponse>
<Data>xs:string</Data>
</SetUserPolicyResponse>
|
|
SetUserPolicyExemption |
Sets a users mobile policy exemption.
Syntax
C#
public SetUserPolicyExemptionResponse SetUserPolicyExemption(SetUserPolicyExemptionRequest request) {
}
Parameters
request
The SetUserPolicyExemptionRequest contains the
data used in execution of SetUserPolicyExemption.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
SetUserPolicyExemptionRequest.xsd is shipped with
the WES and located in the root of the WES Virtual Directory. The
following shows the basic Xml format of the class:
Xml
Message Format |
<SetUserPolicyExemptionRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</SetUserPolicyExemptionRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The SetUserPolicyExemptionResponse class
contains the data returned after execution of
SetUserPolicyExemption.This class is an XmlSerialization compliant
class generated from an Xml Schema Definition.The Xml Schema
Definition document
SetUserPolicyExemptionResponse.xsd is shipped with
the WES and located in the root of the WES Virtual Directory. The
following shows the basic Xml format of the class:
Xml
Message Format |
<SetUserPolicyExemptionResponse>
<Data>xs:string</Data>
</SetUserPolicyExemptionResponse>
|
|
WipeActiveSyncDevice |
Send a remote wipe command to a specified Active Sync
device.
Syntax
C#
public WipeActiveSyncDeviceResponse WipeActiveSyncDevice(WipeActiveSyncDeviceRequest request) {
}
Parameters
request
The WipeActiveSyncDeviceRequest contains the
data used in execution of WipeActiveSyncDevice.This class is an
XmlSerialization compliant class generated from an Xml Schema
Definition.The Xml Schema Definition document
WipeActiveSyncDeviceRequest.xsd is shipped with
the WES and located in the root of the WES Virtual Directory. The
following shows the basic Xml format of the class:
Xml
Message Format |
<WipeActiveSyncDeviceRequest>
<Data>
<path>xs:string</path>
<preferredDomainController>xs:string</preferredDomainController>
<deviceID>xs:string</deviceID>
<deviceType>xs:string</deviceType>
</Data>
<Username>xs:string</Username>
<Password>xs:string</Password>
</WipeActiveSyncDeviceRequest>
|
Xml
Message Elements and Attributes |
- Data - (minOccurs=1, maxOccurs=1). The root
data node
- path - (minOccurs=1, maxOccurs=1). The LDAP
path of the user.
- preferredDomainController - (minOccurs=1,
maxOccurs=1). The name of the preferred domain controller.
- deviceID - (minOccurs=1, maxOccurs=1). The
device id.
- deviceType - (minOccurs=1, maxOccurs=1).
Values are: [SmartPhone | PocketPC].
- Username - (minOccurs=1, maxOccurs=1). The
user name credential to use for the operation.
- Password - (minOccurs=1, maxOccurs=1). The
password credential to use for the operation.
|
Return Value
The WipeActiveSyncDeviceResponse class contains
the data returned after execution of WipeActiveSyncDevice.This
class is an XmlSerialization compliant class generated from an Xml
Schema Definition.The Xml Schema Definition document
WipeActiveSyncDeviceResponse.xsd is shipped with
the WES and located in the root of the WES Virtual Directory. The
following shows the basic Xml format of the class:
Xml
Message Format |
<WipeActiveSyncDeviceResponse>
<Data>xs:string</Data>
</WipeActiveSyncDeviceResponse>
|
|
|