Skip Navigation
  1. BlackBerry Docs
  2. BlackBerry AtHoc
  3. BlackBerry AtHoc SDKs and APIs 7.13
  4. SDK Specification
  5. Content APIs
  6. Get hierarchy

Get hierarchy

Retrieve the organizational, distribution list, or location hierarchy.
The payload type is 
GET-HIERARCHY
.
The payload content should be in the following format: 
<hierarchy type="hierarchy-type" commonName="common name" id="hierarchy_Or_DL_ID" />
<HIERARCHY> nodes
Tag
Mandatory
Description
<hierarchy>
Yes
Attributes: either id, type, or commonName is required. Precedence rule: id, then type, and then commonName. The first attribute found in the precedence is used, the others will be ignored.
  • id
    —The ID of a hierarchy or distribution list.
  • type
    —Specifies the type of hierarchy to return; it can be blank or one of the following:
    • USERBASE—The complete organizational hierarchy.
    • DISTLIST—Only the static and dynamic distribution lists from the organizational hierarchy.
    • LOCATION—IP distribution lists.
  • commonName
    —The common name of a hierarchy or distribution list.
The SDK response will be: 
<hierarchy type="USERBASE|DISTLIST|[blank]" commonName="">
<node path="/">
<providerId>1111111</providerId>
<name>hierarchy node name</name>
<commonName>hierarchy node common name</commonName>
<lineage>/</lineage>
<listType>TREE|DYNAMIC|STATIC|Group|GrouopSet</listType>
<availableForTargeting>Y|N</availableForTargeting>
<availableForManagement>Y|N</availableForManagement>
<node path="…">
… …
</node>
</hierarchy>
GET-HIERARCHY SDK requests and responses are internationalization-enabled. For a list of supported Windows 1252 characters, see Internationalization-supported characters.