18. Other
Content of this chapter
Miscellaneous web service methods
18.1. DecryptLinkData
Namespace: http://agnitas.org/ws/schemas
Decrypts a UID and delivers the information it contains.
18.1.1. Request elements
| Element | Data type | Description |
|---|---|---|
| linkparam | {http://www.w3.org/2001/XMLSchema}string | UID to decode |
18.1.2. Response elements
| Elements | Data type | Description |
|---|---|---|
| mailingID | {http://www.w3.org/2001/XMLSchema}int | mailing ID |
| companyID | {http://www.w3.org/2001/XMLSchema}int | company ID |
| urlID | {http://www.w3.org/2001/XMLSchema}int | URL ID |
| customerID | {http://www.w3.org/2001/XMLSchema}int | customer ID |
customerID and companyID is always larger than 0, mailingID and urlID depending on the use of the UID (e.g. for link click in newsletter).
18.1.3. SOAP Faults
A SOAP fault is issued when the UID cannot be decoded. Decoding is only possible when the given UID has a valid format and all the necessary data can be retrieved from the account concerned.
18.2. CreateDataSource
Namespace: http://agnitas.org/ws/schemas
This web service registers a new data source. A data source can be used for example when adding new subscribers to track the origin of the data.
18.2.1. Request elements
| Elements | Data type | Description |
|---|---|---|
| description | {http://www.w3.org/2001/XMLSchema}string | Description of the new datasource. The description has to be unique. |
| url | {http://www.w3.org/2001/XMLSchema}string | Origin of data. This is not required to be a URL. |
18.2.2. Response elements
| Element | Data type | Description |
|---|---|---|
| id | {http://www.w3.org/2001/XMLSchema}int | ID of new data source |
18.2.3. SOAP Faults
If the data source can not be registered, a Soap Fault is returned. A data source with identical description is a possible reason.