digitaluapi

SaveCampaignActionClientForm

The following routes are available for this service:
PUT POST	/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 CampaignActionsFormResponses {
    /** @param {{Id?:number,CampaignActionsId?:number,CustomersId?:number,ActionTimestamp?:string,FormMetaResponses?:CampaignActionFormResults,FormMetaCustomResponses?:{ [index:string]: string; },CampaignInstanceCommsId?:number,FormMetaFilesResponses?:CampaignActionFile[],FormMetaComments?:string,StatusCodesId?:number,SentToEmailAddress?:string,VersionNumber?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    CampaignActionsId;
    /** @type {?number} */
    CustomersId;
    /** @type {string} */
    ActionTimestamp;
    /** @type {CampaignActionFormResults} */
    FormMetaResponses;
    /** @type {{ [index:string]: string; }} */
    FormMetaCustomResponses;
    /** @type {?number} */
    CampaignInstanceCommsId;
    /** @type {CampaignActionFile[]} */
    FormMetaFilesResponses;
    /** @type {string} */
    FormMetaComments;
    /** @type {number} */
    StatusCodesId;
    /** @type {string} */
    SentToEmailAddress;
    /** @type {number} */
    VersionNumber;
}
export class SaveCampaignActionClientFormResponse {
    /** @param {{CampaignActionsFormResponses?:CampaignActionsFormResponses,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CampaignActionsFormResponses} */
    CampaignActionsFormResponses;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class SaveCampaignActionClientForm {
    /** @param {{CommsGuid?:string,CampaignActionsRequestsId?:number,Comments?:string,CampaignActionFiles?:CampaignActionFile[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CommsGuid;
    /** @type {number} */
    CampaignActionsRequestsId;
    /** @type {string} */
    Comments;
    /** @type {CampaignActionFile[]} */
    CampaignActionFiles;
}

JavaScript SaveCampaignActionClientForm 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/form HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SaveCampaignActionClientForm xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <CampaignActionFiles>
    <CampaignActionFile>
      <Extension>String</Extension>
      <FileSize>String</FileSize>
      <FileType>String</FileType>
      <Name>String</Name>
      <UploadUrl>String</UploadUrl>
    </CampaignActionFile>
  </CampaignActionFiles>
  <CampaignActionsRequestsId>0</CampaignActionsRequestsId>
  <Comments>String</Comments>
  <CommsGuid>00000000-0000-0000-0000-000000000000</CommsGuid>
</SaveCampaignActionClientForm>

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>