Hosted Office Communications Server::SetSipUserProperties

This procedure sets Office Communications Server properties on a user enabled for Office Communications Server.

Use this procedure to set OCS properties on a user enabled for the service. This will override any properties that were set by the service plan.

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 Office Communications Server::SetUserSipProperties, which performs a check for Customer Administrator (UserCreators).

Preconditions

The user is subscribed to the Hosted Office Communications Server service user plan.

Business Rules

None.

Post-conditions

The specified properties will be modified.

Sequence Narrative

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

2. SetSipUserProperties call GetUserPlanAssignment. This validates that the user is enabled for the service.

3. SetSipUserProperties call Managed Office Communications Server::SetSipUserProperties.

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> 
    <!--If true, this user is authorized for; if false, the user does not have specific support under SIP--> 
    <enabled>1</enabled> 
    <!--If true the user is enabled for enhanced presence. If false the user is not enabled for enhanced presence. The default is false--> 
    <enabledForEnhancedPresence>0</enabledForEnhancedPresence> 
    <!--If true the user is enabled for federation. If false the user is not enabled for federation. The default is false--> 
    <enabledForFederation>0</enabledForFederation> 
    <!--If true the user is enabled for Internet access. If false the user is not enabled for Internet access. The default is false--> 
    <enabledForInternetAccess>0</enabledForInternetAccess> 
    <!--The distinguished name of the home server for this user. This name must be valid within the domain's Active Directory. The value of this property is not case-sensitive. This value cannot be NULL--> 
    <homeServerDN>CN=LC Services,CN=Microsoft,CN=pool,CN=Pools,CN=RTC Service,CN=Microsoft,CN=System,DC=fabrikam,DC=com</homeServerDN> 
    <!--The primary SIP URI of the user. This URI must be unique and must be represented in the form "sip:user@domain" where the domain substring is either a fully qualified domain name or a valid IP address. Domains cannot be 0.0.0.0 or any multicast domain address from 224.0.0.0 to 239.255.255.255--> 
    <primaryURI>SIP:JohnC@AlpineSkihouse.com</primaryURI> 
    <!--Controls whether the user is able to exchange instant messages with other users who are hosted by one or more public IM service providers. If true, the user is authorized for public IM connectivity. If false, the user not authorized for public IM connectivity. The default is false--> 
    <publicNetworkEnabled>0</publicNetworkEnabled> 
    <!--This allows the user to invite anonymous user to meeting.--> 
    <allowOrganizeMeetingWithAnonymousParticipants>true</allowOrganizeMeetingWithAnonymousParticipants> 
    <!--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> 
    <!--Controls whether a user's communications across federated domains are archived.--> 
    <archiveFederatedCommunications>true</archiveFederatedCommunications> 
    <!--Controls whether a user's communications within their internal domain are archived.--> 
    <archiveInternalCommunications>true</archiveInternalCommunications> 
    <!--Controls whether the user is enabled for both remote call control and Enterprise voice.  Requires that the UCEnabled be set to true.--> 
    <ipPBXSoftPhoneRoutingEnabled>true</ipPBXSoftPhoneRoutingEnabled> 
    <!--The SIP URI of the telephony gateway server assigned to this user for remote-call control (RCC).--> 
    <lineServerURI>sip:server01@pbx1.phones.fabrikam.com</lineServerURI> 
    <!--Either the SIP URI or the Tel. URI of the user's phone line. This value is used by the Microsoft Office Communicator client and by Enterprise Voice for call routing.--> 
    <lineURI>tel:+15555550101</lineURI> 
    <!--Controls whether the user is able to use the Microsoft Office Communicator client in combination with the user's computer to initiate, receive, and forward phone calls.--> 
    <remoteCallControlTelephonyEnabled>true</remoteCallControlTelephonyEnabled> 
  </data> 
  <procedure> 
    <execute namespace="Hosted Office Communications Server" procedure="SetSipUserProperties" impersonate="1"> 
      <before source="data" sourcePath="user" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="preferredDomainController" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="enabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="enabledForEnhancedPresence" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="enabledForFederation" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="enabledForInternetAccess" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="homeServerDN" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="primaryURI" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="publicNetworkEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="allowOrganizeMeetingWithAnonymousParticipants" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="meetingPolicy" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="ucEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="ucPolicy" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="archiveFederatedCommunications" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="archiveInternalCommunications" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="ipPBXSoftPhoneRoutingEnabled" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="lineServerURI" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="lineURI" destination="executeData" mode="move" /> 
      <before source="data" sourcePath="remoteCallControlTelephonyEnabled" destination="executeData" mode="move" /> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response>  
  <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::Initialize