digitaluapi

<back to all web services

GetCampaignActionClientFormData

The following routes are available for this service:
GET/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 GetCampaignActionClientFormDataResponse {
    /** @param {{FormMetaResponses?:CampaignActionFormResults,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CampaignActionFormResults} */
    FormMetaResponses;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class GetCampaignActionClientFormData {
    /** @param {{Id?:number,CommsGuid?:string,CampaignActionsRequestsId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    CommsGuid;
    /** @type {number} */
    CampaignActionsRequestsId;
}

JavaScript GetCampaignActionClientFormData 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.

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

{
	FormMetaResponses: 
	{
		CustomFormResults: String,
		Comments: String,
		CampaignActionFiles: 
		[
			{
				Name: String,
				FileType: String,
				FileSize: String,
				Extension: String,
				UploadUrl: String
			}
		]
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}