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

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

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

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

<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>contractReforestationReport</con4:reportType>
            <con4:contractNumber>25/2018</con4:contractNumber>
            <!--Optional:-->
            <con4:status>draft</con4:status>
            <con4:receiptDate>2018-10-23T19:03:55.167</con4:receiptDate>
            <con4:clientCreateTime>2018-10-23T19:03:55.167</con4:clientCreateTime>
            <con4:partyId>1207175</con4:partyId>
            <con4:underlyingContractRef id="P_3204" documentType="contractRight"/>
            <con4:woodlotElements/>
            <con4:startDate>2018-10-23T19:03:55.167</con4:startDate>
            <con4:reportingPeriod>
               <!--Optional:-->
               <con4:reportQuarter>1</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 createDate="2018-10-23T19:03:55.406+03:00" updateDate="2018-10-23T19:03:55.406+03:00" sourceSystem="T" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись" updatedBySystem="T" id="P_924144" documentId="P_3373261" sourceKey="?">
            <ns9:reportType>contractReforestationReport</ns9:reportType>
            <ns9:contractNumber>25/2018</ns9:contractNumber>
            <ns9:status>draft</ns9:status>
            <ns9:receiptDate>2018-10-23T00:00:00.000+03:00</ns9:receiptDate>
            <ns9:clientCreateTime>2018-10-23T19:03:55.167+03:00
</ns9:clientCreateTime>
            <ns9:stateAuthorityId>22</ns9:stateAuthorityId>
            <ns9:partyId>1207175</ns9:partyId>
            <ns9:underlyingContractRef id="P_3204" documentType="contractRight"/>
            <ns9:woodlotElements/>
            <ns9:startDate>2018-10-23T00:00:00.000+03:00</ns9:startDate>
            <ns9:reportingPeriod>
               <ns9:reportQuarter>1</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_924144" documentId="P_3373261">
            <con4:reportType>contractReforestationReport</con4:reportType>
            <con4:contractNumber>25/2018</con4:contractNumber>
            <!--Optional:-->
            <con4:status>draft</con4:status>
            <con4:receiptDate>2018-10-23T19:03:55.167</con4:receiptDate>
            <con4:clientCreateTime>2018-10-23T19:03:55.167</con4:clientCreateTime>
            <con4:partyId>1207175</con4:partyId>
            <con4:underlyingContractRef id="P_3204" documentType="contractRight"/>
            <con4:woodlotElements/>
            <con4:startDate>2018-10-23T19: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 createDate="2018-10-23T19:03:55.406+03:00" updateDate="2018-10-23T19:03:55.406+03:00" sourceSystem="T" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись" updatedBySystem="T" id="P_924144" documentId="P_3373261" sourceKey="?">
            <ns9:reportType>contractReforestationReport</ns9:reportType>
            <ns9:contractNumber>25/2018</ns9:contractNumber>
            <ns9:status>draft</ns9:status>
            <ns9:receiptDate>2018-10-23T00:00:00.000+03:00</ns9:receiptDate>
            <ns9:clientCreateTime>2018-10-23T19:03:55.167+03:00
</ns9:clientCreateTime>
            <ns9:stateAuthorityId>22</ns9:stateAuthorityId>
            <ns9:partyId>1207175</ns9:partyId>
            <ns9:underlyingContractRef id="P_3204" documentType="contractRight"/>
            <ns9:woodlotElements/>
            <ns9:startDate>2018-10-23T00: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>        

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

