Помощник по сервису интеграции

Примеры сформированных запросов и ответов#

Формирование запроса на создание новой записи о лесосеке#

Для формирования запроса на создание записи о лесосеке необходимо предварительно сформировать запрос на создание записи о выделах.

<soapenv:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен/">
   <soapenv:Header>
      <api:EgaisRequestHeader apiVersion="версия API" operationId="?">
           <api:security>
                <api:credentials userLogin='логин пользователя' userPassword='пароль пользователя'/>
                <api:apiKey>идентификатор внешней системы</api:apiKey>
           </api:security>
      </api:EgaisRequestHeader>
   </soapenv:Header>
   <soapenv:Body>
      <api:RequestInsertDocument>
        <api:cuttingArea>
            <com:constituentEntityId>22</com:constituentEntityId>
            <com:number>1</com:number>
            <com:withdrawalDate>2018-09-21</com:withdrawalDate>
            <com:cuttingShapeId>1</com:cuttingShapeId>
            <com:cuttingKindId>8</com:cuttingKindId>
            <!--Optional:-->
            <com:forestriesNames>?</com:forestriesNames>
         </api:cuttingArea>
      </api:RequestInsertDocument>
   </soapenv:Body>
</soapenv:Envelope>

Формирование ответа на создание новой записи о лесосеке#

<soap:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен>
   <soap:Header>
      <ns4:EgaisResponseHeader техническая информация с атрибутами xmlns, определяющими пространства имен>
   </soap:Header>
   <soap:Body>
      < ns2:ResponseInsertDocument техническая информация с атрибутами xmlns, определяющими пространства имен>
         <ns2:cuttingArea id="1" createDate="2018-10-01T19:03:05.593+03:00" createdBy="логин пользователя, создавшего запись">
            <constituentEntityId>22</constituentEntityId>
            <number>1</number>
            <withdrawalDate>2018-09-21+03:00</withdrawalDate>
            <cuttingShapeId>1</cuttingShapeId>
            <cuttingKindId>8</cuttingKindId>
            <area>0</area>
         </ns2:cuttingArea>
      </ns2:ResponseInsertDocument>
   </soap:Body>
</soap:Envelope>

Формирование запроса на редактирование записи о лесосеке#

Формирование запроса на редактирование значения параметра «Номер лесосеки».

<soapenv:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен/">
   <soapenv:Header>
      <api:EgaisRequestHeader apiVersion="версия API" operationId="?">
           <api:security>
                <api:credentials userLogin='логин пользователя' userPassword='пароль пользователя'/>
                <api:apiKey>идентификатор внешней системы</api:apiKey>
           </api:security>
      </api:EgaisRequestHeader>
   </soapenv:Header>
   <soapenv:Body>
       <api:RequestUpdateDocument>
        <api:cuttingArea> id="1" createDate="2018-09-21T14:50:42.628+03:00" updateDate="2018-09-21T14:57:42.628+03:00" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись"            
            <com:constituentEntityId>22</com:constituentEntityId>
            <com:number>2</com:number>
            <com:withdrawalDate>2018-08-13</com:withdrawalDate>
            <com:cuttingShapeId>1</com:cuttingShapeId>
            <com:cuttingKindId>8</com:cuttingKindId>
            <!--Optional:-->
            <com:forestriesNames>?</com:forestriesNames>
         </api:cuttingArea>
     <api:RequestUpdateDocument>
   </soapenv:Body>
</soapenv:Envelope>

Формирование ответа на редактирование записи о лесосеке#

<soap:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен>
   <soap:Header>
      <ns4:EgaisResponseHeader техническая информация с атрибутами xmlns, определяющими пространства имен>
   </soap:Header>
   <soap:Body>
      <ns2:ResponseUpdateDocument техническая информация с атрибутами xmlns, определяющими пространства имен>
         <ns2:cuttingArea id="1" createDate="2018-10-01T19:03:05.593+03:00" updateDate="2018-10-01T19:09:59.135+03:00" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись">
            <constituentEntityId>22</constituentEntityId>
            <number>2</number>
            <withdrawalDate>2018-09-21+03:00</withdrawalDate>
            <cuttingShapeId>1</cuttingShapeId>
            <cuttingKindId>8</cuttingKindId>
            <area>0</area>
         </ns2:cuttingArea>
      </ns2:ResponseUpdateDocument>
   </soap:Body>
</soap:Envelope>

Формирование запроса на получение данных о лесосеке#

Для формирования запроса на получение информации о созданной лесосеке необходимо указать тип документа и его идентификатор.

<soapenv:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен/">
   <soapenv:Header>
      <api:EgaisRequestHeader apiVersion="версия API" operationId="?">
           <api:security>
                <api:credentials userLogin='логин пользователя' userPassword='пароль пользователя'/>
                <api:apiKey>идентификатор внешней системы</api:apiKey>
           </api:security>
      </api:EgaisRequestHeader>
   </soapenv:Header>
   <soapenv:Body>
      <api:RequestGetDocument>
         <api:DocumentRef id="1" DocumentType="cuttingArea"/>
      </api:RequestGetDocument>
   </soapenv:Body>
