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

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

Формирование запроса на создание новой записи об отчёте о защите лесов#

Для формирования запроса на создание записи об отчётах о защите лесов должны быть предварительно созданы и подписаны правоустанавливающие документы (договор аренды лесного участка, право пользования лесным участком, государственный контракт или задание).
Подписание документа усиленной квалифицированной электронной подписью осуществляется в соответствующих реестрах ЕГАИС учёта древесины.

<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:contractReport sourceKey="?">
            <con4:reportType>contractSecurityReport</con4:reportType>
            <con4:contractNumber>10/2018</con4:contractNumber>
            <!--Optional:-->
            <con4:status>draft</con4:status>
            <con4:receiptDate>2018-10-24T19:03:55.167</con4:receiptDate>
            <con4:clientCreateTime>2018-10-24T19:03:55.167</con4:clientCreateTime>
            <con4:partyId>1207175</con4:partyId>
            <con4:underlyingContractRef id="P_130400" documentType="contractLease"/>
            <con4:woodlotElements/>
            <con4:startDate>2018-10-24T19:03:55.167</con4:startDate>
            <con4:reportingPeriod>
               <!--Optional:-->
               <con4:reportQuarter>3</con4:reportQuarter>
               <con4:reportingYear>2018</con4:reportingYear>
            </con4:reportingPeriod>
         </api:contractReport>
      </api:RequestInsertDocument>
   </soapenv:Body>
</soapenv:Envelope>

Формирование ответа на создание новой записи об отчёте о защите лесов#

<soap:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен>
   <soap:Header>
      <ns4:EgaisResponseHeader техническая информация с атрибутами xmlns, определяющими пространства имен>
   </soap:Header>
   <soap:Body>
      <ns2:ResponseInsertDocument техническая информация с атрибутами xmlns, определяющими пространства имен>
      <ns2:contractReport id="P_924158" documentId="P_3373383" createDate="2018-10-24T16:57:55.863+03:00" updateDate="2018-10-24T16:57:55.863+03:00" sourceSystem="T" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись" updatedBySystem="T" sourceKey="?">
            <ns9:reportType>contractSecurityReport</ns9:reportType>
            <ns9:contractNumber>10/2018</ns9:contractNumber>
            <ns9:status>draft</ns9:status>
            <ns9:receiptDate>2018-10-24T00:00:00.000+03:00</ns9:receiptDate>
            <ns9:clientCreateTime>2018-10-24T19:03:55.167+03:00
</ns9:clientCreateTime>
            <ns9:stateAuthorityId>22</ns9:stateAuthorityId>
            <ns9:partyId>1207175</ns9:partyId>
            <ns9:underlyingContractRef id="P_130400" documentType="contractLease"/>
            <ns9:woodlotElements/>
            <ns9:startDate>2018-10-24T00:00:00.000+03:00</ns9:startDate>
            <ns9:reportingPeriod>
               <ns9:reportQuarter>3</ns9:reportQuarter>
               <ns9:reportingYear>2018</ns9:reportingYear>
            </ns9:reportingPeriod>
         </ns2:contractReport>
      </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:contractReport sourceKey="?" id="P_924158" documentId="P_3373383">
            <con4:reportType>contractSecurityReport</con4:reportType>
            <con4:contractNumber>10/2018</con4:contractNumber>
            <!--Optional:-->
            <con4:status>draft</con4:status>
            <con4:receiptDate>2018-10-24T19:03:55.167</con4:receiptDate>
            <con4:partyId>1207175</con4:partyId>
            <con4:underlyingContractRef id="P_130400" documentType="contractLease"/>
            <con4:woodlotElements/>
            <con4:startDate>2018-10-24T19:03:55.167</con4:startDate>
            <con4:reportingPeriod>
               <!--Optional:-->
               <con4:reportQuarter>2</con4:reportQuarter>
               <con4:reportingYear>2018</con4:reportingYear>
            </con4:reportingPeriod>
         </api:contractReport>
      </api:RequestUpdateDocument>
   </soapenv:Body>
</soapenv:Envelope>

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

<soap:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен>
   <soap:Header>
      <ns4:EgaisResponseHeader техническая информация с атрибутами xmlns, определяющими пространства имен>
   </soap:Header>
   <soap:Body>
      <ns2:ResponseUpdateDocument техническая информация с атрибутами xmlns, определяющими пространства имен>
         <ns2:contractReport id="P_924157" documentId="P_3373382"createDate="2018-10-24T16:49:28.375+03:00" updateDate="2018-10-24T17:28:11.968+03:00" sourceSystem="T" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись" updatedBySystem="T" sourceKey="?">
            <ns9:reportType>contractSecurityReport</ns9:reportType>
            <ns9:contractNumber>10/2018</ns9:contractNumber>
            <ns9:status>draft</ns9:status>
            <ns9:receiptDate>2018-10-24T00:00:00.000+03:00</ns9:receiptDate>
            <ns9:clientCreateTime>2018-10-24T19:03:55.167+03:00
