Show contents 

Web Service > Web Service Operations > Working with Dictionaries > GetDimElements > Getting Information about Dictionary Elements

Getting Information about Dictionary Elements

Below is the example of using the GetDimElements operation to get information about all dictionary elements. The request contains moniker of opened dictionary instance. The response contains basic information about the elements: key, name, elements level and indication of child elements.

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">
<GetDimElements xmlns="http://www.fsight.ru/PP.SOM.Som">
<tDim xmlns="">
  <id>S1!M!S!S1</id>
  </tDim>
  <tArg xmlns="" />
  </GetDimElements>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetDimElementsResult 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">
<els xmlns="">
<e>
  <n>Item 1</n>
  <k>1</k>
  <h>1</h>
  <o>0</o>
  </e>
<e>
  <n>Item 2</n>
  <k>2</k>
  <h>1</h>
  <o>1</o>
  </e>
<e>
  <n>Item 3</n>
  <k>3</k>
  <h>0</h>
  <o>2</o>
  </e>
<e>
  <n>Item 4</n>
  <k>4</k>
  <h>0</h>
  <o>0</o>
  </e>
<e>
  <n>Fifth element</n>
  <k>5</k>
  <h>0</h>
  <o>0</o>
  </e>
  </els>
<id xmlns="">
  <id>S1!M!S!S1</id>
  </id>
  </GetDimElementsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "GetDimElements" : 
  {
   "tDim" : 
    {
     "id" : "S1!M!S!S1"
    },
   "tArg" : ""
  }
}

JSON response:

{
 "GetDimElementsResult" : 
  {
   "els" : 
    {
     "e" : 
      [
        {
         "n" : "First element",
         "k" : "1",
         "h" : "1",
         "o" : "0"
        },
        {
         "n" : "Second element",
         "k" : "2",
         "h" : "1",
         "o" : "1"
        },
        {
         "n" : "Third element",
         "k" : "3",
         "h" : "0",
         "o" : "2"
        },
        {
         "n" : "Fourth element",
         "k" : "4",
         "h" : "0",
         "o" : "0"
        },
        {
         "n" : "Fifth element",
         "k" : "5",
         "h" : "0",
         "o" : "0"
        }
      ]
    },
   "id" : 
    {
     "id" : "S1!M!S!S1"
    }
  }
}
public static GetDimElementsResult GetElementsInfo(DmId moniker)
{
    var somClient = new SomPortTypeClient(); //Proxy object for operation execution
    //Operation execution parameters
    var tElements = new GetDimElements()
    {
        tArg = new GetDimElementsArg(),
        tDim = moniker
    };
    //Get information about dictionary elements
    var result = somClient.GetDimElements(tElements);
    return result;
}

See also:

GetDimElements: Operation