pp108 : getUnit

getUnit

This method returns the details of a Unit.

Note: The use of this method is deprecated; use getUnitDetails instead.

SOAP Request

<SOAP:Envelope xmlns:SOAP="http://schemas.xmlsoap.org/soap/envelope/">
    <SOAP:Body>
        <getUnit xmlns="http://schemas.cordys.com/orgmodel/runtime/OrgModel/1.0">
            <unitId>[UnitID]</unitId>
            <unitQName>[UnitQName]</unitQName>
        </getUnit>
    </SOAP:Body>
</SOAP:Envelope>

Request Parameters Description

Parameter

Description

Data Type

Accepted Input Value

UnitID

Document ID of the Unit

String

Usually GUID

UnitQName

Qualified name of the Unit

String

If both UnitID and UnitQName are specified, it returns the unit corresponding to the given UnitID. However, if no unit exists for the given UnitID, it returns the unit corresponding to the given UnitQName.

SOAP Response

<getUnitResponse xmlns="http://schemas.cordys.com/orgmodel/runtime/OrgModel/1.0">
    <getUnit>[Unit]</getUnit>
</getUnitResponse>

Response Parameters

Parameter

Description

Unit

String containing XML that specifies details of the unit. See the sample code below.

The value that is returned is a string containing Unit information. The string is XML, and has the following syntax:

<Unit>
    <Id>[Unit ID]</Id>
    <Name>[Unit name]</Name>
    <Description>[Unit description]</Description>
    <QName>[Unit qualified name]</QName>
    <Space>[Unit deployment space ('organization' or 'isv')]</Space>
</Unit>