Click to Rate and Give Feedback
TechNet
TechNet Library

  Switch on low bandwidth view
Hosted Office Communications Server Namespace API
Hosted Office Communications Server Namespace API

This document provides the details of the application programming interface (API) for the Hosted Office Communications Server namespace included with the Microsoft® Provisioning System (MPS) in Hosted Messaging and Collaboration version 4.5.

Contained herein are descriptions of the procedures of this namespace along with input parameters and return values. In addition, example XML requests are provided along with a typical Extensible Markup Language (XML) response that the provisioning system returns after a request is submitted to MPS and tasks are completed.

Developers should use this API document as a reference when creating XML requests that initiate the provisioning of Microsoft Office Communications Server 2007 services or as a basis for review of the Office Communications Server 2007 named procedures that are implemented in the Web Service.

Overview

The Hosted Office Communications Server namespace is a new namespace for Microsoft Office Communications Server 2007 Hosting that provides a set of Microsoft Provisioning Framework (MPF) public named procedures for the provisioning of Office Communications Server 2007 services. The namespace enables service providers to provision Office Communications Server 2007-enabled users in the managed provisioning environment of MPS. The Hosted Office Communications Server namespace interacts with the Managed Office Communications Server namespace, the Managed Plans namespace, and the Managed Helpers namespace to support provisioning tasks.

Public MethodDescription
Hosted Office Communications Server::AddAvailablePlansAdds Office Communications Server user service plans to the available plans list for an organization.
Hosted Office Communications Server::ChangeOrganizationPlanAssignmentChanges the plan assigned to an organization by specifying a new plan
Hosted Office Communications Server::ChangeUserPlanAssignmentChanges the plan assigned to a user by specifying a new plan.
Hosted Office Communications Server::CreateOrganizationPlanCreates an organization plan.
Hosted Office Communications Server::CreateSipDomainCreates a new SIP Domain for the organization.
Hosted Office Communications Server::CreateSipUserCreates a SIP account for an existing Active Directory user. The Office Communications Server settings are determined by the supplied service plan.
Hosted Office Communications Server::CreateUserPlanCreates a user plan for the Office Communications Server service
Hosted Office Communications Server::DeleteSipDomainDeleates a SIP Domain for the organization.
Hosted Office Communications Server::DeleteSipUserDeletes a SIP account from an Active Directory User.
Hosted Office Communications Server::DisableSipUserDisables a user to access to Office Communications Server serivce.
Hosted Office Communications Server::EnableSipUserEnables a user to access to Office Communications Server serivce.
Hosted Office Communications Server::GetOrganizationAvailablePlansReturns a listing of service plans that are available for the users of an organization.
Hosted Office Communications Server::GetOrganizationPlanRetrieves the details of a specified organization plan.
Hosted Office Communications Server::GetOrganizationPlanAssignmentRetrieves the details of the Office Communications Server plan assigned to an organization.
Hosted Office Communications Server::GetPoolAssignmentRetrieves the distinguished name of the Application Pool assigned to the organization.
Hosted Office Communications Server::GetPoolPropertiesRetrieves the properties of a pool.
Hosted Office Communications Server::GetPoolsGets a listing of Office Communications Server Application Pools.
Hosted Office Communications Server::GetServiceInformationRetrieves identifier for this service.
Hosted Office Communications Server::GetSipDomainsByOrganizationGets all SIP domains assigned to an organization.
Hosted Office Communications Server::GetSipUserPropertiesGets Office Communications Server properties from a user enabled for Office Communications Server.
Hosted Office Communications Server::GetUserPlanRetrieves the details of the specified OCSUserHosting plan.
Hosted Office Communications Server::GetUserPlanAssignmentRetrieves the details of the OCSUserHosting plan assigned to a specified user.
Hosted Office Communications Server::InitializeInitializes the Hosted Office Communications Server namespace.
Hosted Office Communications Server::ModifyOrganizationPlanModifies an organization OCSOrgHosting plan.
Hosted Office Communications Server::ModifyUserPlanModifies a user plan.
Hosted Office Communications Server::RemoveAvailablePlansRemoves service plans from the available plans list for an organization.
Hosted Office Communications Server::SetPoolAssignmentAssigns a pool to an organization.
Hosted Office Communications Server::SetSipUserPropertiesSets Office Communications Server properties on a user enabled for Office Communications Server.
Hosted Office Communications Server::SubscribeSubscribes to the Hosted Office Communications Server service.
Hosted Office Communications Server::UnsubscribeUnsubscribes from the Hosted Office Communications Server service.
Hosted Office Communications Server::ValidateSipDomainOwnershipValidates that a SIP domain is owned by an organization or its parent.
 Applies To
© 2009 Microsoft Corporation. All rights reserved. Terms of Use | Trademarks | Privacy Statement
Page view tracker