Changes for page Download a project (export)
Last modified by Robert Jan Daams on 2025/03/05 18:02
Change comment:
Renamed from xwiki:Implementatie dcoumentatie.Setting up a Webservice connection for project exports.WebHome
Summary
-
Page properties (3 modified, 0 added, 0 removed)
Details
- Page properties
-
- Parent
-
... ... @@ -1,1 +1,1 @@ 1 -Implementati ondocumentation.WebHome1 +Implementatie dcoumentatie.WebHome - Author
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki.R jDaams1 +XWiki.RoelofZwaan - Content
-
... ... @@ -16,26 +16,6 @@ 16 16 ((( 17 17 (% class="col-xs-12 col-sm-8" %) 18 18 ((( 19 -== Changelog == 20 - 21 -=== Update 2022-08-23 === 22 - 23 -As part of on-going efforts to improve performance and scalability, we have introduced a dedicated version of DataWS named DataWSExternals. This new service should be used for external API consumers. 24 - 25 -| |**URL**| 26 -|**Old**|{{code language="none"}}https://web.terraindex.com/DataWS/{{/code}}|((( 27 -[[https:~~/~~/web.terraindex.com/DataWS/ITWDataRestService_V1_0/GetProjectsJSON>>https://web.terraindex.com/DataWS/ITWDataRestService_V1_0/GetProjectsJSON]] 28 - 29 -[[https:~~/~~/web.terraindex.com/DataWS/ITWImportExportServiceASMX_V1_0.asmx>>https://web.terraindex.com/DataWSExternals/ITWImportExportServiceASMX_V1_0.asmx]] 30 -))) 31 -|**New**|{{code language="none"}}https://web.terraindex.com/DataWSExternals/{{/code}}|((( 32 -[[https:~~/~~/web.terraindex.com/DataWSExternals/ITWDataRestService_V1_0/GetProjectsJSON>>https://web.terraindex.com/DataWSExternals/ITWDataRestService_V1_0/GetProjectsJSON]] 33 - 34 -[[https:~~/~~/web.terraindex.com/DataWSExternals/ITWImportExportService_V1_0.svc>>https://web.terraindex.com/DataWSExternals/ITWImportExportService_V1_0.svc]] 35 -))) 36 - 37 -== == 38 - 39 39 == 1. Retreive all changed project from TerraIndex == 40 40 41 41 To retreive all changed project from the TerraIndex database since a specific timestamp, there is a webservice call you can do. This will return all project rows that have changes since the timestamp you send within the request. ... ... @@ -42,7 +42,7 @@ 42 42 This way you only download projects that have changes, and it will not request project that are not needed, so it won’t keep our servers busy with exports that are not necessary. 43 43 44 44 To start connecting this webservice, you should use this URL: 45 -[[https:~~/~~/web.terraindex.com/DataWS Externals/ITWDataRestService_V1_0/GetProjectsJSON>>https://web.terraindex.com/DataWSExternals/ITWDataRestService_V1_0/GetProjectsJSON]]25 +[[https:~~/~~/web.terraindex.com/DataWS/ITWDataRestService_V1_0/GetProjectsJSON>>url:https://web.terraindex.com/DataWS/ITWDataRestService_V1_0/GetProjectsJSON]] 46 46 47 47 Fill the **Body **of a **POST **HTTP call with: 48 48 ... ... @@ -56,7 +56,7 @@ 56 56 "Language": "en" 57 57 }, 58 58 "LanguageCode": "en", 59 - "WebserviceVersion": "1.0",39 + "WebserviceVersion": 1, 60 60 "SearchFilter": "", 61 61 "ArchiveID": 0, 62 62 "PageSize": 30, ... ... @@ -260,10 +260,9 @@ 260 260 To request the export from TerraIndex we have a SOAP webservice. This webservice is called the ExportService, and it will provide a full project in TerraIndex Format. 261 261 The format of the projectfile is documentated here: [[Documentation TerraIndex Export format - dsFieldProject.xsd>>Implementation documentation.Documentation TerraIndex Export format - dsFieldProject\.xsd.WebHome]] 262 262 263 -To start connecting this webservice, you should use this URL of the Import Export Webservice: 243 +To start connecting this webservice, you should use this URL of the Import Export Webservice: 244 +[[https:~~/~~/web.terraindex.com/DataWS/ITWImportExportServiceASMX_V1_0.asmx>>url:https://web.terraindex.com/DataWS/ITWImportExportServiceASMX_V1_0.asmx]] 264 264 265 -[[https:~~/~~/web.terraindex.com/DataWSExternals/ITWImportExportService_V1_0.svc>>https://web.terraindex.com/DataWSExternals/ITWImportExportService_V1_0.svc]] 266 - 267 267 With this URL many IDE’s can create a proxy for you, just by providing the URL. Once this proxy is created, you will have a few classes looking like the call in the image below. 268 268 269 269 [[image:image-20200108-123431.png]] ... ... @@ -277,15 +277,12 @@ 277 277 Also fill the license and the applicationCode. //(These two fields can be requested at the TerraIndex Servicedesk.)// 278 278 5; Fill the **ExportType **'**Export_FIELD_XML_v1_0_0**’. This export corresponds with dsFieldProject.xsd and is the best XML to connect TI with. 279 279 Create at least create 2 parameters as in the image. Beacause 2 parameters are needed. 280 -//If JSON is prevered use: ExportType = 'Export_FIELD_JSON_v1_0_0'// 281 281 6; Fill the parameter with the FileName. 282 282 7; Fill the parameter with **projectID**. Instead of ‘ProjectID' it’s also possible to fill the parameter ‘ProjectCode'. 283 283 8; Send the request and wait for the reponse. In response field ‘ResultCode’ should be 'SUCCES’ when it all went OK. If not it will tell what went wrong. 284 284 9; The response field 'Filecontent’is filled if it went OK, and it contains XML you can serialize. 285 -10; an extra parameter is added calles: **UseZipStream**. The result data is default Base64 encoded, if you add UseZipStream = true, the result string is GZIPSTREAMED Base64 encoded. **At the end of this page, we have added an class as code, to parse the base64 or ZIPStream Base64 to a normal string.** 286 -*Username and password are known by each TI user and the application manager of your company can create new usernames. 263 +\\*Username and password are known by each TI user and the application manager of your company can create new usernames. 287 287 288 - 289 289 **EXAMPLE CODE** 290 290 291 291 ExportType: ... ... @@ -331,7 +331,7 @@ 331 331 <soapenv:Envelope 332 332 xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 333 333 xmlns:itw="https://wsterraindex.terraindex.com/ITWorks.TerraIndex/"> 334 - <soapenv:Header ></soapenv:Header>310 + <soapenv:Header/> 335 335 <soapenv:Body> 336 336 <itw:Export> 337 337 <itw:request>