Changes for page Download a project (export)

Last modified by Nico Lemaire on 2025/09/01 13:36

From version 3.1

edited by Roelof Zwaan
on 2021/11/23 11:40

Change comment: Renamed from xwiki:Implementatie dcoumentatie.Setting up a Webservice connection for project exports.WebHome

To version 15.6

edited by Nico Lemaire
on 2025/09/01 13:36

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (4 modified, 0 added, 0 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--Setting up a Webservice connection for project exports
++Download a project (export)

Parent

@@ -1,1 +1,1 @@
--Implementatie dcoumentatie.WebHome
++Implementation documentation.For customers.WebHome

Author

@@ -1,1 +1,1 @@
--XWiki.RoelofZwaan
++XWiki.NicoLemaire

Content

@@ -16,6 +16,36 @@
  (((
  (% class="col-xs-12 col-sm-8" %)
  (((
++== Changelog ==
++
++=== Update 2022-08-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.
++
++| |**URL**|
++|**Old**|{{code language="none"}}https://web.terraindex.com/DataWS/{{/code}}|(((
++[[https:~~/~~/web.terraindex.com/DataWS/ITWDataRestService_V1_0/GetProjectsJSON>>https://web.terraindex.com/DataWS/ITWDataRestService_V1_0/GetProjectsJSON]]
++
++[[https:~~/~~/web.terraindex.com/DataWS/ITWImportExportServiceASMX_V1_0.asmx>>https://web.terraindex.com/DataWSExternals/ITWImportExportServiceASMX_V1_0.asmx]]
++)))
++|**New**|{{code language="none"}}https://web.terraindex.com/DataWSExternals/{{/code}}|(((
++[[https:~~/~~/web.terraindex.com/DataWSExternals/ITWDataRestService_V1_0/GetProjectsJSON>>https://web.terraindex.com/DataWSExternals/ITWDataRestService_V1_0/GetProjectsJSON]]
++
++[[https:~~/~~/web.terraindex.com/DataWSExternals/ITWImportExportServiceASMX_V1_0.asmx>>https://web.terraindex.com/DataWSExternals/ITWImportExportServiceASMX_V1_0.asmx?wsdl]]
++)))
++
++==  ==
++
++{{info}}
++We also have new REST Calls, with the same Input Output formats:
++\\[[https:~~/~~/web.terraindex.com/datawsExternals/ITWImportExportRestService_V1_0/export>>https://web.terraindex.com/datawsExternals/ITWImportExportRestService_V1_0/export]]
++
++input as json: ExportRequest
++output as json: ExportResult
++
++as  POST  or   GET
++{{/info}}
++
  == 1. Retreive all changed project from TerraIndex ==
  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.
@@ -22,7 +22,7 @@
  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.
  To start connecting this webservice, you should use this URL:
--[[https:~~/~~/web.terraindex.com/DataWS/ITWDataRestService_V1_0/GetProjectsJSON>>url:https://web.terraindex.com/DataWS/ITWDataRestService_V1_0/GetProjectsJSON]]
++[[https:~~/~~/web.terraindex.com/DataWSExternals/ITWDataRestService_V1_0/GetProjectsJSON>>https://web.terraindex.com/DataWSExternals/ITWDataRestService_V1_0/GetProjectsJSON]]
  Fill the **Body **of a **POST **HTTP call with:
@@ -36,7 +36,7 @@
      "Language": "en"
    },
    "LanguageCode": "en",
--  "WebserviceVersion": 1,
++  "WebserviceVersion": "1.0",
    "SearchFilter": "",
    "ArchiveID": 0,
    "PageSize": 30,
@@ -238,11 +238,12 @@
  == 2. Retreive the project export from TerraIndex ==
  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.
--The format of the projectfile is documentated here: [[Documentation TerraIndex Export format - dsFieldProject.xsd>>Implementation documentation.Documentation TerraIndex Export format - dsFieldProject\.xsd.WebHome]]
++The format of the projectfile is documentated here: [[Documentation TerraIndex Export format - dsFieldProject.xsd>>Implementation documentation.For customers.Documentation TerraIndex Export format - dsFieldProject\.xsd.WebHome]]
--To start connecting this webservice, you should use this URL of the Import Export Webservice:
--[[https:~~/~~/web.terraindex.com/DataWS/ITWImportExportServiceASMX_V1_0.asmx>>url:https://web.terraindex.com/DataWS/ITWImportExportServiceASMX_V1_0.asmx]]
++To start connecting this webservice, you should use this URL of the Import Export Webservice:
++[[https:~~/~~/web.terraindex.com/DataWSExternals/ITWImportExportService_V1_0.svc>>https://web.terraindex.com/DataWSExternals/ITWImportExportService_V1_0.svc]]
++
  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.
  [[image:image-20200108-123431.png]]
@@ -256,12 +256,16 @@
  Also fill the license and the applicationCode. //(These two fields can be requested at the TerraIndex Servicedesk.)//
 ; Fill the **ExportType **'**Export_FIELD_XML_v1_0_0**’. This export corresponds with dsFieldProject.xsd and is the best XML to connect TI with.
  Create at least create 2 parameters as in the image. Beacause 2 parameters are needed.
++//If JSON is prevered use: ExportType = 'Export_FIELD_JSON_v1_0_0'
++For other export types, see the end of this page//
 ; Fill the parameter with the FileName.
 ; Fill the parameter with **projectID**. Instead of ‘ProjectID' it’s also possible to fill the parameter ‘ProjectCode'.
 ; 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.
 ; The response field 'Filecontent’is filled if it went OK, and it contains XML you can serialize.
--\\*Username and password are known by each TI user and the application manager of your company can create new usernames.
++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.**
++*Username and password are known by each TI user and the application manager of your company can create new usernames.
++
  **EXAMPLE CODE**
  ExportType:
@@ -307,7 +307,7 @@
  <soapenv:Envelope
   xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
   xmlns:itw="https://wsterraindex.terraindex.com/ITWorks.TerraIndex/">
-- <soapenv:Header/>
++ <soapenv:Header></soapenv:Header>
   <soapenv:Body>
    <itw:Export>
     <itw:request>
@@ -375,139 +375,31 @@
  {{/code}}
--== Zip Stream class ==
++**List of export types:**
--If needed, this is the Zip Stream class you can use to extract the zipstream as used above:
--
--{{code language="Csharp" layout="LINENUMBERS"}}
--/// <summary>
--/// Helper class for compress en decompress of file data
--/// </summary>
--public static class ZipStreamHelper {
--  #region Compress and encode
--  /// <summary>
--  /// Comprimeer een string en geeft deze terug in Base64 string.
--  /// </summary>
--  /// <param name="content">filecontent</param>
--  /// <returns>gecomprimeerde string</returns>
--  public static string CompressToBase64String(string content) {
--    //string to byte[]
--    byte[] contentArray = stringToByteArray(content);
--    // Compress
--    byte[] compressed = Compress(contentArray);
--    return base64_encode(compressed);
--  }
--
--  /// <summary>
--  /// Zet een string om naar een ByteArray
--  /// </summary>
--  /// <param name="content">filecontent</param>
--  /// <returns>ByteArray</returns>
--  public static byte[] stringToByteArray(string content) {
--    System.Text.UTF8Encoding encoding = new System.Text.UTF8Encoding();
--    return encoding.GetBytes(content);
--  }
--
--  /// <summary>
--  /// comprimeer een ByteArray
--  /// </summary>
--  /// <param name="data">filedata als ByteArray</param>
--  /// <returns>gecomprimeerde ByteArray</returns>
--  public static byte[] Compress(byte[] data) {
--    using(var compressedStream = new MemoryStream())
--    using(var zipStream = new GZipStream(compressedStream, CompressionMode.Compress)) {
--      zipStream.Write(data, 0, data.Length);
--      zipStream.Close();
--      return compressedStream.ToArray();
--    }
--  }
--
--  /// <summary>
--  /// Zet een ByteArray om naar een Base64 string
--  /// </summary>
--  /// <param name="data">gecomprimeerde ByteArray</param>
--  /// <returns>Base 64 string</returns>
--  public static string base64_encode(byte[] data) {
--    if (data == null)
--      return string.Empty;
--    return Convert.ToBase64String(data);
--  }
--
--  /// <summary>
--  /// Zet een string om naar een Base64 string
--  /// </summary>
--  /// <param name="data">string</param>
--  /// <returns>Base 64 string</returns>
--  public static string string_base64_encode(string data) {
--    if (string.IsNullOrEmpty(data))
--      return string.Empty;
--
--    //string to byte[]
--    byte[] contentArray = stringToByteArray(data);
--    return base64_encode(contentArray);
--  }
--  #endregion
--
--  #region Decompress and decode
--  // Decode and decompress
--  /// <summary>
--  /// Decomprimeer een Base64 string naar een string
--  /// </summary>
--  /// <param name="contentBase64">GZIP Base64 string</param>
--  /// <returns>string</returns>
--  public static string DecompressBase64StringToString(string contentBase64) {
--    // Decompress
--    byte[] decoded = base64_decode(contentBase64);
--    byte[] decompressed = Decompress(decoded);
--
--    return byteArrayTostring(decompressed);
--  }
--
--  /// <summary>
--  /// Zet een ByteArray om in een normale string
--  /// </summary>
--  /// <param name="data">ByteArray</param>
--  /// <returns>string</returns>
--  public static string byteArrayTostring(byte[] data) {
--    System.Text.UTF8Encoding enc = new System.Text.UTF8Encoding();
--    return enc.GetString(data);
--  }
--
--  /// <summary>
--  /// Zet een Base64 string om naar een ByteArray
--  /// </summary>
--  /// <param name="encodedData">Base64 string</param>
--  /// <returns>gecomprimeerde ByteArray</returns>
--  public static byte[] base64_decode(string encodedData) {
--    byte[] encodedDataAsBytes = Convert.FromBase64String(encodedData);
--    return encodedDataAsBytes;
--  }
--
--  /// <summary>
--  /// Zet een gecomprimeerde ByteArray om in een ByteArray
--  /// </summary>
--  /// <param name="data">gecomprimeerde ByteArray</param>
--  /// <returns>ByteArray (gedecomprimeerd)</returns>
--  public static byte[] Decompress(byte[] data) {
--    using(var compressedStream = new MemoryStream(data))
--    using(var zipStream = new GZipStream(compressedStream, CompressionMode.Decompress))
--    using(var resultStream = new MemoryStream()) {
--      var buffer = new byte[4096];
--      int read;
--
--      while ((read = zipStream.Read(buffer, 0, buffer.Length)) > 0) {
--        resultStream.Write(buffer, 0, read);
--      }
--
--      return resultStream.ToArray();
--    }
--  }
--  #endregion
--}
--{{/code}}
++* Export_TI_v1_0_0
++* Export_FIELD_XML_v1_0_0
++* Export_FIELD_JSON_v1_0_0
++* Export_Field_Codelist_XML
++* Export_Field_Codelist_JSON
++* Export_OVAM_MISTRAL2_v8_4_0
++* Export_DOV
++* Export_IMSIKB_v14_3_0
++* Export_IMSIKB_v13_5_0
++* Export_BRO_GMW
++* Export_BRO_BHR_GT
++* Export_BRO_GAR
++* Export_IMSIKB_v14_7_0
++* Export_IMSIKB_v14_8_0
++* Export_BRO_SAD_IMBROA_Registration
++* Export_BRO_SAD_IMBROA_Correction
++* Export_BRO_SAD_IMBRO_Registration
++* Export_BRO_SAD_IMBRO_Correction
++* Export_IMSIKB_v14_9_0
  )))
++
  (% class="col-xs-12 col-sm-4" %)
  (((