The following is a description of most common platform data structures.
General
Credentials
| Field |
Type |
| username |
String |
| password |
String |
| customerId |
int |
| type |
int |
| extra |
String |
Option
| Field |
Type |
| key |
String |
| value |
String |
FieldValue
| Field |
Type |
| key |
String |
| value |
String |
MNRowSetInfo
| Field |
Type |
Description |
| count |
int |
Number of the records of the rowset |
| dataType |
String |
Type of the rowset |
| idRowSet |
String |
Id of the rowset |
MNCampaign
| Field |
Type |
| idCampaign |
String |
| name |
String |
| description |
String |
| defaultTarget |
List of String |
| idWebsite |
int |
SimpleQueryResult
| Field |
Type |
|
| recordCount |
int |
number of records retrieved |
| columnNames |
ListString
|
name of the columns of the query results. List is empty if the query has no results
|
| records |
List of SimpleRecord
|
list of record results |
SimpleRecord
| Field |
Type |
|
| record |
List of FieldValue
|
records of a custom table |
SQLParameter
| Field |
Type |
Description |
| type |
type |
null, string, integer, timestamp |
| value |
string |
|
sqlResult
| Field |
Type |
| ok |
boolean |
| recordCount |
long |
| resultstype |
SimpleQueryResult |
MNCustomDataBatchStartOptions
| Field |
Type |
| name |
Name of the operation |
| tableName |
Name of the table into which perform the batch import/update operation |
MNCustomDataMergeOperation
| Field |
Type |
|
| result |
String |
result of the operation, can be one of 'insert','update','error','notvalid' or 'contactnotfound' |
| pk |
String |
primary key of the record which has been inserted/updated |
| debugMessage |
String |
debug message |
Workflows
EnterWorkflowData
| Field |
Type |
|
| idContact |
String |
the ID of the Contact |
| variable |
List of FieldValue
|
list of contextual variables |
| primaryKey |
String |
To be used together with iddatabase and as an alternative to idcontact. Indicates the ID of the origin database of the contact to be added to the workflow.
<xs:element name="primaryKey" type="xs:string" minOccurs="0"/>
|
| iddatabase |
String |
To be used together with primaryKey and as an alternative to idcontact. Indicates the primarykey of the contact to be added to the workflow.
<xs:element name="iddatabase" type="xs:string" minOccurs="0"/>
|
EnterWorkflowResult
| Field |
Type |
|
| idContact |
String |
the ID of the Contact |
| idWorkflowSession |
List<String> |
list of the session which have been actually created for the Contact |
AppCloud
ApplicationResult
| Field |
Type |
|
| text |
String |
message returned from the operation |
| binary |
Byte[] |
final result of the operation |
| ok; |
Boolean |
|
| errorMessage |
String |
it is valued in the presence of execution errors |
Design Legacy
MNTemplateInfo
| Field |
Type |
| description |
String |
| forImport |
Boolean |
| templateId |
String |
Delivery Legacy
BounceCategory
| Field |
Type |
Description |
| idbouncecategory |
Integer |
|
| errorType |
String |
'hard' or 'soft' |
| subtypeCode |
String |
'hard','softuser','softblock','softtechnical','other' |
| subtype |
String |
Localized description of the subtypeCode |
| causeCode |
String |
see list of causes in bounces analysis documentation |
| cause |
String |
Localized description of the causeCode |
| media |
String |
'email' or 'sms' or 'fax' |
| description |
String |
(Deprecated) Internal localized description of the bounce category, it is better to use 'causeCode' and 'cause' fields |
Events
SimpleMessageEvent
| Field |
Type |
Description |
| idSimpleMessage |
int |
|
| idContact |
int |
|
| eventType |
string |
|
| open |
boolean |
|
| link |
string |
|
| eventTimestamp |
long |
Unix timestamp |
| otherValues |
list <FieldValue> |
|
| idChannel |
int |
|