Hosted Office Communications Server::GetUserPlanAssignment

This procedure retrieves the details of the OCSUserHosting plan assigned to a specified user.

Use this procedure to retrieve the Office Communications Server Hosted Service subscription for a user.

Arguments

Remarks

Security

The caller must be at least a member of role: Customer Administrator

Permission Check

No explicit permission check is required for this procedure. The procedure calls Managed Plans::GetPlansByCustomer, which performs a check for Customer Administrator (UserCreators).

Preconditions

The specified user was previously subscribed to the service.

Business Rules

None.

Post-conditions

None.

Sequence Narrative

1. Actor submits GetUserPlanAssignment request to the Hosted Office Communications Server namespace.

2. GetUserPlanAssignment calls the GetPlanAssignment_ with the planTypeName filter equal to 'OCSUserHosting'. An exception is thrown if the user is not subscribed to an OCSUserHosting plan.

3. GetUserPlanAssignment calls the TransformUserPlanFeatures_ to transform the output format.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--LDAP path of the user.--> 
    <user>LDAP://CN=Johnc@AlpineSkiHouse.com,OU=AlpineSkiHouse,OU=ConsolidatedMessenger,OU=Hosting,DC=Fabrikam,DC=Com</user> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Office Communications Server" procedure="GetUserPlanAssignment" impersonate="1"> 
      <before source="data" sourcePath="user" 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 unique name of the plan--> 
    <planName>OCSBasicIM</planName> 
    <!--The description of the plan--> 
    <planDescription>Enable a user for Basic IM</planDescription> 
    <features> 
      <!--This allows the user to invite anonymous user to meeting.--> 
      <allowOrganizeMeetingWithAnonymousParticipants>true</allowOrganizeMeetingWithAnonymousParticipants> 
      <!--This enables the user for Office Communications Server.--> 
      <enabled>true</enabled> 
      <!--This enables the user for new advanced features of Office Communications Server.--> 
      <enabledForEnhancedPresence>true</enabledForEnhancedPresence> 
      <!--This enables the user to participate in a federated conversation.--> 
      <enabledForFederation>true</enabledForFederation> 
      <!--This enables the user for internet access.--> 
      <enabledForInternetAccess>true</enabledForInternetAccess> 
      <!--This setting controls the user ability to participate in conversations with public IM providers such as AOL, MSN and Yahoo.--> 
      <publicNetworkEnabled>true</publicNetworkEnabled> 
      <!--Specifies the name of the Meeting Policy to be applied to a user.--> 
      <meetingPolicy>Default Policy</meetingPolicy> 
      <!--This enables the user for Unified Communications.--> 
      <ucEnabled>true</ucEnabled> 
      <!--Specifies the name of the Unified Communications Policy to be applied to a user. This parameter must be present if ucEnabled is true.--> 
      <ucPolicy>Default Policy</ucPolicy> 
    </features> 
  </data> 
</response>

Applies To

Hosted Office Communications Server Namespace API for:

• Hosted Messaging and Collaboration version 4.5

See also

Tasks

Hosted Office Communications Server::ChangeUserPlanAssignment