digitaluapi

<back to all web services

GetCampaignActionFiles

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
GET/campaign/actions/filesGet Campaign Action Files
"use strict";
export class FormFieldOption {
    /** @param {{Value?:string,Label?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Value;
    /** @type {string} */
    Label;
}
export class FormField {
    /** @param {{Id?:number,ControlType?:string,Label?:string,Placeholder?:string,Help?:string,Name?:string,SortOrder?:number,Options?:FormFieldOption[],Validation?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    ControlType;
    /** @type {string} */
    Label;
    /** @type {string} */
    Placeholder;
    /** @type {string} */
    Help;
    /** @type {string} */
    Name;
    /** @type {number} */
    SortOrder;
    /** @type {FormFieldOption[]} */
    Options;
    /** @type {string[]} */
    Validation;
}
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 CampaignActions {
    /** @param {{Id?:number,CampaignsId?:number,ActionsId?:number,ButtonName?:string,ActionTypesId?:number,Description?:string,OfferOrder?:number,StandOut?:boolean,PublicAccessGuid?:string,FormMeta?:FormField[],Files?:CampaignActionFile[],SentToEmailAddress?:string,CcEmailAddress?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    CampaignsId;
    /** @type {?number} */
    ActionsId;
    /** @type {string} */
    ButtonName;
    /** @type {?number} */
    ActionTypesId;
    /** @type {string} */
    Description;
    /** @type {?number} */
    OfferOrder;
    /** @type {?boolean} */
    StandOut;
    /** @type {string} */
    PublicAccessGuid;
    /** @type {FormField[]} */
    FormMeta;
    /** @type {CampaignActionFile[]} */
    Files;
    /** @type {string} */
    SentToEmailAddress;
    /** @type {string} */
    CcEmailAddress;
}
export class GetCampaignActionFiles {
    /** @param {{CampaignsId?:number,CampaignActionsId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CampaignsId;
    /** @type {number} */
    CampaignActionsId;
}

JavaScript GetCampaignActionFiles 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.

GET /campaign/actions/files HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CampaignActions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
  <ActionTypesId>0</ActionTypesId>
  <ActionsId>0</ActionsId>
  <ButtonName>String</ButtonName>
  <CampaignsId>0</CampaignsId>
  <CcEmailAddress>String</CcEmailAddress>
  <Description>String</Description>
  <Files xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
    <d2p1:CampaignActionFile>
      <d2p1:Extension>String</d2p1:Extension>
      <d2p1:FileSize>String</d2p1:FileSize>
      <d2p1:FileType>String</d2p1:FileType>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:UploadUrl>String</d2p1:UploadUrl>
    </d2p1:CampaignActionFile>
  </Files>
  <FormMeta xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
    <d2p1:FormField>
      <d2p1:ControlType>String</d2p1:ControlType>
      <d2p1:Help>String</d2p1:Help>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:Label>String</d2p1:Label>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Options>
        <d2p1:FormFieldOption>
          <d2p1:Label>String</d2p1:Label>
          <d2p1:Value>String</d2p1:Value>
        </d2p1:FormFieldOption>
      </d2p1:Options>
      <d2p1:Placeholder>String</d2p1:Placeholder>
      <d2p1:SortOrder>0</d2p1:SortOrder>
      <d2p1:Validation xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Validation>
    </d2p1:FormField>
  </FormMeta>
  <Id>0</Id>
  <OfferOrder>0</OfferOrder>
  <PublicAccessGuid>00000000-0000-0000-0000-000000000000</PublicAccessGuid>
  <SentToEmailAddress>String</SentToEmailAddress>
  <StandOut>false</StandOut>
</CampaignActions>