digitaluapi

<back to all web services

SaveCampaignActionClientCustomForm

The following routes are available for this service:
PUT POST/campaign/inbox/customform
namespace digitaluapi.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CampaignActionFile() = 
        member val Name:String = null with get,set
        member val FileType:String = null with get,set
        member val FileSize:String = null with get,set
        member val Extension:String = null with get,set
        member val UploadUrl:String = null with get,set

    [<AllowNullLiteral>]
    type CampaignActionFormResults() = 
        member val CustomFormResults:String = null with get,set
        member val Comments:String = null with get,set
        member val CampaignActionFiles:ResizeArray<CampaignActionFile> = null with get,set

    [<AllowNullLiteral>]
    type CampaignActionsFormResponses() = 
        [<DataMember(Order=1)>]
        [<Required>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember(Order=2)>]
        [<Required>]
        [<References(typeof<CampaignActions>)>]
        member val CampaignActionsId:Int64 = new Int64() with get,set

        [<DataMember(Order=3)>]
        [<References(typeof<Customers>)>]
        member val CustomersId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=4)>]
        [<Required>]
        [<Computed>]
        member val ActionTimestamp:DateTimeOffset = new DateTimeOffset() with get,set

        [<DataMember(Order=5)>]
        member val FormMetaResponses:CampaignActionFormResults = null with get,set

        [<DataMember(Order=6)>]
        member val FormMetaCustomResponses:Dictionary<String, String> = null with get,set

        [<DataMember(Order=7)>]
        member val CampaignInstanceCommsId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=8)>]
        member val FormMetaFilesResponses:ResizeArray<CampaignActionFile> = null with get,set

        [<DataMember(Order=9)>]
        member val FormMetaComments:String = null with get,set

        [<DataMember(Order=10)>]
        member val StatusCodesId:Int32 = new Int32() with get,set

        [<DataMember(Order=11)>]
        member val SentToEmailAddress:String = null with get,set

        [<DataMember(Order=12)>]
        member val VersionNumber:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type SaveCampaignActionClientFormResponse() = 
        member val CampaignActionsFormResponses:CampaignActionsFormResponses = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type SaveCampaignActionClientCustomForm() = 
        member val CommsGuid:Guid = new Guid() with get,set
        member val CampaignActionsRequestsId:Int64 = new Int64() with get,set
        member val CustomFormResults:Dictionary<String, String> = null with get,set

F# 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>