digitaluapi

<back to all web services

SaveCampaignActionClientForm

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

namespace digitaluapi.ServiceModel
{
    public partial class CampaignActionFile
    {
        public virtual string Name { get; set; }
        public virtual string FileType { get; set; }
        public virtual string FileSize { get; set; }
        public virtual string Extension { get; set; }
        public virtual string UploadUrl { get; set; }
    }

    public partial class CampaignActionFormResults
    {
        public virtual string CustomFormResults { get; set; }
        public virtual string Comments { get; set; }
        public virtual List<CampaignActionFile> CampaignActionFiles { get; set; }
    }

    public partial class SaveCampaignActionClientForm
    {
        public virtual Guid CommsGuid { get; set; }
        public virtual long CampaignActionsRequestsId { get; set; }
        public virtual string Comments { get; set; }
        public virtual List<CampaignActionFile> CampaignActionFiles { get; set; }
    }

    public partial class SaveCampaignActionClientFormResponse
    {
        public virtual CampaignActionsFormResponses CampaignActionsFormResponses { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace digitaluapi.ServiceModel.Types
{
    public partial class CampaignActionsFormResponses
    {
        [DataMember(Order=1)]
        [Required]
        public virtual long Id { get; set; }

        [DataMember(Order=2)]
        [Required]
        [References(typeof(digitaluapi.ServiceModel.Types.CampaignActions))]
        public virtual long CampaignActionsId { get; set; }

        [DataMember(Order=3)]
        [References(typeof(digitaluapi.ServiceModel.Types.Customers))]
        public virtual long? CustomersId { get; set; }

        [DataMember(Order=4)]
        [Required]
        [Computed]
        public virtual DateTimeOffset ActionTimestamp { get; set; }

        [DataMember(Order=5)]
        public virtual CampaignActionFormResults FormMetaResponses { get; set; }

        [DataMember(Order=6)]
        public virtual Dictionary<string, string> FormMetaCustomResponses { get; set; }

        [DataMember(Order=7)]
        public virtual long? CampaignInstanceCommsId { get; set; }

        [DataMember(Order=8)]
        public virtual List<CampaignActionFile> FormMetaFilesResponses { get; set; }

        [DataMember(Order=9)]
        public virtual string FormMetaComments { get; set; }

        [DataMember(Order=10)]
        public virtual int StatusCodesId { get; set; }

        [DataMember(Order=11)]
        public virtual string SentToEmailAddress { get; set; }

        [DataMember(Order=12)]
        public virtual int VersionNumber { get; set; }
    }

}

C# 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
		}
	}
}