Для добавления информации о мероприятии лесного семеноводства в созданный отчёт о воспроизводстве лесов необходимо сформировать запрос со значением «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>76</com:cuttingPlotId>
             <!--Optional:-->
            <com:activity>
               <look:id>1</look:id>
               <!--Optional:-->
               <look:name>Заготовка семян лесных растений для лесовосстановления и лесоразведения*</look:name>
               <!--Optional:-->
               <look:code>100</look:code>
            </com:activity>
            <!--Optional:-->
            <com:activityPlace>
               <look:id>1</look:id>
               <!--Optional:-->
               <look:name>ОВЛ: Лесное семеноводство</look:name>
            </com:activityPlace>
            <!--Optional:-->
            <com:woodBreedId>1301</com:woodBreedId>
            <!--Optional:-->
            <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": "11", "name": "Пашни"},"landCharacteristicEndDate": {"id": "1", "name": "Лесные насаждения"},"infrastructureNumber":"","forestryPlantationType": {"id": "3", "name": "Культуры под пологом  леса (подпологовые)"},"maxUsedValue":0}</com:jsonData>
            <!--Optional:-->
            <com:meta>
               <look:value>REL</look:value>
            </com:meta>
            <!--Optional:-->
            <com:document id="P_3373261" documentType="contractReforestationReport"/>
         </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="350" createDate="2018-10-24T13:41:55.071+03:00" createdBy="логин пользователя, создавшего запись">
            <cuttingPlotId>76</cuttingPlotId>
            <activity>
               <ns12:id>1</ns12:id>
               <ns12:name>Заготовка семян лесных растений для лесовосстановления и лесоразведения*</ns12:name>
               <ns12:code>100</ns12:code>
            </activity>
            <activityPlace>
               <ns12:id>1</ns12:id>
               <ns12:name>ОВЛ: Лесное семеноводство</ns12:name>
            </activityPlace>
            <woodBreedId>1301</woodBreedId>
            <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": "", "forestryPlantationType": {"id": "3", "name": "Культуры под пологом  леса (подпологовые)"}, "landCharacteristicEndDate": {"id": "1", "name": "Лесные насаждения"}, "landCharacteristicStartDate": {"id": "11", "name": "Пашни"}}</jsonData>
            <meta>
               <ns12:value>REL</ns12:value>
            </meta>
            <document id="P_3373261" documentType="contractReforestationReport"/>
         </ns2:plotFact>
      </ns2:ResponseInsertDocument>
   </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>76</com:cuttingPlotId>
             <!--Optional:-->
            <com:activity>
               <look:id>32</look:id>
               <!--Optional:-->
               <look:name>Искусственное лесовосстановление, посадка лесных культур с использованием улучшенного посадочного материала</look:name>
               <!--Optional:-->
               <look:code>380</look:code>
            </com:activity>
            <!--Optional:-->
            <com:activityPlace>
               <look:id>2</look:id>
               <!--Optional:-->
               <look:name>ОВЛ: Лесовосстановление и лесоразведение</look:name>
            </com:activityPlace>
            <!--Optional:-->
            <com:woodBreedId>1301</com:woodBreedId>
             <!--Optional:-->
            <com:forestPlantState>
               <look:id>1</look:id>
               <!--Optional:-->
               <look:name>Хорошие (процент приживаемости 81-100)</look:name>
            </com:forestPlantState>
            <!--Optional:-->
            <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": "7", "name": "Погибшие насаждения"},"landCharacteristicEndDate": {"id": "1", "name": "Лесные насаждения"},"infrastructureNumber":"","forestryPlantationType": {"id": "3", "name": "Культуры под пологом  леса (подпологовые)"},"maxUsedValue":0}</com:jsonData>
            <!--Optional:-->
            <com:meta>
               <look:value>REL</look:value>
            </com:meta>
            <!--Optional:-->
            <com:document id="P_3373261" documentType="contractReforestationReport"/>
         </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="380" createDate="2018-10-24T15:54:32.717+03:00" createdBy="логин пользователя, создавшего запись">
            <cuttingPlotId>76</cuttingPlotId>
            <activity>
               <ns12:id>32</ns12:id>
               <ns12:name>Искусственное лесовосстановление, посадка лесных культур с использованием улучшенного посадочного материала</ns12:name>
               <ns12:code>380</ns12:code>
            </activity>
            <activityPlace>
               <ns12:id>2</ns12:id>
               <ns12:name>ОВЛ: Лесовосстановление и лесоразведение</ns12:name>
            </activityPlace>
            <woodBreedId>1301</woodBreedId>
            <forestPlantState>
               <ns12:id>1</ns12:id>
               <ns12:name>Хорошие (процент приживаемости 81-100)</ns12:name>
            </forestPlantState>
            <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": "", "forestryPlantationType": {"id": "3", "name": "Культуры под пологом  леса (подпологовые)"}, "landCharacteristicEndDate": {"id": "1", "name": "Лесные насаждения"}, "landCharacteristicStartDate": {"id": "7", "name": "Погибшие насаждения"}}</jsonData>
            <meta>
               <ns12:value>REL</ns12:value>
            </meta>
            <document id="P_3373261" documentType="contractReforestationReport"/>
         </ns2:plotFact>
      </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:RequestGetDocument>
       <api:documentRef id="P_924144" 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 createDate="2018-10-23T19:03:55.406+03:00" updateDate="2018-10-23T19:03:55.406+03:00" sourceSystem="T" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись" updatedBySystem="T" id="P_924144" documentId="P_3373261" sourceKey="?">
            <ns9:reportType>contractReforestationReport</ns9:reportType>
            <ns9:contractNumber>25/2018</ns9:contractNumber>
            <ns9:status>draft</ns9:status>
            <ns9:receiptDate>2018-10-23T00:00:00.000+03:00</ns9:receiptDate>
            <ns9:clientCreateTime>2018-10-23T19:03:55.167+03:00
</ns9:clientCreateTime>
            <ns9:stateAuthorityId>22</ns9:stateAuthorityId>
            <ns9:partyId>1207175</ns9:partyId>
            <ns9:underlyingContractRef id="P_3204" documentType="contractRight"/>
            <ns9:woodlotElements/>
            <ns9:startDate>2018-10-23T00: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="contractReforestationReport" 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 createDate="2018-10-23T19:03:55.406+03:00" updateDate="2018-10-23T19:03:55.406+03:00" sourceSystem="T" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись" updatedBySystem="T" id="P_924144" documentId="P_3373261" sourceKey="?">
            <ns9:reportType>contractReforestationReport</ns9:reportType>
            <ns9:contractNumber>25/2018</ns9:contractNumber>
            <ns9:status>draft</ns9:status>
            <ns9:receiptDate>2018-10-21T00:00:00.000+03:00</ns9:receiptDate>
            <ns9:clientCreateTime>2018-10-23T19:03:55.167+03:00
</ns9:clientCreateTime>
            <ns9:stateAuthorityId>22</ns9:stateAuthorityId>
            <ns9:partyId>1207175</ns9:partyId>
            <ns9:underlyingContractRef id="P_3204" documentType="contractRight"/>
            <ns9:startDate>2018-10-21T00: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>

Выше