digitaluapi

<back to all web services

SaveCampaignActionClientCustomForm

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

public class dtos
{

    public static class SaveCampaignActionClientCustomForm
    {
        public UUID CommsGuid = null;
        public Long CampaignActionsRequestsId = null;
        public HashMap<String,String> CustomFormResults = null;
        
        public UUID getCommsGuid() { return CommsGuid; }
        public SaveCampaignActionClientCustomForm setCommsGuid(UUID value) { this.CommsGuid = value; return this; }
        public Long getCampaignActionsRequestsId() { return CampaignActionsRequestsId; }
        public SaveCampaignActionClientCustomForm setCampaignActionsRequestsId(Long value) { this.CampaignActionsRequestsId = value; return this; }
        public HashMap<String,String> getCustomFormResults() { return CustomFormResults; }
        public SaveCampaignActionClientCustomForm setCustomFormResults(HashMap<String,String> value) { this.CustomFormResults = 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; }
    }

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

}

Java SaveCampaignActionClientCustomForm DTOs

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

HTTP + XML

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

POST /campaign/inbox/customform HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveCampaignActionClientCustomForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CampaignActionsRequestsId>0</CampaignActionsRequestsId>
  <CommsGuid>00000000-0000-0000-0000-000000000000</CommsGuid>
  <CustomFormResults xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </CustomFormResults>
</SaveCampaignActionClientCustomForm>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SaveCampaignActionClientFormResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CampaignActionsFormResponses xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
    <d2p1:ActionTimestamp xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>0001-01-01T00:00:00Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </d2p1:ActionTimestamp>
    <d2p1:CampaignActionsId>0</d2p1:CampaignActionsId>
    <d2p1:CampaignInstanceCommsId>0</d2p1:CampaignInstanceCommsId>
    <d2p1:CustomersId>0</d2p1:CustomersId>
    <d2p1:FormMetaComments>String</d2p1:FormMetaComments>
    <d2p1:FormMetaCustomResponses xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:FormMetaCustomResponses>
    <d2p1:FormMetaFilesResponses>
      <CampaignActionFile>
        <Extension>String</Extension>
        <FileSize>String</FileSize>
        <FileType>String</FileType>
        <Name>String</Name>
        <UploadUrl>String</UploadUrl>
      </CampaignActionFile>
    </d2p1:FormMetaFilesResponses>
    <d2p1:FormMetaResponses>
      <CampaignActionFiles>
        <CampaignActionFile>
          <Extension>String</Extension>
          <FileSize>String</FileSize>
          <FileType>String</FileType>
          <Name>String</Name>
          <UploadUrl>String</UploadUrl>
        </CampaignActionFile>
      </CampaignActionFiles>
      <Comments>String</Comments>
      <CustomFormResults>String</CustomFormResults>
    </d2p1:FormMetaResponses>
    <d2p1:Id>0</d2p1:Id>
    <d2p1:SentToEmailAddress>String</d2p1:SentToEmailAddress>
    <d2p1:StatusCodesId>0</d2p1:StatusCodesId>
    <d2p1:VersionNumber>0</d2p1:VersionNumber>
  </CampaignActionsFormResponses>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</SaveCampaignActionClientFormResponse>