Hosted Office Communications Server::GetServiceInformation

  • Article

This procedure retrieves identifier for this service.

Use this procedure to retrieve the service information that is used to register the service with the plan manager database. This procedure simply returns values that are hard-coded in the MPS namespace.

Arguments

Output argument Type Description

<serviceId>

xs:string

The Globally Unique Identifier (GUID) that uniquely identifies the service.

<serviceName>

xs:string

The name that uniquely identifies the service.

<serviceDescription>

xs:string

The description of the service.

Remarks

Security

No restriction.

Permission Check

No explicit check is performed for this procedure as access to the procedure is unrestricted.

Preconditions

None.

Business Rules

None.

Post-conditions

None.

Sequence Narrative

  1. The Actor submits a GetServiceInformation request to the Hosted Office Communications Server namespace.

  2. GetServiceInformation returns the information by using a simple transform.

Sample Code

Example XML Request

<request> 
  <procedure> 
    <execute namespace="Hosted Office Communications Server" procedure="GetServiceInformation" impersonate="1"> 
      <after source="executeData" destination="data" mode="merge" /> 
    </execute> 
  </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <!--The GUID to be assigned to the service. Each service has a unique serviceId.--> 
    <serviceId>522C2F96E44647159C006C88332326D1</serviceId> 
    <!--The unique name of the service.--> 
    <serviceName>HostedOCS</serviceName> 
    <!--The description of the service.--> 
    <serviceDescription>OCS hosting services</serviceDescription> 
  </data> 
</response>

Applies To

Hosted Office Communications Server Namespace API for:

  • Hosted Messaging and Collaboration version 4.5