digitaluapi

<back to all web services

SaveCampaignActionClientForm

The following routes are available for this service:
PUT POST/campaign/inbox/form
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports digitaluapi.ServiceModel
Imports digitaluapi.ServiceModel.Types

Namespace Global

    Namespace digitaluapi.ServiceModel

        Public Partial Class CampaignActionFile
            Public Overridable Property Name As String
            Public Overridable Property FileType As String
            Public Overridable Property FileSize As String
            Public Overridable Property Extension As String
            Public Overridable Property UploadUrl As String
        End Class

        Public Partial Class CampaignActionFormResults
            Public Overridable Property CustomFormResults As String
            Public Overridable Property Comments As String
            Public Overridable Property CampaignActionFiles As List(Of CampaignActionFile)
        End Class

        Public Partial Class SaveCampaignActionClientForm
            Public Overridable Property CommsGuid As Guid
            Public Overridable Property CampaignActionsRequestsId As Long
            Public Overridable Property Comments As String
            Public Overridable Property CampaignActionFiles As List(Of CampaignActionFile)
        End Class

        Public Partial Class SaveCampaignActionClientFormResponse
            Public Overridable Property CampaignActionsFormResponses As CampaignActionsFormResponses
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace digitaluapi.ServiceModel.Types

        Public Partial Class CampaignActionsFormResponses
            <DataMember(Order:=1)>
            <Required>
            Public Overridable Property Id As Long

            <DataMember(Order:=2)>
            <Required>
            <References(GetType(CampaignActions))>
            Public Overridable Property CampaignActionsId As Long

            <DataMember(Order:=3)>
            <References(GetType(Customers))>
            Public Overridable Property CustomersId As Long?

            <DataMember(Order:=4)>
            <Required>
            <Computed>
            Public Overridable Property ActionTimestamp As DateTimeOffset

            <DataMember(Order:=5)>
            Public Overridable Property FormMetaResponses As CampaignActionFormResults

            <DataMember(Order:=6)>
            Public Overridable Property FormMetaCustomResponses As Dictionary(Of String, String)

            <DataMember(Order:=7)>
            Public Overridable Property CampaignInstanceCommsId As Long?

            <DataMember(Order:=8)>
            Public Overridable Property FormMetaFilesResponses As List(Of CampaignActionFile)

            <DataMember(Order:=9)>
            Public Overridable Property FormMetaComments As String

            <DataMember(Order:=10)>
            Public Overridable Property StatusCodesId As Integer

            <DataMember(Order:=11)>
            Public Overridable Property SentToEmailAddress As String

            <DataMember(Order:=12)>
            Public Overridable Property VersionNumber As Integer
        End Class
    End Namespace
End Namespace

VB.NET SaveCampaignActionClientForm DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"CommsGuid":"00000000000000000000000000000000","CampaignActionsRequestsId":0,"Comments":"String","CampaignActionFiles":[{"Name":"String","FileType":"String","FileSize":"String","Extension":"String","UploadUrl":"String"}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"CampaignActionsFormResponses":{"Id":0,"CampaignActionsId":0,"CustomersId":0,"ActionTimestamp":"0001-01-01T00:00:00.0000000+00:00","FormMetaResponses":{"CustomFormResults":"String","Comments":"String","CampaignActionFiles":[{"Name":"String","FileType":"String","FileSize":"String","Extension":"String","UploadUrl":"String"}]},"FormMetaCustomResponses":{"String":"String"},"CampaignInstanceCommsId":0,"FormMetaFilesResponses":[{"Name":"String","FileType":"String","FileSize":"String","Extension":"String","UploadUrl":"String"}],"FormMetaComments":"String","StatusCodesId":0,"SentToEmailAddress":"String","VersionNumber":0},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}