GetHieMembers

Syntax

GetHieMembersResult GetHieMembers(HieId tHie, GetHieMembersArg tArg)

Parameters

tHie. Indicators hierarchy moniker.

tArg. Parameters for getting the list of indicators elements.

Description

The GetHieMembers operation gets the list of elements of the indicators hierarchy.

Comments

To execute the operation, in the tHie parameter specify hierarchy moniker, and in the tArg field specify parameters for getting information about the indicators. The moniker can be obtained on executing the OpenHie operation. The operation results in the collection of indicators available in the hms field.

Example

Below is the example of getting the list of indicators hierarchy elements. The request contains indicators hierarchy moniker. The response contains the obtained list.

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<GetHieMembers xmlns="http://www.fsight.ru/PP.SOM.Som">
<tHie xmlns="">
  <id>S1!M!S!H2</id>
  </tHie>
<tArg xmlns="">
<parent>
  <p />
  </parent>
  <filter />
<pattern>
  <attributes />
  <getAttsTextValues>true</getAttsTextValues>
  </pattern>
  </tArg>
  </GetHieMembers>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetHieMembersResult xmlns="http://www.fsight.ru/PP.SOM.Som" xmlns:q1="http://www.fsight.ru/PP.SOM.Som" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id xmlns="">
  <id>S1!M!S!H2</id>
  </id>
<parent xmlns="">
  <p />
  </parent>
<hms xmlns="">
<m isLeaf="0">
  <p>1@1</p>
  <n>Annual</n>
  <o>0</o>
  </m>
  </hms>
  <notEof xmlns="">0</notEof>
  </GetHieMembersResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetHieMembers" :
{
"tHie" :
{
"id" : "S1!M!S!H2"
},
"tArg" :
{
"parent" :
{
"p" : ""
},
"filter" : "",
"pattern" :
{
"attributes" : "",
"getAttsTextValues" : "true"
}
}
}
}

JSON response:

{
"GetHieMembersResult" :
{
"id" :
{
"id" : "S1!M!S!H2"
},
"parent" :
{
"p" : ""
},
"hms" :
{
"m" :
{
"@isLeaf" : "0",
"p" : "1@1",
"n" : "Annual",
"o" : "0"
}
},
"notEof" : "0"
}
}
public static GetHieMembersResult  GetHieMembers(HieId id)
{
var somClient = new SomPortTypeClient(); //Proxy object for operation execution
//Operation execution parameters
var tMembers = new GetHieMembers()
{
tArg = new GetHieMembersArg()
{
parent = new HmKey() { p = string.Empty },
filter = new HmsFilter(),
pattern = new HmsPattern()
{
attributes = string.Empty,
getAttsTextValues = true
}
},
tHie = id
};
//Get indicators list
var result = somClient.GetHieMembers(tMembers);
return result;
}

See also:

Working with Time Series Database