Changes for page Download a project (export)

Last modified by Robert Jan Daams on 2025/03/05 18:02

From version < 1.2 >

edited by Roelof Zwaan
on 2021/11/22 10:41

To version < 6.2 >

edited by Robert Jan Daams
on 2022/08/23 11:14

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Parent

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

Author

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

Content

@@ -8,10 +8,27 @@
  )))
  )))
++{{box title="**Contents**"}}
++[[image:data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==||height="15" role="presentation" title="Click and drag to move" width="15"]]
++{{/box}}
++
  (% class="row" %)
  (((
  (% 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/ITWImportExportServiceASMX_V1_0.asmx?wsdl>>https://web.terraindex.com/DataWS/ITWImportExportServiceASMX_V1_0.asmx?wsdl]]
++|**New**|{{code language="none"}}https://web.terraindex.com/DataWSExternals/{{/code}}|[[https:~~/~~/web.terraindex.com/DataWSExternals/ITWImportExportServiceASMX_V1_0.asmx?wsdl>>https://web.terraindex.com/DataWSExternals/ITWImportExportServiceASMX_V1_0.asmx?wsdl]]
++
++(% class="wikigeneratedid" %)
++==  ==
++
  == 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.
@@ -32,7 +32,7 @@
      "Language": "en"
    },
    "LanguageCode": "en",
--  "WebserviceVersion": 1,
++  "WebserviceVersion": "1.0",
    "SearchFilter": "",
    "ArchiveID": 0,
    "PageSize": 30,
@@ -234,7 +234,7 @@
  == 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>>Implementatie dcoumentatie.Documentation TerraIndex Export format - dsFieldProject\.xsd.WebHome]]
++The format of the projectfile is documentated here: [[Documentation TerraIndex Export format - dsFieldProject.xsd>>Implementation documentation.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]]
@@ -252,12 +252,15 @@
  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'//
 ; 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:
@@ -299,11 +299,76 @@
  Example call
--<soapenv:Envelope xmlns:soapenv="http:~/~/schemas.xmlsoap.org/soap/envelope/" xmlns:itw="https:~/~/wsterraindex.terraindex.com/ITWorks.TerraIndex/"> <soapenv:Header/> <soapenv:Body> <itw:Export> <itw:request> <itw:AuthorisationRequest> <itw:Username>USERNAME</itw:Username> <itw:Password>PASSWORD</itw:Password> <itw:Licensenumber>LICENSE</itw:Licensenumber> <itw:ApplicationCode>APPCODE</itw:ApplicationCode> </itw:AuthorisationRequest> <itw:WebserviceVersion>1.0</itw:WebserviceVersion> <itw:LanguageCode>nld</itw:LanguageCode> <itw:UseCompression>true</itw:UseCompression> <itw:TypeOfExport>Export_FIELD_XML_v1_0_0</itw:TypeOfExport> <itw:Parameters> <itw:ExportParameter> <itw:ParameterType>FileName</itw:ParameterType> <itw:StringValue>Export</itw:StringValue> </itw:ExportParameter> <itw:ExportParameter> <itw:ParameterType>projectID</itw:ParameterType> <itw:FloatValue>917</itw:FloatValue> </itw:ExportParameter> ~-~-~-~-- <itw:ExportParameter> <itw:ParameterType>ProjectCode</itw:ParameterType> <itw:StringValue>202020</itw:StringValue> </itw:ExportParameter> ~-~-~-~- </itw:Parameters> <itw:LogFormat>XML</itw:LogFormat> <itw:UseZipStream>true</itw:UseZipStream> </itw:request> </itw:Export> </soapenv:Body></soapenv:Envelope>
++{{code language="none" layout="LINENUMBERS"}}
++<soapenv:Envelope
++ xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
++ xmlns:itw="https://wsterraindex.terraindex.com/ITWorks.TerraIndex/">
++ <soapenv:Header></soapenv:Header>
++ <soapenv:Body>
++  <itw:Export>
++   <itw:request>
++    <itw:AuthorisationRequest>
++     <itw:Username>USERNAME</itw:Username>
++     <itw:Password>PASSWORD</itw:Password>
++     <itw:Licensenumber>LICENSE</itw:Licensenumber>
++     <itw:ApplicationCode>APPCODE</itw:ApplicationCode>
++    </itw:AuthorisationRequest>
++    <itw:WebserviceVersion>1.0</itw:WebserviceVersion>
++    <itw:LanguageCode>nld</itw:LanguageCode>
++    <itw:UseCompression>true</itw:UseCompression>
++    <itw:TypeOfExport>Export_FIELD_XML_v1_0_0</itw:TypeOfExport>
++    <itw:Parameters>
++     <itw:ExportParameter>
++      <itw:ParameterType>FileName</itw:ParameterType>
++      <itw:StringValue>Export</itw:StringValue>
++     </itw:ExportParameter>
++     <itw:ExportParameter>
++      <itw:ParameterType>projectID</itw:ParameterType>
++      <itw:FloatValue>917</itw:FloatValue>
++     </itw:ExportParameter> -----
++     <itw:ExportParameter>
++      <itw:ParameterType>ProjectCode</itw:ParameterType>
++      <itw:StringValue>202020</itw:StringValue>
++     </itw:ExportParameter> ----
++    </itw:Parameters>
++    <itw:LogFormat>XML</itw:LogFormat>
++    <itw:UseZipStream>true</itw:UseZipStream>
++   </itw:request>
++  </itw:Export>
++ </soapenv:Body>
++</soapenv:Envelope>
++{{/code}}
  Example response:
--<soap:Envelope xmlns:soap="http:~/~/schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http:~/~/www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http:~/~/www.w3.org/2001/XMLSchema"> <soap:Body> <ExportResponse xmlns="https:~/~/wsterraindex.terraindex.com/ITWorks.TerraIndex/"> <ExportResult> <ResultCode>Export_Succes</ResultCode> <TypeOfExport>Export_TI_v1_0_0</TypeOfExport> <Files> <File> <FileName>917.xml</FileName> <TypeOfFile>Field_XML_Compressed</TypeOfFile> <FileContent>H4sIAAAAAAAEAFWRuZaqQABEP4hAGnAGggm6odlREFkkA2WRRRCBxv76YeYF70yFVXUqqBvgl4KQBzcZ8Aho2iqxdhxDSPDmNGjz9Z/weMa8/aimTAUeF42KgxRRzd3YaGfdXtvECEBvWafSNwf+dOsjVXpZUzs+lw/p3gBhuXQ5S8T3MdIBlxUQEam+LOVgVo4D8w4c2E8pEgp3haewcpQx1KQ41Z8DKWv16seaDLp3GABLuIKXK5Ucq31EfSXm0172YvG87hcbayYGdB1t0CbcuueLpU5UawgHSitFr564Aet5LeegD0/tocZDTvuIuc9Ja0tDFt/m7kZnomdVJc+2SkqBGXmTdPiiPzJa2OznLkX67p2PCNM7iHU11QbIilVkMDBVd0J8gK4Ams6ycJQagnww/SaxuiZ/EdS6DZ0cf17BIhUq87CSkQvxat/2dEG1xu94BoaeT7C8XR38/C1DZbpygwfW+gk8Z+Mgm3DDhAj8r6099Rj+5YNs5F3+5R5EUPmd6+EvYvj1Dd8o9lLwAQAA</FileContent> </File> <File> <FileName>ProjectInfo.xml</FileName> <TypeOfFile>Field_XML_Compressed</TypeOfFile> <FileContent>H4sIAAAAAAAEAI1Qy5JDQAD8IAdj1/M4hJggDBnEbTxDsV7BxtdvNqm9bx+6urq7+tBEnw+qiuETCLrcTlst9Pajtb0soj7JeynztNIubHK9XZJOXoojN8dXpaxltOlOwAZzK033Edx7HWT1ZFVYNljpsT7iCVDbxb5tlmw3GhV7vgty5jqiGzWSYEvL7RCIQifzchIoMJnHz+fO17C4JAwA0hNRb247SR1ba8OunCV4ralK1rjwBhUAJ2pihopeuxqXIUecePETLhx8zT6IZX5GzafC0XHTrauISeyIM2+2g1PzEymRZrTtglKlsFYHXDKmoYTp+jw1zNDyAFZOTN9XHkuNGmU33905uipWMTsjm2ccm6+bxqk2xAjCf/z3BwS1j+qVqTjrlDGJziCIhC59CHwafeNgI8d3U4cQQ+VXSdXb+QGLuAuvrAEAAA==</FileContent> </File> </Files> </ExportResult> </ExportResponse> </soap:Body></soap:Envelope>
++{{code language="none"}}
++<soap:Envelope
++ xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
++ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
++ xmlns:xsd="http://www.w3.org/2001/XMLSchema">
++ <soap:Body>
++  <ExportResponse
++   xmlns="https://wsterraindex.terraindex.com/ITWorks.TerraIndex/">
++   <ExportResult>
++    <ResultCode>Export_Succes</ResultCode>
++    <TypeOfExport>Export_TI_v1_0_0</TypeOfExport>
++    <Files>
++     <File>
++      <FileName>917.xml</FileName>
++      <TypeOfFile>Field_XML_Compressed</TypeOfFile>
++      <FileContent>H4sIAAAAAAAEAFWRuZaqQABEP4hAGnAGggm6odlREFkkA2WRRRCBxv76YeYF70yFVXUqqBvgl4KQBzcZ8Aho2iqxdhxDSPDmNGjz9Z/weMa8/aimTAUeF42KgxRRzd3YaGfdXtvECEBvWafSNwf+dOsjVXpZUzs+lw/p3gBhuXQ5S8T3MdIBlxUQEam+LOVgVo4D8w4c2E8pEgp3haewcpQx1KQ41Z8DKWv16seaDLp3GABLuIKXK5Ucq31EfSXm0172YvG87hcbayYGdB1t0CbcuueLpU5UawgHSitFr564Aet5LeegD0/tocZDTvuIuc9Ja0tDFt/m7kZnomdVJc+2SkqBGXmTdPiiPzJa2OznLkX67p2PCNM7iHU11QbIilVkMDBVd0J8gK4Ams6ycJQagnww/SaxuiZ/EdS6DZ0cf17BIhUq87CSkQvxat/2dEG1xu94BoaeT7C8XR38/C1DZbpygwfW+gk8Z+Mgm3DDhAj8r6099Rj+5YNs5F3+5R5EUPmd6+EvYvj1Dd8o9lLwAQAA</FileContent>
++     </File>
++     <File>
++      <FileName>ProjectInfo.xml</FileName>
++      <TypeOfFile>Field_XML_Compressed</TypeOfFile>
++      <FileContent>H4sIAAAAAAAEAI1Qy5JDQAD8IAdj1/M4hJggDBnEbTxDsV7BxtdvNqm9bx+6urq7+tBEnw+qiuETCLrcTlst9Pajtb0soj7JeynztNIubHK9XZJOXoojN8dXpaxltOlOwAZzK033Edx7HWT1ZFVYNljpsT7iCVDbxb5tlmw3GhV7vgty5jqiGzWSYEvL7RCIQifzchIoMJnHz+fO17C4JAwA0hNRb247SR1ba8OunCV4ralK1rjwBhUAJ2pihopeuxqXIUecePETLhx8zT6IZX5GzafC0XHTrauISeyIM2+2g1PzEymRZrTtglKlsFYHXDKmoYTp+jw1zNDyAFZOTN9XHkuNGmU33905uipWMTsjm2ccm6+bxqk2xAjCf/z3BwS1j+qVqTjrlDGJziCIhC59CHwafeNgI8d3U4cQQ+VXSdXb+QGLuAuvrAEAAA==</FileContent>
++     </File>
++    </Files>
++   </ExportResult>
++  </ExportResponse>
++ </soap:Body>
++</soap:Envelope>
++{{/code}}
  == Zip Stream class ==
@@ -310,16 +310,137 @@
  If needed, this is the Zip Stream class you can use to extract the zipstream as used above:
--~/~// <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 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}}
  )))
  (% class="col-xs-12 col-sm-4" %)
  (((
--{{box title="**Contents**"}}
--{{toc/}}
--{{/box}}
--
  )))
  )))

Changes for page Download a project (export)

Summary

Details

Navigation