digitaluapi

SaveCampaignActionClientForm

The following routes are available for this service:
PUT POST	/campaign/inbox/form

"use strict";
export class CampaignActionFile {
    /** @param {{Name?:string,FileType?:string,FileSize?:string,Extension?:string,UploadUrl?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    FileType;
    /** @type {string} */
    FileSize;
    /** @type {string} */
    Extension;
    /** @type {string} */
    UploadUrl;
}
export class CampaignActionFormResults {
    /** @param {{CustomFormResults?:string,Comments?:string,CampaignActionFiles?:CampaignActionFile[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CustomFormResults;
    /** @type {string} */
    Comments;
    /** @type {CampaignActionFile[]} */
    CampaignActionFiles;
}
export class CampaignActionsFormResponses {
    /** @param {{Id?:number,CampaignActionsId?:number,CustomersId?:number,ActionTimestamp?:string,FormMetaResponses?:CampaignActionFormResults,FormMetaCustomResponses?:{ [index:string]: string; },CampaignInstanceCommsId?:number,FormMetaFilesResponses?:CampaignActionFile[],FormMetaComments?:string,StatusCodesId?:number,SentToEmailAddress?:string,VersionNumber?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    CampaignActionsId;
    /** @type {?number} */
    CustomersId;
    /** @type {string} */
    ActionTimestamp;
    /** @type {CampaignActionFormResults} */
    FormMetaResponses;
    /** @type {{ [index:string]: string; }} */
    FormMetaCustomResponses;
    /** @type {?number} */
    CampaignInstanceCommsId;
    /** @type {CampaignActionFile[]} */
    FormMetaFilesResponses;
    /** @type {string} */
    FormMetaComments;
    /** @type {number} */
    StatusCodesId;
    /** @type {string} */
    SentToEmailAddress;
    /** @type {number} */
    VersionNumber;
}
export class SaveCampaignActionClientFormResponse {
    /** @param {{CampaignActionsFormResponses?:CampaignActionsFormResponses,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CampaignActionsFormResponses} */
    CampaignActionsFormResponses;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class SaveCampaignActionClientForm {
    /** @param {{CommsGuid?:string,CampaignActionsRequestsId?:number,Comments?:string,CampaignActionFiles?:CampaignActionFile[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CommsGuid;
    /** @type {number} */
    CampaignActionsRequestsId;
    /** @type {string} */
    Comments;
    /** @type {CampaignActionFile[]} */
    CampaignActionFiles;
}

JavaScript SaveCampaignActionClientForm DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /campaign/inbox/form HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CommsGuid: 00000000000000000000000000000000,
	CampaignActionsRequestsId: 0,
	Comments: String,
	CampaignActionFiles: 
	[
		{
			Name: String,
			FileType: String,
			FileSize: String,
			Extension: String,
			UploadUrl: String
		}
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CampaignActionsFormResponses: 
	{
		Id: 0,
		CampaignActionsId: 0,
		CustomersId: 0,
		ActionTimestamp: 0001-01-01T00:00:00.0000000+00:00,
		FormMetaResponses: 
		{
			CustomFormResults: String,
			Comments: String,
			CampaignActionFiles: 
			[
				{
					Name: String,
					FileType: String,
					FileSize: String,
					Extension: String,
					UploadUrl: String
				}
			]
		},
		FormMetaCustomResponses: 
		{
			String: String
		},
		CampaignInstanceCommsId: 0,
		FormMetaFilesResponses: 
		[
			{
				Name: String,
				FileType: String,
				FileSize: String,
				Extension: String,
				UploadUrl: String
			}
		],
		FormMetaComments: String,
		StatusCodesId: 0,
		SentToEmailAddress: String,
		VersionNumber: 0
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}