Hosted Email 2007::GetOrganizationAvailablePlans

  • Article

This precedure returns a listing of service plans that are available for an organization's users.

Arguments

Input Arguments Required Description

<organization>

Yes

The Lightweight Directory Access Protocol (LDAP) path of the customer.

<preferredDomainController>

Yes

The Fully Qualified Domain Name (FQDN) of a domain controller.
Output Arguments Description

<availablePlans>

The collection of available service plans for this customer.

<availablePlans/ plan>

The container element for service plan details.

<availablePlans/ plan/ planName>

The name of the desired service plan.

<availablePlans/ plan/ planDescription>

Description of plan.

<availablePlans/ plan/ planStatus>

The status of this service plan.

<availablePlans/ plan/ dateCreated>

The date the service plan was created.

<availablePlans/ plan/ dateLastUpdated>

The last date the service plan record was updated.

<availablePlans/ plan/ planTypeName>

The plan type.

Remarks

Security

The caller must be at least a member of role: UserCreators.

Schema Definition

Input

<executeData>  
<organization>1..1 </organization> 
<preferredDomainController>1..1 </preferredDomainController> 
</executeData>

Output

<executeData>  
<availablePlans>1..1  
<plan>0..unbounded  
<planName>1..1 </planName> 
<planDescription>1..1 </planDescription> 
<planStatus>1..1 </planStatus> 
<dateCreated>1..1 </dateCreated> 
<dateLastUpdated>1..1 </dateLastUpdated> 
<planTypeName>1..1 </planTypeName> 
</plan> 
</availablePlans> 
</executeData>

Sample Code

Example XML Request

<request> 
  <data> 
    <!--LDAP path of the customer.--> 
    <organization>LDAP://OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</organization> 
    <!--FQDN of a domain controller. --> 
    <preferredDomainController>AD01.Fabrikam.com</preferredDomainController> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Email 2007" procedure="GetOrganizationAvailablePlans" impersonate="1"> 
      <before source="data" sourcePath="organization" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <!--The collection of available service plans for this customer--> 
    <availablePlans> 
      <!--Container element for service plan details--> 
      <plan> 
        <!--The name of the desired service plan.--> 
        <planName>GoldMailbox<planName> 
        <!--Description of plan--> 
        <planDescription>Premium Outlook Web Access</planDescription> 
        <!--The status of this service plan--> 
        <planStatus>Enabled</planStatus> 
        <!--The date the service plan was created--> 
        <dateCreated>2008-01-01T09:00:00.000000000</dateCreated> 
        <!--The last date the service plan record was updated--> 
        <dateLastUpdated>2008-02-02T09:00:00.000000000</dateLastUpdated> 
        <!--The plan type--> 
        <planTypeName>ExchBusinessUser</planTypeName> 
      </plan> 
    </availablePlans> 
  </data> 
</response>

Applies To

Hosted Email 2007 Namespace for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

See also

Tasks

Hosted Email 2007::AddAvailablePlans
Hosted Email 2007::GetUserPlanAssignment
Hosted Email 2007::CreateOrganizationPlan
Hosted Email 2007::CreateUserPlan
Hosted Email 2007::GetOrganizationPlan
Hosted Email 2007::GetUserPlanAssignment
Hosted Email 2007::GetServiceInformation
Hosted Email 2007::GetUserPlan
Hosted Email 2007::GetUserPlanAssignment
Hosted Email 2007::Initialize
Hosted Email 2007::ModifyOrganizationPlan
Hosted Email 2007::ModifyUserPlan
Hosted Email 2007::RemoveAvailablePlans
Hosted Email 2007::Subscribe
Hosted Email 2007::Unsubscribe