</soapenv:Envelope>

Формирование ответа на получение данных о лесосеке#

<soap:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен>
   <soap:Header>
      <ns4:EgaisResponseHeader техническая информация с атрибутами xmlns, определяющими пространства имен>
   </soap:Header>
   <soap:Body>
      <ns2:ResponseGetDocument техническая информация с атрибутами xmlns, определяющими пространства имен>
         <ns2:cuttingArea id="1" createDate="2018-10-01T19:03:05.593+03:00" updateDate="2018-10-01T19:09:59.135+03:00" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись">
            <constituentEntityId>22</constituentEntityId>
            <number>2</number>
            <withdrawalDate>2018-09-21+03:00</withdrawalDate>
            <cuttingShapeId>1</cuttingShapeId>
            <cuttingKindId>8</cuttingKindId>
            <area>0</area>
         </ns2:cuttingArea>
      </ns2:ResponseGetDocument>
   </soap:Body>
</soap:Envelope>

Формирование запроса на получение сведений о лесосеке
по заданным параметрам фильтрации
#

Формирование запроса на получение информации о созданных лесосеках по форме рубки.

<soapenv:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен/">
   <soapenv:Header>
      <api:EgaisRequestHeader apiVersion="версия API" operationId="?">
           <api:security>
                <api:credentials userLogin='логин пользователя' userPassword='пароль пользователя'/>
                <api:apiKey>идентификатор внешней системы</api:apiKey>
           </api:security>
      </api:EgaisRequestHeader>
   </soapenv:Header>
   <soapenv:Body>
      <api:RequestGetDocumentsByFilter DocumentType="cuttingArea" pageSize="1" pageNumber="0">
         <!--0 to 100 repetitions:-->
         <api:item>
            <fil:property>cuttingShapeId</fil:property>
            <!--1 or more repetitions:-->
            <fil:value>1</fil:value>
            <fil:operation>EQ</fil:operation>
         </api:item>
      </api:RequestGetDocumentsByFilter>
   </soapenv:Body>
</soapenv:Envelope> 

Формирование ответа на получение сведений о лесосеке
по заданным параметрам фильтрации
#

<soap:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен>
   <soap:Header>
      <ns4:EgaisResponseHeader техническая информация с атрибутами xmlns, определяющими пространства имен>
   </soap:Header>
   <soap:Body>
      <ns2:ResponseGetDocumentsByFilter pageSize="1" pageNumber="0" count="1" техническая информация с атрибутами xmlns, определяющими пространства имен>
         <ns2:cuttingArea id="1" createDate="2018-10-01T19:03:05.593+03:00" updateDate="2018-10-01T19:09:59.135+03:00" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись">
            <constituentEntityId>22</constituentEntityId>
            <number>2</number>
            <withdrawalDate>2018-09-21+03:00</withdrawalDate>
            <cuttingShapeId>1</cuttingShapeId>
            <cuttingKindId>8</cuttingKindId>
            <area>0</area>
         </ns2:cuttingArea>
      </ns2:ResponseGetDocumentsByFilter>
   </soap:Body>
</soap:Envelope>

Формирование запроса на добавление информации о выделах#

Для добавления информации о выделе в созданную лесосеку, необходимо сформировать запрос со значением «GROUP» параметра «value», где значение параметра «useSquare» – площадь лесосеки, га.

<soapenv:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен/">
   <soapenv:Header>
      <api:EgaisRequestHeader apiVersion="версия API" operationId="?">
           <api:security>
                <api:credentials userLogin='логин пользователя' userPassword='пароль пользователя'/>
                <api:apiKey>идентификатор внешней системы</api:apiKey>
           </api:security>
      </api:EgaisRequestHeader>
   </soapenv:Header>
   <soapenv:Body>
      <api:RequestInsertDocument>
		<api:plotFact>
            <com:cuttingPlotId>9</com:cuttingPlotId>
            <com:cuttingAreaId>9</com:cuttingAreaId>
            <com:activityPlace>
               <look:id>108</look:id>
            </com:activityPlace>
            <com:treeSpecie>
               <look:id>3</look:id>
            </com:treeSpecie>
            <com:woodBreedId>1301</com:woodBreedId>
            <com:useSquare>1</com:useSquare>
             <com:jsonData>{"timberWoodVolume":0,"fireWoodVolume":0,"illiquidWoodVolume":0,"age":0,"height":0,"ageGroup":{"id":"5","name":"Спелые"},"bonitet":{"id":8,"name":"V"},"completeness":0.1,"comment":"","landCharacteristicStartDate":{"id":"1","name":"Лесные насаждения"},"infrastructureNumber":"","maxUsedValue":0}</com:jsonData>
             <com:meta>
               <look:value>GROUP</look:value>
            </com:meta>
         </api:plotFact>
      </api:RequestInsertDocument>
   </soapenv:Body>