</ns9:clientCreateTime>
            <ns9:stateAuthorityId>22</ns9:stateAuthorityId>
            <ns9:partyId>1207175</ns9:partyId>
            <ns9:underlyingContractRef id="P_130400" documentType="contractLease"/>
            <ns9:woodlotElements/>
            <ns9:startDate>2018-10-24T00:00:00.000+03:00</ns9:startDate>
            <ns9:reportingPeriod>
               <ns9:reportQuarter>2</ns9:reportQuarter>
               <ns9:reportingYear>2018</ns9:reportingYear>
            </ns9:reportingPeriod>
         </ns2:contractReport>
      </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="P_924157" documentId="P_3373382" documentType="contractReforestationReport"/>
      </api:RequestGetDocument>
   </soapenv:Body>
</soapenv:Envelope>

Формирование ответа на получение данных об отчёте о защите лесов#

<soap:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен>
   <soap:Header>
      <ns4:EgaisResponseHeader техническая информация с атрибутами xmlns, определяющими пространства имен>
   </soap:Header>
   <soap:Body>
      <ns2:ResponseGetDocument техническая информация с атрибутами xmlns, определяющими пространства имен>
      <ns2:contractReport id="P_924157" documentId="P_3373382"createDate="2018-10-24T16:49:28.375+03:00" updateDate="2018-10-24T17:28:11.968+03:00" sourceSystem="T" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись" updatedBySystem="T" sourceKey="?">
            <ns9:reportType>contractSecurityReport</ns9:reportType>
            <ns9:contractNumber>10/2018</ns9:contractNumber>
            <ns9:status>draft</ns9:status>
            <ns9:receiptDate>2018-10-24T00:00:00.000+03:00</ns9:receiptDate>
            <ns9:clientCreateTime>2018-10-24T19:03:55.167+03:00
</ns9:clientCreateTime>
            <ns9:stateAuthorityId>22</ns9:stateAuthorityId>
            <ns9:partyId>1207175</ns9:partyId>
            <ns9:underlyingContractRef id="P_130400" documentType="contractLease"/>
            <ns9:woodlotElements/>
            <ns9:startDate>2018-10-24T00:00:00.000+03:00</ns9:startDate>
            <ns9:reportingPeriod>
               <ns9:reportQuarter>2</ns9:reportQuarter>
               <ns9:reportingYear>2018</ns9:reportingYear>
            </ns9:reportingPeriod>
         </ns2:contractReport>
      </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="contractSecurityReport" pageSize="10" pageNumber="0">
         <!--0 to 100 repetitions:-->
         <api:item>
            <fil:property>status</fil:property>
            <fil:value>1</fil:value>
            <!--Optional:-->
            <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 техническая информация с атрибутами xmlns, определяющими пространства имен>
      <ns2:contractReport id="P_924157" documentId="P_3373382"createDate="2018-10-24T16:49:28.375+03:00" updateDate="2018-10-24T17:28:11.968+03:00" sourceSystem="T" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись" updatedBySystem="T" sourceKey="?">
            <ns9:reportType>contractSecurityReport</ns9:reportType>
            <ns9:contractNumber>10/2018</ns9:contractNumber>
            <ns9:status>draft</ns9:status>
            <ns9:receiptDate>2018-10-24T00:00:00.000+03:00</ns9:receiptDate>
            <ns9:clientCreateTime>2018-10-24T19:03:55.167+03:00
</ns9:clientCreateTime>
            <ns9:stateAuthorityId>22</ns9:stateAuthorityId>
            <ns9:partyId>1207175</ns9:partyId>
            <ns9:underlyingContractRef id="P_130400" documentType="contractLease"/>
            <ns9:woodlotElements/>
            <ns9:startDate>2018-10-24T00:00:00.000+03:00</ns9:startDate>
            <ns9:reportingPeriod>
               <ns9:reportQuarter>2</ns9:reportQuarter>
               <ns9:reportingYear>2018</ns9:reportingYear>
            </ns9:reportingPeriod>
         </ns2:contractReport>
      </ns2:ResponseGetDocumentsByFilter>
   </soap:Body>
</soap:Envelope>

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

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

