Changes for page Download a project (export)
Last modified by Robert Jan Daams on 2025/03/05 18:02
Change comment:
There is no comment for this version
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.Ro binHuisman1 +XWiki.RoelofZwaan - Content
-
... ... @@ -8,10 +8,6 @@ 8 8 ))) 9 9 ))) 10 10 11 -{{box title="**Contents**"}} 12 -[[image:data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==||height="15" role="presentation" title="Click and drag to move" width="15"]] 13 -{{/box}} 14 - 15 15 (% class="row" %) 16 16 ((( 17 17 (% class="col-xs-12 col-sm-8" %) ... ... @@ -36,7 +36,7 @@ 36 36 "Language": "en" 37 37 }, 38 38 "LanguageCode": "en", 39 - "WebserviceVersion": "1.0",35 + "WebserviceVersion": 1, 40 40 "SearchFilter": "", 41 41 "ArchiveID": 0, 42 42 "PageSize": 30, ... ... @@ -238,7 +238,7 @@ 238 238 == 2. Retreive the project export from TerraIndex == 239 239 240 240 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. 241 -The format of the projectfile is documentated here: [[Documentation TerraIndex Export format - dsFieldProject.xsd>>Implementati ondocumentation.Documentation TerraIndex Export format - dsFieldProject\.xsd.WebHome]]237 +The format of the projectfile is documentated here: [[Documentation TerraIndex Export format - dsFieldProject.xsd>>Implementatie dcoumentatie.Documentation TerraIndex Export format - dsFieldProject\.xsd.WebHome]] 242 242 243 243 To start connecting this webservice, you should use this URL of the Import Export Webservice: 244 244 [[https:~~/~~/web.terraindex.com/DataWS/ITWImportExportServiceASMX_V1_0.asmx>>url:https://web.terraindex.com/DataWS/ITWImportExportServiceASMX_V1_0.asmx]] ... ... @@ -260,10 +260,8 @@ 260 260 7; Fill the parameter with **projectID**. Instead of ‘ProjectID' it’s also possible to fill the parameter ‘ProjectCode'. 261 261 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. 262 262 9; The response field 'Filecontent’is filled if it went OK, and it contains XML you can serialize. 263 -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.** 264 -*Username and password are known by each TI user and the application manager of your company can create new usernames. 259 +\\*Username and password are known by each TI user and the application manager of your company can create new usernames. 265 265 266 - 267 267 **EXAMPLE CODE** 268 268 269 269 ExportType: ... ... @@ -305,76 +305,11 @@ 305 305 306 306 Example call 307 307 308 -{{code language="none" layout="LINENUMBERS"}} 309 -<soapenv:Envelope 310 - xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 311 - xmlns:itw="https://wsterraindex.terraindex.com/ITWorks.TerraIndex/"> 312 - <soapenv:Header></soapenv:Header> 313 - <soapenv:Body> 314 - <itw:Export> 315 - <itw:request> 316 - <itw:AuthorisationRequest> 317 - <itw:Username>USERNAME</itw:Username> 318 - <itw:Password>PASSWORD</itw:Password> 319 - <itw:Licensenumber>LICENSE</itw:Licensenumber> 320 - <itw:ApplicationCode>APPCODE</itw:ApplicationCode> 321 - </itw:AuthorisationRequest> 322 - <itw:WebserviceVersion>1.0</itw:WebserviceVersion> 323 - <itw:LanguageCode>nld</itw:LanguageCode> 324 - <itw:UseCompression>true</itw:UseCompression> 325 - <itw:TypeOfExport>Export_FIELD_XML_v1_0_0</itw:TypeOfExport> 326 - <itw:Parameters> 327 - <itw:ExportParameter> 328 - <itw:ParameterType>FileName</itw:ParameterType> 329 - <itw:StringValue>Export</itw:StringValue> 330 - </itw:ExportParameter> 331 - <itw:ExportParameter> 332 - <itw:ParameterType>projectID</itw:ParameterType> 333 - <itw:FloatValue>917</itw:FloatValue> 334 - </itw:ExportParameter> ----- 335 - <itw:ExportParameter> 336 - <itw:ParameterType>ProjectCode</itw:ParameterType> 337 - <itw:StringValue>202020</itw:StringValue> 338 - </itw:ExportParameter> ---- 339 - </itw:Parameters> 340 - <itw:LogFormat>XML</itw:LogFormat> 341 - <itw:UseZipStream>true</itw:UseZipStream> 342 - </itw:request> 343 - </itw:Export> 344 - </soapenv:Body> 345 -</soapenv:Envelope> 346 -{{/code}} 302 +<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> 347 347 348 348 Example response: 349 349 350 -{{code language="none"}} 351 -<soap:Envelope 352 - xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" 353 - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 354 - xmlns:xsd="http://www.w3.org/2001/XMLSchema"> 355 - <soap:Body> 356 - <ExportResponse 357 - xmlns="https://wsterraindex.terraindex.com/ITWorks.TerraIndex/"> 358 - <ExportResult> 359 - <ResultCode>Export_Succes</ResultCode> 360 - <TypeOfExport>Export_TI_v1_0_0</TypeOfExport> 361 - <Files> 362 - <File> 363 - <FileName>917.xml</FileName> 364 - <TypeOfFile>Field_XML_Compressed</TypeOfFile> 365 - <FileContent>H4sIAAAAAAAEAFWRuZaqQABEP4hAGnAGggm6odlREFkkA2WRRRCBxv76YeYF70yFVXUqqBvgl4KQBzcZ8Aho2iqxdhxDSPDmNGjz9Z/weMa8/aimTAUeF42KgxRRzd3YaGfdXtvECEBvWafSNwf+dOsjVXpZUzs+lw/p3gBhuXQ5S8T3MdIBlxUQEam+LOVgVo4D8w4c2E8pEgp3haewcpQx1KQ41Z8DKWv16seaDLp3GABLuIKXK5Ucq31EfSXm0172YvG87hcbayYGdB1t0CbcuueLpU5UawgHSitFr564Aet5LeegD0/tocZDTvuIuc9Ja0tDFt/m7kZnomdVJc+2SkqBGXmTdPiiPzJa2OznLkX67p2PCNM7iHU11QbIilVkMDBVd0J8gK4Ams6ycJQagnww/SaxuiZ/EdS6DZ0cf17BIhUq87CSkQvxat/2dEG1xu94BoaeT7C8XR38/C1DZbpygwfW+gk8Z+Mgm3DDhAj8r6099Rj+5YNs5F3+5R5EUPmd6+EvYvj1Dd8o9lLwAQAA</FileContent> 366 - </File> 367 - <File> 368 - <FileName>ProjectInfo.xml</FileName> 369 - <TypeOfFile>Field_XML_Compressed</TypeOfFile> 370 - <FileContent>H4sIAAAAAAAEAI1Qy5JDQAD8IAdj1/M4hJggDBnEbTxDsV7BxtdvNqm9bx+6urq7+tBEnw+qiuETCLrcTlst9Pajtb0soj7JeynztNIubHK9XZJOXoojN8dXpaxltOlOwAZzK033Edx7HWT1ZFVYNljpsT7iCVDbxb5tlmw3GhV7vgty5jqiGzWSYEvL7RCIQifzchIoMJnHz+fO17C4JAwA0hNRb247SR1ba8OunCV4ralK1rjwBhUAJ2pihopeuxqXIUecePETLhx8zT6IZX5GzafC0XHTrauISeyIM2+2g1PzEymRZrTtglKlsFYHXDKmoYTp+jw1zNDyAFZOTN9XHkuNGmU33905uipWMTsjm2ccm6+bxqk2xAjCf/z3BwS1j+qVqTjrlDGJziCIhC59CHwafeNgI8d3U4cQQ+VXSdXb+QGLuAuvrAEAAA==</FileContent> 371 - </File> 372 - </Files> 373 - </ExportResult> 374 - </ExportResponse> 375 - </soap:Body> 376 -</soap:Envelope> 377 -{{/code}} 306 +<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> 378 378 379 379 380 380 == Zip Stream class == ... ... @@ -381,137 +381,16 @@ 381 381 382 382 If needed, this is the Zip Stream class you can use to extract the zipstream as used above: 383 383 384 -{{code language="Csharp" layout="LINENUMBERS"}} 385 -/// <summary> 386 -/// Helper class for compress en decompress of file data 387 -/// </summary> 388 -public static class ZipStreamHelper { 389 - #region Compress and encode 390 - /// <summary> 391 - /// Comprimeer een string en geeft deze terug in Base64 string. 392 - /// </summary> 393 - /// <param name="content">filecontent</param> 394 - /// <returns>gecomprimeerde string</returns> 395 - public static string CompressToBase64String(string content) { 396 - //string to byte[] 397 - byte[] contentArray = stringToByteArray(content); 398 - // Compress 399 - byte[] compressed = Compress(contentArray); 400 - return base64_encode(compressed); 401 - } 402 - 403 - /// <summary> 404 - /// Zet een string om naar een ByteArray 405 - /// </summary> 406 - /// <param name="content">filecontent</param> 407 - /// <returns>ByteArray</returns> 408 - public static byte[] stringToByteArray(string content) { 409 - System.Text.UTF8Encoding encoding = new System.Text.UTF8Encoding(); 410 - return encoding.GetBytes(content); 411 - } 412 - 413 - /// <summary> 414 - /// comprimeer een ByteArray 415 - /// </summary> 416 - /// <param name="data">filedata als ByteArray</param> 417 - /// <returns>gecomprimeerde ByteArray</returns> 418 - public static byte[] Compress(byte[] data) { 419 - using(var compressedStream = new MemoryStream()) 420 - using(var zipStream = new GZipStream(compressedStream, CompressionMode.Compress)) { 421 - zipStream.Write(data, 0, data.Length); 422 - zipStream.Close(); 423 - return compressedStream.ToArray(); 424 - } 425 - } 426 - 427 - /// <summary> 428 - /// Zet een ByteArray om naar een Base64 string 429 - /// </summary> 430 - /// <param name="data">gecomprimeerde ByteArray</param> 431 - /// <returns>Base 64 string</returns> 432 - public static string base64_encode(byte[] data) { 433 - if (data == null) 434 - return string.Empty; 435 - return Convert.ToBase64String(data); 436 - } 437 - 438 - /// <summary> 439 - /// Zet een string om naar een Base64 string 440 - /// </summary> 441 - /// <param name="data">string</param> 442 - /// <returns>Base 64 string</returns> 443 - public static string string_base64_encode(string data) { 444 - if (string.IsNullOrEmpty(data)) 445 - return string.Empty; 446 - 447 - //string to byte[] 448 - byte[] contentArray = stringToByteArray(data); 449 - return base64_encode(contentArray); 450 - } 451 - #endregion 452 - 453 - #region Decompress and decode 454 - // Decode and decompress 455 - /// <summary> 456 - /// Decomprimeer een Base64 string naar een string 457 - /// </summary> 458 - /// <param name="contentBase64">GZIP Base64 string</param> 459 - /// <returns>string</returns> 460 - public static string DecompressBase64StringToString(string contentBase64) { 461 - // Decompress 462 - byte[] decoded = base64_decode(contentBase64); 463 - byte[] decompressed = Decompress(decoded); 464 - 465 - return byteArrayTostring(decompressed); 466 - } 467 - 468 - /// <summary> 469 - /// Zet een ByteArray om in een normale string 470 - /// </summary> 471 - /// <param name="data">ByteArray</param> 472 - /// <returns>string</returns> 473 - public static string byteArrayTostring(byte[] data) { 474 - System.Text.UTF8Encoding enc = new System.Text.UTF8Encoding(); 475 - return enc.GetString(data); 476 - } 477 - 478 - /// <summary> 479 - /// Zet een Base64 string om naar een ByteArray 480 - /// </summary> 481 - /// <param name="encodedData">Base64 string</param> 482 - /// <returns>gecomprimeerde ByteArray</returns> 483 - public static byte[] base64_decode(string encodedData) { 484 - byte[] encodedDataAsBytes = Convert.FromBase64String(encodedData); 485 - return encodedDataAsBytes; 486 - } 487 - 488 - /// <summary> 489 - /// Zet een gecomprimeerde ByteArray om in een ByteArray 490 - /// </summary> 491 - /// <param name="data">gecomprimeerde ByteArray</param> 492 - /// <returns>ByteArray (gedecomprimeerd)</returns> 493 - public static byte[] Decompress(byte[] data) { 494 - using(var compressedStream = new MemoryStream(data)) 495 - using(var zipStream = new GZipStream(compressedStream, CompressionMode.Decompress)) 496 - using(var resultStream = new MemoryStream()) { 497 - var buffer = new byte[4096]; 498 - int read; 499 - 500 - while ((read = zipStream.Read(buffer, 0, buffer.Length)) > 0) { 501 - resultStream.Write(buffer, 0, read); 502 - } 503 - 504 - return resultStream.ToArray(); 505 - } 506 - } 507 - #endregion 508 -} 509 -{{/code}} 313 +~/~// <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 } 510 510 ))) 511 511 512 512 513 513 (% class="col-xs-12 col-sm-4" %) 514 514 ((( 319 +{{box title="**Contents**"}} 320 +{{toc/}} 321 +{{/box}} 322 + 515 515 516 516 ))) 517 517 )))