digitaluapi

<back to all web services

GetCampaignActionClientFormData

The following routes are available for this service:
GET/campaign/inbox/form
GetCampaignActionClientFormData Parameters:
NameParameterData TypeRequiredDescription
IdquerylongNo
CommsGuidqueryGuidNo
CampaignActionsRequestsIdquerylongNo
GetCampaignActionClientFormDataResponse Parameters:
NameParameterData TypeRequiredDescription
FormMetaResponsesformCampaignActionFormResultsNo
ResponseStatusformResponseStatusNo
CampaignActionFormResults Parameters:
NameParameterData TypeRequiredDescription
CustomFormResultsformstringNo
CommentsformstringNo
CampaignActionFilesformList<CampaignActionFile>No
CampaignActionFile Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
FileTypeformstringNo
FileSizeformstringNo
ExtensionformstringNo
UploadUrlformstringNo

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
		}
	}
}