digitaluapi

<back to all web services

SaveCampaignActionClientForm

The following routes are available for this service:
PUT POST/campaign/inbox/form
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class SaveCampaignActionClientForm
    {
        public UUID CommsGuid = null;
        public Long CampaignActionsRequestsId = null;
        public String Comments = null;
        public ArrayList<CampaignActionFile> CampaignActionFiles = null;
        
        public UUID getCommsGuid() { return CommsGuid; }
        public SaveCampaignActionClientForm setCommsGuid(UUID value) { this.CommsGuid = value; return this; }
        public Long getCampaignActionsRequestsId() { return CampaignActionsRequestsId; }
        public SaveCampaignActionClientForm setCampaignActionsRequestsId(Long value) { this.CampaignActionsRequestsId = value; return this; }
        public String getComments() { return Comments; }
        public SaveCampaignActionClientForm setComments(String value) { this.Comments = value; return this; }
        public ArrayList<CampaignActionFile> getCampaignActionFiles() { return CampaignActionFiles; }
        public SaveCampaignActionClientForm setCampaignActionFiles(ArrayList<CampaignActionFile> value) { this.CampaignActionFiles = value; return this; }
    }

    public static class CampaignActionFile
    {
        public String Name = null;
        public String FileType = null;
        public String FileSize = null;
        public String Extension = null;
        public String UploadUrl = null;
        
        public String getName() { return Name; }
        public CampaignActionFile setName(String value) { this.Name = value; return this; }
        public String getFileType() { return FileType; }
        public CampaignActionFile setFileType(String value) { this.FileType = value; return this; }
        public String getFileSize() { return FileSize; }
        public CampaignActionFile setFileSize(String value) { this.FileSize = value; return this; }
        public String getExtension() { return Extension; }
        public CampaignActionFile setExtension(String value) { this.Extension = value; return this; }
        public String getUploadUrl() { return UploadUrl; }
        public CampaignActionFile setUploadUrl(String value) { this.UploadUrl = value; return this; }
    }

    public static class SaveCampaignActionClientFormResponse
    {
        public CampaignActionsFormResponses CampaignActionsFormResponses = null;
        public ResponseStatus ResponseStatus = null;
        
        public CampaignActionsFormResponses getCampaignActionsFormResponses() { return CampaignActionsFormResponses; }
        public SaveCampaignActionClientFormResponse setCampaignActionsFormResponses(CampaignActionsFormResponses value) { this.CampaignActionsFormResponses = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public SaveCampaignActionClientFormResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class CampaignActionsFormResponses
    {
        @DataMember(Order=1)
        @Required()
        public Long Id = null;

        @DataMember(Order=2)
        @Required()
        @References(Type=CampaignActions.class)
        public Long CampaignActionsId = null;

        @DataMember(Order=3)
        @References(Type=Customers.class)
        public Long CustomersId = null;

        @DataMember(Order=4)
        @Required()
        @Computed()
        public Date ActionTimestamp = null;

        @DataMember(Order=5)
        public CampaignActionFormResults FormMetaResponses = null;

        @DataMember(Order=6)
        public HashMap<String,String> FormMetaCustomResponses = null;

        @DataMember(Order=7)
        public Long CampaignInstanceCommsId = null;

        @DataMember(Order=8)
        public ArrayList<CampaignActionFile> FormMetaFilesResponses = null;

        @DataMember(Order=9)
        public String FormMetaComments = null;

        @DataMember(Order=10)
        public Integer StatusCodesId = null;

        @DataMember(Order=11)
        public String SentToEmailAddress = null;

        @DataMember(Order=12)
        public Integer VersionNumber = null;
        
        public Long getId() { return Id; }
        public CampaignActionsFormResponses setId(Long value) { this.Id = value; return this; }
        public Long getCampaignActionsId() { return CampaignActionsId; }
        public CampaignActionsFormResponses setCampaignActionsId(Long value) { this.CampaignActionsId = value; return this; }
        public Long getCustomersId() { return CustomersId; }
        public CampaignActionsFormResponses setCustomersId(Long value) { this.CustomersId = value; return this; }
        public Date getActionTimestamp() { return ActionTimestamp; }
        public CampaignActionsFormResponses setActionTimestamp(Date value) { this.ActionTimestamp = value; return this; }
        public CampaignActionFormResults getFormMetaResponses() { return FormMetaResponses; }
        public CampaignActionsFormResponses setFormMetaResponses(CampaignActionFormResults value) { this.FormMetaResponses = value; return this; }
        public HashMap<String,String> getFormMetaCustomResponses() { return FormMetaCustomResponses; }
        public CampaignActionsFormResponses setFormMetaCustomResponses(HashMap<String,String> value) { this.FormMetaCustomResponses = value; return this; }
        public Long getCampaignInstanceCommsId() { return CampaignInstanceCommsId; }
        public CampaignActionsFormResponses setCampaignInstanceCommsId(Long value) { this.CampaignInstanceCommsId = value; return this; }
        public ArrayList<CampaignActionFile> getFormMetaFilesResponses() { return FormMetaFilesResponses; }
        public CampaignActionsFormResponses setFormMetaFilesResponses(ArrayList<CampaignActionFile> value) { this.FormMetaFilesResponses = value; return this; }
        public String getFormMetaComments() { return FormMetaComments; }
        public CampaignActionsFormResponses setFormMetaComments(String value) { this.FormMetaComments = value; return this; }
        public Integer getStatusCodesId() { return StatusCodesId; }
        public CampaignActionsFormResponses setStatusCodesId(Integer value) { this.StatusCodesId = value; return this; }
        public String getSentToEmailAddress() { return SentToEmailAddress; }
        public CampaignActionsFormResponses setSentToEmailAddress(String value) { this.SentToEmailAddress = value; return this; }
        public Integer getVersionNumber() { return VersionNumber; }
        public CampaignActionsFormResponses setVersionNumber(Integer value) { this.VersionNumber = value; return this; }
    }

    public static class CampaignActionFormResults
    {
        public String CustomFormResults = null;
        public String Comments = null;
        public ArrayList<CampaignActionFile> CampaignActionFiles = null;
        
        public String getCustomFormResults() { return CustomFormResults; }
        public CampaignActionFormResults setCustomFormResults(String value) { this.CustomFormResults = value; return this; }
        public String getComments() { return Comments; }
        public CampaignActionFormResults setComments(String value) { this.Comments = value; return this; }
        public ArrayList<CampaignActionFile> getCampaignActionFiles() { return CampaignActionFiles; }
        public CampaignActionFormResults setCampaignActionFiles(ArrayList<CampaignActionFile> value) { this.CampaignActionFiles = value; return this; }
    }

}

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