15. Import and export
Content of this chapter
This chapter contains web service methods concerning import and export.
15.1. StartImport
Namespace: http://agnitas.org/ws/schemas
Initiates an import. The import uses an Auto-Import profile. The import starts independently to the import time defined in the profile.
The webservice returns a job ID. The current state of the job ID can be read by using the webservice ImportStatus.
15.1.1. Request elements
| Element | Data type | Description |
|---|---|---|
| importID | {http://www.w3.org/2001/XMLSchema}int | ID of Auto-Import profile |
15.1.2. Response elements
| Element | Data type | Description |
|---|---|---|
| jobID | {http://www.w3.org/2001/XMLSchema}int | ID of import job |
15.1.3. SOAP Faults
The webservice returns a SOAP Fault if the given profile ID is unknown.
Note: The state of the job can be read only for a period of time.
15.2. ImportStatus
Namespace: http://agnitas.org/ws/schemas
It reads the state of a previously initiated import. Possible states are:
- Queued – The import has not been started yet
- Transferring – Retrieving data for import
- Running – The import is in progress
- Done – The import has finished successfully
- Fail – The import failed
15.2.1. Request elements
| Element | Data type | Description |
|---|---|---|
| jobID | {http://www.w3.org/2001/XMLSchema}int | ID of import job |
15.2.2. Response elements
| Element | Data type | Description |
|---|---|---|
| status | {http://www.w3.org/2001/XMLSchema}string | State of import job |
15.2.3. SOAP Faults
The webservice returns a SOAP fault if given job ID is unknown.
15.3. StartExport
Namespace: http://agnitas.com/ws/schemas
Initiates an export. The export uses an Auto-Export profile. The export starts independently to the export time defined in the profile.
The webservice returns a job ID. The current state of the job ID can be read by using the webservice ExportStatus.
15.3.1. Request elements
| Element | Data type | Description |
|---|---|---|
| exportID | {http://www.w3.org/2001/XMLSchema}int | ID of Auto-Export profile |
15.3.2. Reponse elements
| Element | Data type | Description |
|---|---|---|
| jobID | {http://www.w3.org/2001/XMLSchema}int | ID of export job |
15.3.3. SOAP faults
The webservice returns a SOAP Fault if the given profile ID is unknown.
Note: The state of the job can be read only for a period of time.
15.4. ExportStatus
Namespace: http://agnitas.com/ws/schemas
It reads the state of a previously initiated export. Possible states are:
- Queued – The export has not been started yet
- Transferring – Transferring exported data
- Running – The export is in progress
- Done – The export has finished successfully
- Fail – The export failed
15.4.1. Request elements
| Element | Data type | Description |
|---|---|---|
| jobID | {http://www.w3.org/2001/XMLSchema}int | ID of export job |
15.4.2. Response elements
| Element | Data type | Description |
|---|---|---|
| status | {http://www.w3.org/2001/XMLSchema}string | State of export job |
15.4.3. SOAP faults
The webservice returns a SOAP fault if given job ID is unknown.
15.5. ImportMailing
Namespace: http://agnitas.org/ws/schemas
Creates a new mailing by importing JSON data.