A base class for all API DTO classes
| name | data type | description |
|---|---|---|
| templateCode | string | |
| parameters | array of MessageVariableValue | |
| campaign | Campaign | |
| contact | Contact | |
| media | MediaEnum | |
| subMedia | string | |
| priority | PriorityEnum | |
| status | MessageStatusEnum | |
| rejectionReason | string |
Example
{
"templateCode" : "...",
"parameters" : [ {
"message" : {
"id" : 12345,
"contact" : { },
"version" : 12345,
"media" : "WEBSERVICE",
"priority" : "NORMAL",
"status" : "PROCESSING",
"subMedia" : "...",
"rejectionReason" : "...",
"transient" : true,
"parameters" : [ { }, { } ],
"campaign" : { },
"templateCode" : "..."
},
"auditableFields" : [ {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "RENEWAL",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
}, {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "OTHER",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
} ],
"referenceCode" : "...",
"historized" : true,
"code" : "...",
"descriptionAndCode" : "...",
"descriptionOrCode" : "...",
"version" : 12345,
"description" : "...",
"value" : "...",
"parentEntityType" : { },
"id" : 12345,
"notified" : true,
"referenceDescription" : "...",
"transient" : true,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastUser" : "...",
"updater" : "...",
"updated" : 12345,
"lastModified" : 12345
},
"appendGeneratedCode" : true,
"parentEntity" : {
"referenceDescription" : "...",
"auditableFields" : [ { }, { } ],
"parentEntity" : { },
"codeChanged" : true,
"description" : "...",
"auditable" : { },
"transient" : true,
"referenceCode" : "...",
"version" : 12345,
"code" : "...",
"parentEntityType" : { },
"id" : 12345,
"notified" : true,
"appendGeneratedCode" : true,
"descriptionAndCode" : "...",
"historized" : true,
"descriptionOrCode" : "..."
},
"codeChanged" : true
}, {
"message" : {
"id" : 12345,
"contact" : { },
"version" : 12345,
"media" : "POSTAL_MAIL",
"priority" : "SLOW",
"status" : "PROCESSING",
"subMedia" : "...",
"rejectionReason" : "...",
"transient" : true,
"parameters" : [ { }, { } ],
"campaign" : { },
"templateCode" : "..."
},
"auditableFields" : [ {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "OTHER",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
}, {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "STATUS",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
} ],
"referenceCode" : "...",
"historized" : true,
"code" : "...",
"descriptionAndCode" : "...",
"descriptionOrCode" : "...",
"version" : 12345,
"description" : "...",
"value" : "...",
"parentEntityType" : { },
"id" : 12345,
"notified" : true,
"referenceDescription" : "...",
"transient" : true,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastUser" : "...",
"updater" : "...",
"updated" : 12345,
"lastModified" : 12345
},
"appendGeneratedCode" : true,
"parentEntity" : {
"referenceDescription" : "...",
"auditableFields" : [ { }, { } ],
"parentEntity" : { },
"codeChanged" : true,
"description" : "...",
"auditable" : { },
"transient" : true,
"referenceCode" : "...",
"version" : 12345,
"code" : "...",
"parentEntityType" : { },
"id" : 12345,
"notified" : true,
"appendGeneratedCode" : true,
"descriptionAndCode" : "...",
"historized" : true,
"descriptionOrCode" : "..."
},
"codeChanged" : true
} ],
"campaign" : {
"referenceDescription" : "...",
"codeChanged" : true,
"historized" : true,
"status" : "TERMINATED",
"startDate" : 12345,
"endDate" : 12345,
"useAnyMedia" : true,
"description" : "...",
"auditableFields" : [ {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "OTHER",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
}, {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "RENEWAL",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
} ],
"messages" : [ {
"id" : 12345,
"contact" : { },
"version" : 12345,
"media" : "WEBSERVICE",
"priority" : "NORMAL",
"status" : "CANCELED",
"subMedia" : "...",
"rejectionReason" : "...",
"transient" : true,
"parameters" : [ { }, { } ],
"campaign" : { },
"templateCode" : "..."
}, {
"id" : 12345,
"contact" : { },
"version" : 12345,
"media" : "IM",
"priority" : "SLOW",
"status" : "PROCESSING",
"subMedia" : "...",
"rejectionReason" : "...",
"transient" : true,
"parameters" : [ { }, { } ],
"campaign" : { },
"templateCode" : "..."
} ],
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastUser" : "...",
"updater" : "...",
"updated" : 12345,
"lastModified" : 12345
},
"referenceCode" : "...",
"processingThreadId" : 12345,
"scheduleDate" : 12345,
"descriptionOrCode" : "...",
"parentEntity" : {
"referenceDescription" : "...",
"auditableFields" : [ { }, { } ],
"parentEntity" : { },
"codeChanged" : true,
"description" : "...",
"auditable" : { },
"transient" : true,
"referenceCode" : "...",
"version" : 12345,
"code" : "...",
"parentEntityType" : { },
"id" : 12345,
"notified" : true,
"appendGeneratedCode" : true,
"descriptionAndCode" : "...",
"historized" : true,
"descriptionOrCode" : "..."
},
"priority" : "URGENT",
"transient" : true,
"parentEntityType" : { },
"subMedia" : "...",
"appendGeneratedCode" : true,
"media" : "IM",
"notified" : true,
"id" : 12345,
"code" : "...",
"descriptionAndCode" : "...",
"version" : 12345
},
"contact" : {
"uuid" : "...",
"appendGeneratedCode" : true,
"jobTitle" : "...",
"referenceCode" : "...",
"websiteUrl" : "...",
"addressBook" : {
"appendGeneratedCode" : true,
"referenceCode" : "...",
"version" : 12345,
"id" : 12345,
"contacts" : [ { }, { } ],
"notified" : true,
"code" : "...",
"referenceDescription" : "...",
"parentEntityType" : { },
"historized" : true,
"auditable" : { },
"auditableFields" : [ { }, { } ],
"descriptionAndCode" : "...",
"codeChanged" : true,
"descriptionOrCode" : "...",
"parentEntity" : { },
"transient" : true,
"description" : "...",
"customer" : { }
},
"version" : 12345,
"contactPolicy" : {
"nbMaxMessagePerWeek" : 12345,
"nbMaxMessagePerMonth" : 12345,
"nbMaxMessagePerDay" : 12345,
"delayMinBetween2messages" : 12345
},
"agreedToUA" : true,
"externalRef2" : "...",
"code" : "...",
"company" : "...",
"cfAccumulatedValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"contactInformation" : {
"email" : "...",
"fax" : "...",
"phone" : "...",
"mobile" : "..."
},
"externalRef1" : "...",
"contactInformationNullSafe" : {
"email" : "...",
"fax" : "...",
"phone" : "...",
"mobile" : "..."
},
"referenceDescription" : "...",
"codeChanged" : true,
"contactCategories" : [ {
"auditableFields" : [ { }, { } ],
"notified" : true,
"transient" : true,
"parentEntityType" : { },
"descriptionAndCode" : "...",
"referenceCode" : "...",
"description" : "...",
"referenceDescription" : "...",
"cfValues" : { },
"parentCFEntities" : [ { }, { } ],
"uuid" : "...",
"cfAccumulatedValues" : { },
"parentEntity" : { },
"codeChanged" : true,
"historized" : true,
"version" : 12345,
"auditable" : { },
"descriptionOrCode" : "...",
"code" : "...",
"appendGeneratedCode" : true,
"id" : 12345
}, {
"auditableFields" : [ { }, { } ],
"notified" : true,
"transient" : true,
"parentEntityType" : { },
"descriptionAndCode" : "...",
"referenceCode" : "...",
"description" : "...",
"referenceDescription" : "...",
"cfValues" : { },
"parentCFEntities" : [ { }, { } ],
"uuid" : "...",
"cfAccumulatedValues" : { },
"parentEntity" : { },
"codeChanged" : true,
"historized" : true,
"version" : 12345,
"auditable" : { },
"descriptionOrCode" : "...",
"code" : "...",
"appendGeneratedCode" : true,
"id" : 12345
} ],
"notified" : true,
"historized" : true,
"description" : "...",
"position" : "...",
"assistantName" : "...",
"auditableFields" : [ {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "RENEWAL",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
}, {
"fieldName" : "...",
"notfiable" : true,
"auditType" : "OTHER",
"historized" : true,
"previousState" : { },
"currentState" : { },
"historable" : true,
"notified" : true
} ],
"address" : {
"countryBundle" : "...",
"address1" : "...",
"state" : "...",
"address4" : "...",
"city" : "...",
"zipCode" : "...",
"address5" : "...",
"address3" : "...",
"country" : { },
"address2" : "..."
},
"isCompany" : true,
"assistantPhone" : "...",
"primaryContact" : {
"id" : 12345,
"auditableFields" : [ { }, { } ],
"parentEntity" : { },
"fax" : "...",
"descriptionAndCode" : "...",
"parentEntityType" : { },
"description" : "...",
"transient" : true,
"appendGeneratedCode" : true,
"lastName" : "...",
"historized" : true,
"referenceCode" : "...",
"version" : 12345,
"descriptionOrCode" : "...",
"codeChanged" : true,
"auditable" : { },
"phone" : "...",
"code" : "...",
"notified" : true,
"firstName" : "...",
"mobile" : "...",
"email" : "...",
"referenceDescription" : "...",
"genericMail" : "...",
"address" : { }
},
"tags" : [ "...", "..." ],
"prospect" : true,
"parentEntityType" : { },
"name" : {
"fullName" : "...",
"title" : { },
"lastName" : "...",
"firstName" : "..."
},
"vatNo" : "...",
"addressBookContacts" : [ {
"position" : "...",
"addressBook" : { },
"version" : 12345,
"mainContact" : true,
"contact" : { },
"transient" : true,
"id" : 12345
}, {
"position" : "...",
"addressBook" : { },
"version" : 12345,
"mainContact" : true,
"contact" : { },
"transient" : true,
"id" : 12345
} ],
"importedBy" : "...",
"enterprise" : true,
"id" : 12345,
"auditable" : {
"created" : 12345,
"creator" : "...",
"lastUser" : "...",
"updater" : "...",
"updated" : 12345,
"lastModified" : 12345
},
"descriptionOrCode" : "...",
"messages" : [ {
"id" : 12345,
"contact" : { },
"version" : 12345,
"media" : "WEBSERVICE",
"priority" : "NORMAL",
"status" : "TREATED",
"subMedia" : "...",
"rejectionReason" : "...",
"transient" : true,
"parameters" : [ { }, { } ],
"campaign" : { },
"templateCode" : "..."
}, {
"id" : 12345,
"contact" : { },
"version" : 12345,
"media" : "CFT_FILE",
"priority" : "URGENT",
"status" : "REJECTED",
"subMedia" : "...",
"rejectionReason" : "...",
"transient" : true,
"parameters" : [ { }, { } ],
"campaign" : { },
"templateCode" : "..."
} ],
"vip" : true,
"parentCFEntities" : [ {
"cfValuesNullSafe" : { },
"uuid" : "...",
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfValues" : { },
"parentCFEntities" : [ { }, { } ],
"CFValuesCopy" : { },
"cfAccumulatedValuesNullSafe" : { },
"cfAccumulatedValues" : { }
}, {
"cfValuesNullSafe" : { },
"uuid" : "...",
"dirtyCF" : true,
"cfValuesAsValues" : {
"property1" : { },
"property2" : { }
},
"cfValues" : { },
"parentCFEntities" : [ { }, { } ],
"CFValuesCopy" : { },
"cfAccumulatedValuesNullSafe" : { },
"cfAccumulatedValues" : { }
} ],
"importedFrom" : "...",
"descriptionAndCode" : "...",
"cfValues" : {
"valuesByCode" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"values" : {
"property1" : { },
"property2" : { }
},
"newVersionedCFValuePeriods" : {
"property1" : [ { }, { } ],
"property2" : [ { }, { } ]
},
"encrypted" : true
},
"comment" : "...",
"transient" : true,
"parentEntity" : {
"referenceDescription" : "...",
"auditableFields" : [ { }, { } ],
"parentEntity" : { },
"codeChanged" : true,
"description" : "...",
"auditable" : { },
"transient" : true,
"referenceCode" : "...",
"version" : 12345,
"code" : "...",
"parentEntityType" : { },
"id" : 12345,
"notified" : true,
"appendGeneratedCode" : true,
"descriptionAndCode" : "...",
"historized" : true,
"descriptionOrCode" : "..."
},
"reference" : "...",
"socialIdentifier" : "...",
"legalEntityType" : {
"descriptionI18nNullSafe" : {
"property1" : "...",
"property2" : "..."
},
"id" : 12345,
"codeChanged" : true,
"auditable" : { },
"parentEntity" : { },
"auditableFields" : [ { }, { } ],
"referenceDescription" : "...",
"transient" : true,
"code" : "...",
"descriptionAndCode" : "...",
"appendGeneratedCode" : true,
"descriptionOrCode" : "...",
"historized" : true,
"description" : "...",
"isCompany" : true,
"parentEntityType" : { },
"version" : 12345,
"descriptionI18n" : {
"property1" : "...",
"property2" : "..."
},
"referenceCode" : "...",
"notified" : true,
"descriptionNotNull" : "..."
},
"registrationNo" : "..."
},
"media" : "POSTAL_MAIL",
"subMedia" : "...",
"priority" : "NORMAL",
"status" : "WAITING",
"rejectionReason" : "..."
}