Hosted Office Communications Server::GetUserPlan

This procedure retrieves the details of the specified OCSUserHosting plan.

Arguments

Remarks

Security

No restriction.

Permission Check

No explicit permission check is required for this procedure. The procedure calls Managed Plans::GetPlan, which contains no permission restriction.

Preconditions

• The Hosted Office Communications Server namespace was initialized.

• The specified plan was previously created.

Business Rules

The specified plan is of type 'OCSUserHosting'.

Post-conditions

None.

Sequence Narrative

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

2. The Hosted Office Communications Server namespace calls the private procedure GetPlanWithTypeValidation_ to get the plan and validate its type. This will validate that the plan submitted is of the required type "OCSUserHosting". If not, an exception will be thrown by the called procedure.

3. An after transform is used on the results of GetPlan to transform its output to the output defined by the procedures schema.

Sample Code

Example XML Request

<request> 
  <data> 
    <!--The name of the plan--> 
    <planName>OCSBasicIM</planName> 
    <!--The domain controller to use for Active Directory actions.--> 
    <preferredDomainController>AD01.Fabrikam.Com</preferredDomainController> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Office Communications Server" procedure="GetUserPlan" impersonate="1"> 
      <before source="data" sourcePath="planName" 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::CreateUserPlan
Hosted Office Communications Server::ModifyUserPlan