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

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

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

<soaping: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:cuttingPlot>
            <com:quarterNo>4</com:quarterNo>
            <com:tractId>G_6464</com:tractId>
            <com:subForestryId>G_U0106</com:subForestryId>
            <com:forestryId>G_00039</com:forestryId>
            <com:constituentEntityId>22</com:constituentEntityId>
            <com:metropolitanBoroughId>359</com:metropolitanBoroughId>
            <com:number>36</com:number>
            <com:area>2.8</com:area>
            <com:status>active</com:status>
         </api:cuttingPlot>
      </api:RequestInsertDocument>
   </soapenv:Body>
</soapenv:Envelope>

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

<soap:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен>
   <soap:Header>
      <ns4:EgaisResponseHeader техническая информация с атрибутами xmlns, определяющими пространства имен>
   </soap:Header>
   <soap:Body>
      <ns2:ResponseInsertDocument техническая информация с атрибутами xmlns, определяющими пространства имен>
	   <ns2:cuttingPlot id="1" createDate="2018-09-21T14:50:42.628+03:00" createdBy="логин пользователя, создавшего запись"> 
            <com:quarterNo>4</com:quarterNo>
            <com:tractId>G_6464</com:tractId>
            <com:subForestryId>G_U0106</com:subForestryId>
            <com:forestryId>G_00039</com:forestryId>
            <com:constituentEntityId>22</com:constituentEntityId>
            <com:metropolitanBoroughId>359</com:metropolitanBoroughId>
            <com:number>36</com:number>
            <com:area>2.8</com:area>
            <com:status>active</com:status>
         </ns2:cuttingPlot>
      </ns2:ResponseInsertDocument>
   </soapenv:Body>
</soapenv: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:cuttingPlot id="1" createDate=" 2018-09-27T17:23:19.415+03:00" updateDate=" 2018-09-27T17:23:19.415+03:00" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись">           <com:metropolitanBoroughId>359</com:metropolitanBoroughId>
            <com:area>8.7</com:area>
            <com:status>active</com:status>
         </api:cuttingPlot>
      </api:RequestUpdateDocument>
   </soapenv:Body>
</soapenv:Envelope>

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

Формирование ответа на редактирование значения параметра «Площадь»

<soap:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен>
   <soap:Header>
      <ns4:EgaisResponseHeader техническая информация с атрибутами xmlns, определяющими пространства имен>
   </soap:Header>
   <soap:Body>
      <ns2:ResponseUpdateDocument техническая информация с атрибутами xmlns, определяющими пространства имен>
          <ns2:cuttingPlot id="1" createDate=" 2018-09-27T17:23:19.415+03:00" updateDate=" 2018-09-27T17:23:19.415+03:00" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись">            
            <com:quarterNo>4</com:quarterNo>
            <com:tractId>G_6464</com:tractId>
            <com:subForestryId>G_U0106</com:subForestryId>
            <com:forestryId>G_00039</com:forestryId>
            <com:constituentEntityId>22</com:constituentEntityId>
            <com:metropolitanBoroughId>359</com:metropolitanBoroughId>
            <com:number>36</com:number>
            <com:area>8.7</com:area>
            <com:status>active</com:status>
         </ns2:cuttingPlot>
      </ns2:ResponseUpdateDocument>
   </soapenv:Body>
</soapenv: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="cuttingPlot"/>
      </api:RequestGetDocument>
   </soapenv:Body>
</soapenv:Envelope>

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

<soap:Envelope техническая информация с атрибутами xmlns, определяющими пространства имен>
   <soap:Header>
      <ns4:EgaisResponseHeader техническая информация с атрибутами xmlns, определяющими пространства имен>
   </soap:Header>
   <soap:Body>
      <ns2:ResponseGetDocument техническая информация с атрибутами xmlns, определяющими пространства имен>
          <ns2:cuttingPlot id="1" createDate=" 2018-09-27T17:23:19.415+03:00" updateDate=" 2018-09-27T17:23:19.415+03:00" createdBy="логин пользователя, создавшего запись" updatedBy="логин пользователя, изменившего запись">           
            <com:quarterNo>4</com:quarterNo>
            <com:tractId>G_6464</com:tractId>
            <com:subForestryId>G_U0106</com:subForestryId>
            <com:forestryId>G_00039</com:forestryId>
            <com:constituentEntityId>22</com:constituentEntityId>
            <com:metropolitanBoroughId>359</com:metropolitanBoroughId>
            <com:number>36</com:number>
            <com:area>8.7</com:area>
            <com:status>active</com:status>
         </ns2:cuttingPlot>
      </ns2:ResponseGetDocument>
   </soapenv:Body>
</soapenv: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="cuttingPlot" pageSize="1" pageNumber="0">
         <!--0 to 100 repetitions:-->
         <api:item>
            <fil:property>constituentEntityId</fil:property>
            <!--1 or more repetitions:-->
            <fil:value>22</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:cuttingPlot id="1" createDate="2018-09-27T17:23:19.415+03:00" createdBy="логин пользователя, создавшего запись">           
            <quarterNo>4</quarterNo>
            <tractId>G_6464</tractId>
            <subForestryId>G_U0106</subForestryId>
            <forestryId>G_00039</forestryId>
            <constituentEntityId>22</constituentEntityId>
            <metropolitanBoroughId>359</metropolitanBoroughId>
            <number>36</number>
            <area>2.8000</area>
            <status>active</status>
         </ns2:cuttingPlot>
      </ns2:ResponseGetDocumentsByFilter>
   </soap:Body>
</soap:Envelope>

Выше