Import/Export Web Service

The Web Service interface allows to import, export and update entities.

Methods

The Web Service interface provides the following methods:

• Import and DeepImport - import or update entities
• Export and DeepExport- export entities
• Delete - delete entities
• GetStatus
• Errors and Warnings

URLs

• Service Url

  https://[pathToWebApplication]/service/importexportservice.asmx

• Service WSDL

  https://[pathToWebApplication]/service/importexportservice.asmx?wsdl

Sequence to get the Final Result

The following steps draft the sequence for import, export, delete, deep import, and deep export to get the final result.

Note: All service requests are handled asynchronously.

Sequence Steps

1. Call the appropriate method with all mandatory parameters.

2. Check the Status field of the result object:

   • If Status is 0, the process is still running and no final result yet exists. Go on to step 3.

   • If Status <> 0: Operation is ready. Check "Errors" array. If empty, operation succeeded. If not empty, details about the errors are contained in array.

3. Wait for some time and then call "Get Status" to get the result of the request: use the Token of the Result object from step 2 as parameter.

4. Check Status field of the result object.

   • If Status is 0, the process is still running and no final result yet exists. Go back to step 3.

   • If Status <> 0: Operation is ready. Check "Errors" array. If empty, operation succeeded. If not empty, details about the errors are contained in array.

Result Object

Every operation returns a .NET object that has the following structure:

• Status

  Status of the request:

  • 0: The request is being processed
  • <>0: The request was finished

  Type: int

• RecentRequestedDate

  Date/Time when the request was initiated

  Type: DateTime

• Token

  The one-time authentication token of the request that can be used to get the status of the request.

  Type: string

• Format

  Data format of the request data (XML or CSV).

  Type: string

• Data

  The Data element does return the following:

  • For Export: depending of the Format, either an XML string in a CDATA section or a CSV string.
  • For DeepExport: the generated ZIP file in base64 encoded format.
  • Null for all other operations.

  Type: string

• Description

  A short description of the result (success or error description)

  Type: string

• Errors

  An array of Error objects that are populated in case the request results in an error. For the structure of an error object see

  Type: Error. See: Errors and Warnings