Share via

Hosted Exchange::GetAvailablePlans

  • Article

This procedure retrieves the plans that are defined as available for a specified organization.

Arguments

Input argument Required Description

<path>

Yes

The Lightweight Directory Access Protocol (LDAP) path of organization.

<preferredDomainController>

Yes

Output argument Description

<servicePlans>/<plan>

Collection containing plan details for plans available to an organization.

Remarks

Provisioning Steps

  1. Managed Active Directory::TestPermissions_ - UserCreator role

  2. Hosted Exchange::GetCustomerAvailablePlansRecord_

Security

  • Impersonate caller.

  • Caller tested for UserCreator role.

Sample Code

Example XML Request

<request>   
        <procedure>     
                <execute namespace="Hosted Exchange" procedure="GetAvailablePlans" impersonate="1">       
                        <executeData>         
                                <path>LDAP://OU=alpineskihouse,OU=WH,OU=Hosting,DC=fabrikam,DC=Com</path>         
                                <preferredDomainController>AD01.fabrikam.com</preferredDomainController>       
                        </executeData>       
                        <after source="executeData" destination="data" mode="merge"/>     
                </execute>   
        </procedure> 
</request>

Example XML Response

<response>   
        <data>     
                <path>LDAP://OU=alpineskihouse,OU=WH,OU=Hosting,DC=fabrikam,DC=Com</path>     
                <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

See also

Tasks

Hosted Exchange::AddAvailablePlans