digitaluapi

<back to all web services

SaveCampaignActionClientForm

The following routes are available for this service:
PUT POST/campaign/inbox/form
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class SaveCampaignActionClientForm
{
    open var CommsGuid:UUID? = null
    open var CampaignActionsRequestsId:Long? = null
    open var Comments:String? = null
    open var CampaignActionFiles:ArrayList<CampaignActionFile>? = null
}

open class CampaignActionFile
{
    open var Name:String? = null
    open var FileType:String? = null
    open var FileSize:String? = null
    open var Extension:String? = null
    open var UploadUrl:String? = null
}

open class SaveCampaignActionClientFormResponse
{
    open var CampaignActionsFormResponses:CampaignActionsFormResponses? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CampaignActionsFormResponses
{
    @DataMember(Order=1)
    @Required()
    open var Id:Long? = null

    @DataMember(Order=2)
    @Required()
    @References(Type=CampaignActions::class)
    open var CampaignActionsId:Long? = null

    @DataMember(Order=3)
    @References(Type=Customers::class)
    open var CustomersId:Long? = null

    @DataMember(Order=4)
    @Required()
    @Computed()
    open var ActionTimestamp:Date? = null

    @DataMember(Order=5)
    open var FormMetaResponses:CampaignActionFormResults? = null

    @DataMember(Order=6)
    open var FormMetaCustomResponses:HashMap<String,String>? = null

    @DataMember(Order=7)
    open var CampaignInstanceCommsId:Long? = null

    @DataMember(Order=8)
    open var FormMetaFilesResponses:ArrayList<CampaignActionFile>? = null

    @DataMember(Order=9)
    open var FormMetaComments:String? = null

    @DataMember(Order=10)
    open var StatusCodesId:Int? = null

    @DataMember(Order=11)
    open var SentToEmailAddress:String? = null

    @DataMember(Order=12)
    open var VersionNumber:Int? = null
}

open class CampaignActionFormResults
{
    open var CustomFormResults:String? = null
    open var Comments:String? = null
    open var CampaignActionFiles:ArrayList<CampaignActionFile>? = null
}

Kotlin SaveCampaignActionClientForm 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.

POST /campaign/inbox/form HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
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/jsv
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
		}
	}
}