Hosted Exchange::GetPlans
This procedure returns a listing of service plans based on optional filters. Optional parameters statusTypeName, categoryName, and planTypeName, restrict the returned service plan records to those that match the criteria. You can use any combination of these parameters or issue none to retrieve an unfiltered list.
Arguments
| Input argument | Required | Description |
|---|---|---|
<preferredDomainController> |
Yes |
|
<planTypeName> |
No |
Filter listing by planTypeName (for example, ExchMailbox). |
<categoryName> |
No |
Filter listing by categoryName (for example, HeBusiness). |
<statusTypeName> |
No |
Filter listing by statusTypeName (for example, Enabled). |
| Output argument | Description |
|---|---|
<servicePlans>/<plan> |
Collection containing a listing of plans meeting the request criteria. |
Remarks
Provisioning Steps
- Hosted Exchange::GetPlanRecords_
Security
Impersonate caller.
Sample Code
Example XML Request
<request>
<procedure>
<execute namespace="Hosted Exchange" procedure="GetPlans" impersonate="1">
<executeData>
<planTypeName>ExchMailbox</planTypeName>
<categoryName>HeBusiness</categoryName>
<statusTypeName>Enabled</statusTypeName>
<preferredDomainController>AD01.fabrikam.Com</preferredDomainController>
</executeData>
<after source="executeData" destination="data" mode="merge" />
</execute>
</procedure>
</request>
Example XML Response
<response>
<data>
<planTypeName>ExchMailbox</planTypeName>
<categoryName>HeBusiness</categoryName>
<statusTypeName>Enabled</statusTypeName>
<preferredDomainController>AD01.fabrikam.Com</preferredDomainController>
<servicePlans>
<plan>
<planName>OutlookMail</planName>
<planDescription>Full Outlook client and Outlook Web Access support</planDescription>
<PlanStatus>Enabled</PlanStatus>
<dateCreated>2003-07-30T15:41:09.937000000</dateCreated>
<dateLastUpdated>2003-07-30T15:41:09.937000000</dateLastUpdated>
<planTypeName>ExchMailbox</planTypeName>
</plan>
<plan>
<planName>BasicMail</planName>
<planDescription>Basic Web Mail</planDescription>
<PlanStatus>Enabled</PlanStatus>
<dateCreated>2003-07-30T15:41:08.437000000</dateCreated>
<dateLastUpdated>2003-07-30T15:41:08.437000000</dateLastUpdated>
<planTypeName>ExchMailbox</planTypeName>
</plan>
<plan>
<planName>ProMail</planName>
<planDescription>Outlook Web Access with Calendar</planDescription>
<PlanStatus>Enabled</PlanStatus>
<dateCreated>2003-07-30T15:41:09.263000000</dateCreated>
<dateLastUpdated>2003-07-30T15:41:09.263000000</dateLastUpdated>
<planTypeName>ExchMailbox</planTypeName>
</plan>
</servicePlans>
</data>
</response>
Applies To
Hosted Exchange Namespace API for:
Hosted Messaging and Collaboration version 3.5
Hosted Messaging and Collaboration version 3.0