digitaluapi

SaveCampaignActionClientCustomForm

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


export class CampaignActionFile
{
    public Name: string;
    public FileType: string;
    public FileSize: string;
    public Extension: string;
    public UploadUrl: string;

    public constructor(init?: Partial<CampaignActionFile>) { (Object as any).assign(this, init); }
}

export class CampaignActionFormResults
{
    public CustomFormResults: string;
    public Comments: string;
    public CampaignActionFiles: CampaignActionFile[];

    public constructor(init?: Partial<CampaignActionFormResults>) { (Object as any).assign(this, init); }
}

export class CampaignActionsFormResponses
{
    // @DataMember(Order=1)
    // @Required()
    public Id: number;

    // @DataMember(Order=2)
    // @Required()
    // @References("typeof(digitaluapi.ServiceModel.Types.CampaignActions)")
    public CampaignActionsId: number;

    // @DataMember(Order=3)
    // @References("typeof(digitaluapi.ServiceModel.Types.Customers)")
    public CustomersId?: number;

    // @DataMember(Order=4)
    // @Required()
    // @Computed()
    public ActionTimestamp: string;

    // @DataMember(Order=5)
    public FormMetaResponses: CampaignActionFormResults;

    // @DataMember(Order=6)
    public FormMetaCustomResponses: { [index:string]: string; };

    // @DataMember(Order=7)
    public CampaignInstanceCommsId?: number;

    // @DataMember(Order=8)
    public FormMetaFilesResponses: CampaignActionFile[];

    // @DataMember(Order=9)
    public FormMetaComments: string;

    // @DataMember(Order=10)
    public StatusCodesId: number;

    // @DataMember(Order=11)
    public SentToEmailAddress: string;

    // @DataMember(Order=12)
    public VersionNumber: number;

    public constructor(init?: Partial<CampaignActionsFormResponses>) { (Object as any).assign(this, init); }
}

export class SaveCampaignActionClientFormResponse
{
    public CampaignActionsFormResponses: CampaignActionsFormResponses;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<SaveCampaignActionClientFormResponse>) { (Object as any).assign(this, init); }
}

export class SaveCampaignActionClientCustomForm
{
    public CommsGuid: string;
    public CampaignActionsRequestsId: number;
    public CustomFormResults: { [index:string]: string; };

    public constructor(init?: Partial<SaveCampaignActionClientCustomForm>) { (Object as any).assign(this, init); }
}

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