</soapenv:Envelope>

Формирование ответа на добавление информации о выделах#

<soap:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен>
   <soap:Header>
      <ns4:EgaisResponseHeader техническая информация с атрибутами xmlns, определяющими пространства имен>
   </soap:Header>
   <soap:Body>
      < ns2:ResponseInsertDocument техническая информация с атрибутами xmlns, определяющими пространства имен>
         <ns2:plotFact id="168" createDate="2018-10-16T17:21:42.663+03:00" createdBy="логин пользователя, создавшего запись">
            <cuttingPlotId>9</cuttingPlotId>
            <cuttingAreaId>9</cuttingAreaId>
            <activityPlace>
               <ns12:id>108</ns12:id>
               <ns12:name>Лесосека</ns12:name>
            </activityPlace>
            <treeSpecie>
               <ns12:id>3</ns12:id>
               <ns12:name>Мягколиственное</ns12:name>
            </treeSpecie>
            <woodBreedId>1301</woodBreedId>
            <useSquare>1</useSquare>
            <jsonData>{"age": 0, "height": 0, "bonitet": {"id": 8, "name": "V"}, "comment": "", "ageGroup": {"id": "5", "name": "Спелые"}, "completeness": 0.1, "maxUsedValue": 0, "fireWoodVolume": 0, "timberWoodVolume": 0, "illiquidWoodVolume": 0, "infrastructureNumber": "", "landCharacteristicStartDate": {"id": "1", "name": "Лесные насаждения"}}</jsonData>
            <meta>
               <ns12:value>GROUP</ns12:value>
            </meta>
         </ns2:plotFact>
      </ns2:ResponseInsertDocument>
   </soap:Body>
</soap:Envelope>

Формирование запроса на добавление информации об объёме
подлежащей заготовке древесины
#

Для добавления информации об объёме подлежащей заготовке древесины в созданный выдел, необходимо сформировать запрос со значением «REL» параметра «value», где значение параметра «useSquare» – площадь лесосеки, га, а «value» – общий объем, м3.

<soapenv:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен/">
   <soapenv:Header>
      <api:EgaisRequestHeader apiVersion="версия API" operationId="?">
           <api:security>
                <api:credentials userLogin='логин пользователя' userPassword='пароль пользователя'/>
                <api:apiKey>идентификатор внешней системы</api:apiKey>
           </api:security>
      </api:EgaisRequestHeader>
   </soapenv:Header>
   <soapenv:Body>
      <api:RequestInsertDocument>
		<api:plotFact>
            <com:cuttingPlotId>9</com:cuttingPlotId>
            <com:cuttingAreaId>9</com:cuttingAreaId>
            <com:activityPlace>
               <look:id>108</look:id>
            </com:activityPlace>
            <com:treeSpecie>
               <look:id>3</look:id>
            </com:treeSpecie>
            <com:woodBreedId>1301</com:woodBreedId>
            <com:useSquare>1</com:useSquare>
            <com:value>9</com:value>
            <com:value2>0</com:value2>
<com:jsonData>{"timberWoodVolume":5,"fireWoodVolume":2,"illiquidWoodVolume":2,"age":65,"height":22,"completeness":0.1,"comment":"","infrastructureNumber":"","maxUsedValue":0}</com:jsonData>
            <com:meta>
               <look:value>REL</look:value>
            </com:meta>
         </api:plotFact>
      </api:RequestInsertDocument>
   </soapenv:Body>
</soapenv:Envelope>

Формирование ответа на добавление информации об объёме
подлежащей заготовке древесины
#

<soap:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен>
   <soap:Header>
      <ns4:EgaisResponseHeader техническая информация с атрибутами xmlns, определяющими пространства имен>
   </soap:Header>
   <soap:Body>
      < ns2:ResponseInsertDocument техническая информация с атрибутами xmlns, определяющими пространства имен>
         <ns2:plotFact id="172" createDate="2018-10-16T18:35:04.749+03:00" createdBy="логин пользователя, создавшего запись">
            <cuttingPlotId>9</cuttingPlotId>
            <cuttingAreaId>9</cuttingAreaId>
            <activityPlace>
               <ns12:id>108</ns12:id>
               <ns12:name>Лесосека</ns12:name>
            </activityPlace>
            <treeSpecie>
               <ns12:id>3</ns12:id>
               <ns12:name>Мягколиственное</ns12:name>
            </treeSpecie>
            <woodBreedId>1301</woodBreedId>
            <useSquare>1</useSquare>
            <value>9.0</value>
            <value2>0.0</value2>
            <jsonData>{"age": 65, "height": 22, "comment": "", "completeness": 0.1, "maxUsedValue": 0, "fireWoodVolume": 2, "timberWoodVolume": 5, "illiquidWoodVolume": 2, "infrastructureNumber": ""}</jsonData>
            <meta>
               <ns12:value>REL</ns12:value>
            </meta>
         </ns2:plotFact>
      </ns2:ResponseInsertDocument>
   </soap:Body>
</soap:Envelope>

Выше