<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>1</com:cuttingPlotId>
             <!--Optional:-->
            <com:woodSiteId>1</com:woodSiteId>
             <!--Optional:-->
            <com:activity>
               <look:id>129</look:id>
               <!--Optional:-->
               <look:name>Предупреждение распространения вредных организмов</look:name>
               <!--Optional:-->
               <look:code>1200</look:code>
            </com:activity>
            <!--Optional:-->
            <com:activityPlace>
               <look:id>4</look:id>
               <!--Optional:-->
               <look:name>ОЗЛ</look:name>
            </com:activityPlace>
            <com:useSquare>5530</com:useSquare>
            <!--Optional:-->
            <com:value>1500</com:value>
            <!--Optional:-->
            <com:value2>3500</com:value2>
             <com:jsonData>{"timberWoodVolume":0,"fireWoodVolume":0,"illiquidWoodVolume":0,"age":0,"height":0,"completeness":0.1,"comment":"", "landCharacteristicStartDate":"id":"1","createdBy": "migration", "updatedBy":null,"createDate":"2018-05-19T17:42:47","updateDate":null,"sourceSystem": null,"sourceKey":null,"deleted":false,"initialId":null,"name":"Лесные насаждения","landCharacteristicKind":"id":1, "createdBy": "migration","updatedBy":null,"createDate":"2018-05-19T17:42:47","updateDate":null,"sourceSystem":null, "sourceKey":null,"deleted":false,"initialId":null,"name":"Лесные насаждения", "landCharacteristicKindCategory": {"id":1,"createdBy":null,"updatedBy":null,"createDate":null,"updateDate":null,"sourceSystem":null,"sourceKey":null, "deleted":null,"initialId":null,"name":"Лесные земли, занятые лесными насаждениями (покрытые лесной растительностью)"}},"value":"1"},"landCharacteristicEndDate":{"id":"1","createdBy":"migration","updatedBy":null,"createDate":"2018-05-19T17:42:47","updateDate":null,"sourceSystem":null, "sourceKey":null, "deleted":false, "initialId":null,"name":"Лесные насаждения","landCharacteristicKind": {"id":1,"createdBy":"migration","updatedBy":null,"createDate":"2018-05-19T17:42:47","updateDate":null, "sourceSystem":null,"sourceKey":null,"deleted":false,"initialId":null,"name":"Лесные насаждения","landCharacteristicKindCategory":"id":1,"createdBy":null,"updatedBy":null, "createDate":null,"updateDate":null,"sourceSystem":null,"sourceKey":null, "deleted":null,"initialId":null,"name": "Лесные земли, занятые лесными насаждениями (покрытые лесной растительностью)"}},"value":"1"}, "infrastructureNumber":"","maxUsedValue":0}</com:jsonData>
             <!--Optional:-->
            <com:meta>
               <look:value>REL</look:value>
            </com:meta>
            <!--Optional:-->
            <com:document id="P_3373382" documentType="contractSecurityReport"/>
         </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="122" createDate="2018-10-25T13:32:51.453+03:00" createdBy="логин пользователя, создавшего запись">
            <cuttingPlotId>1</cuttingPlotId>
            <woodSiteId>1</woodSiteId>
            <activity>
               <ns12:id>129</ns12:id>
               <ns12:name>Предупреждение распространения вредных организмов</ns12:name>
               <ns12:code>1200</ns12:code>
            </activity>
            <activityPlace>
               <ns12:id>4</ns12:id>
               <ns12:name>ОЗЛ</ns12:name>
            </activityPlace>
            <useSquare>5530</useSquare>
            <value>1500.0</value>
            <value2>3500.0</value2>
            <jsonData>{"age": 0, "height": 0, "comment": "", "completeness": 0.1, "maxUsedValue": 0, "fireWoodVolume": 0, "timberWoodVolume": 0, "illiquidWoodVolume": 0, "infrastructureNumber": "", "landCharacteristicEndDate": {"id": "1", "name": "Лесные насаждения", "value": "1", "deleted": false, "createdBy": "migration", "initialId": null, "sourceKey": null, "updatedBy": null, "createDate": "2018-05-19T17:42:47", "updateDate": null, "sourceSystem": null, "landCharacteristicKind": {"id": 1, "name": "Лесные насаждения", "deleted": false, "createdBy": "migration", "initialId": null, "sourceKey": null, "updatedBy": null, "createDate": "2018-05-19T17:42:47", "updateDate": null, "sourceSystem": null, "landCharacteristicKindCategory": {"id": 1, "name": "Лесные земли, занятые лесными насаждениями (покрытые лесной растительностью)", "deleted": null, "createdBy": null, "initialId": null, "sourceKey": null, "updatedBy": null, "createDate": null, "updateDate": null, "sourceSystem": null} } }, "landCharacteristicStartDate": {"id": "1", "name": "Лесные насаждения", "value": "1", "deleted": false, "createdBy": "migration", "initialId": null, "sourceKey": null, "updatedBy": null, "createDate": "2018-05-19T17:42:47", "updateDate": null, "sourceSystem": null, "landCharacteristicKind": {"id": 1, "name": "Лесные насаждения", "deleted": false, "createdBy": "migration", "initialId": null, "sourceKey": null, "updatedBy": null, "createDate": "2018-05-19T17:42:47", "updateDate": null, "sourceSystem": null, "landCharacteristicKindCategory": {"id": 1, "name": "Лесные земли, занятые лесными насаждениями (покрытые лесной растительностью)", "deleted": null, "createdBy": null, "initialId": null, "sourceKey": null, "updatedBy": null, "createDate": null, "updateDate": null, "sourceSystem": null} } } }</jsonData>
            <meta>
               <ns12:value>REL</ns12:value>
            </meta>
            <document id="P_3373382" documentType="contractSecurityReport"/>
         </ns2:plotFact>
      </ns2:ResponseInsertDocument>
   </soap:Body>
</soap:Envelope>

Выше