Import/Export Web Service

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

Methods

The Web Service interface provides the following methods:

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 final result.

All service requests are handled asynchronously.

Steps of sequence:

1. Call the appropriate method with all mandatory parameters

2. Check Status field of the result object:

3. Wait for some time and then call "Get Status" to get the result of the request: Use the TokenProdukt(e): AE, SNSC. Ein Token wird für die Authentifizierung innerhalb einer Sitzung zwischen einem Client und einem Server verwendet. Ein (Soft-)Token ist eine eindeutige Kennung, die von einem zentralen Server generiert und zu einer Client-Software gesendet wird. Der Client verwendet das Token, um jede Anfrage zu authentifizieren. of the Result object from step 2 as parameter

4. Check Status field of the result object.

Result Object

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

Property Name

Type

Description

Status

int

Status of the request:

State

Description

0

The request is getting processed

>0

The request was finished successfully

<0

An error occurred

RecentRequestedDate

DateTime

Date/Time when the request was initiated

Token string The one-time authentication token of the request that can be used to get the status of the request
Format string Data format of the request data (xml or csv)
Data string

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
Description string

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

Errors Error[] An array of Error objects that will be populated in case the request results in an error. For the structure of an error object see Errors and Warnings