digitaluapi

<back to all web services

GetCampaignActionClientForm

The following routes are available for this service:
GET/campaign/inbox/formmeta
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 FormField
            Public Overridable Property Id As Integer
            Public Overridable Property ControlType As String
            Public Overridable Property Label As String
            Public Overridable Property Placeholder As String
            Public Overridable Property Help As String
            Public Overridable Property Name As String
            Public Overridable Property SortOrder As Integer
            Public Overridable Property Options As List(Of FormFieldOption)
            Public Overridable Property Validation As List(Of String)
        End Class

        Public Partial Class FormFieldOption
            Public Overridable Property Value As String
            Public Overridable Property Label As String
        End Class

        Public Partial Class GetCampaignActionClientForm
            Public Overridable Property CommsGuid As Guid
            Public Overridable Property CampaignActionsRequestsId As Long
        End Class

        Public Partial Class InboxActionResponse
            Public Overridable Property campaignAction As CampaignActions
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace digitaluapi.ServiceModel.Types

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

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

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

            <DataMember(Order:=4)>
            Public Overridable Property ButtonName As String

            <DataMember(Order:=5)>
            <References(GetType(ActionTypes))>
            Public Overridable Property ActionTypesId As Integer?

            <DataMember(Order:=6)>
            Public Overridable Property Description As String

            <DataMember(Order:=7)>
            Public Overridable Property OfferOrder As Short?

            <DataMember(Order:=8)>
            Public Overridable Property StandOut As Boolean?

            <DataMember(Order:=9)>
            <Required>
            Public Overridable Property PublicAccessGuid As Guid

            <DataMember(Order:=10)>
            Public Overridable Property FormMeta As List(Of FormField)

            <DataMember(Order:=11)>
            Public Overridable Property Files As List(Of CampaignActionFile)

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

            <DataMember(Order:=13)>
            Public Overridable Property CcEmailAddress As String
        End Class
    End Namespace
End Namespace

VB.NET GetCampaignActionClientForm DTOs

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

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /campaign/inbox/formmeta HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	campaignAction: 
	{
		Id: 0,
		CampaignsId: 0,
		ActionsId: 0,
		ButtonName: String,
		ActionTypesId: 0,
		Description: String,
		OfferOrder: 0,
		StandOut: False,
		PublicAccessGuid: 00000000000000000000000000000000,
		FormMeta: 
		[
			{
				Id: 0,
				ControlType: String,
				Label: String,
				Placeholder: String,
				Help: String,
				Name: String,
				SortOrder: 0,
				Options: 
				[
					{
						Value: String,
						Label: String
					}
				],
				Validation: 
				[
					String
				]
			}
		],
		Files: 
		[
			{
				Name: String,
				FileType: String,
				FileSize: String,
				Extension: String,
				UploadUrl: String
			}
		],
		SentToEmailAddress: String,
		CcEmailAddress: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}