digitaluapi

<back to all web services

InboxActionLog

The following routes are available for this service:
PUT POST/campaign/inbox/log
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 FormField
    {
        public virtual int Id { get; set; }
        public virtual string ControlType { get; set; }
        public virtual string Label { get; set; }
        public virtual string Placeholder { get; set; }
        public virtual string Help { get; set; }
        public virtual string Name { get; set; }
        public virtual int SortOrder { get; set; }
        public virtual List<FormFieldOption> Options { get; set; }
        public virtual List<string> Validation { get; set; }
    }

    public partial class FormFieldOption
    {
        public virtual string Value { get; set; }
        public virtual string Label { get; set; }
    }

    public partial class InboxActionLog
    {
        public virtual Guid CommsGuid { get; set; }
        public virtual long CampaignActionsRequestsId { get; set; }
    }

    public partial class InboxActionResponse
    {
        public virtual CampaignActions campaignAction { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

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

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

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

        [DataMember(Order=4)]
        public virtual string ButtonName { get; set; }

        [DataMember(Order=5)]
        [References(typeof(digitaluapi.ServiceModel.Types.ActionTypes))]
        public virtual int? ActionTypesId { get; set; }

        [DataMember(Order=6)]
        public virtual string Description { get; set; }

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

        [DataMember(Order=8)]
        public virtual bool? StandOut { get; set; }

        [DataMember(Order=9)]
        [Required]
        public virtual Guid PublicAccessGuid { get; set; }

        [DataMember(Order=10)]
        public virtual List<FormField> FormMeta { get; set; }

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

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

        [DataMember(Order=13)]
        public virtual string CcEmailAddress { get; set; }
    }

}

C# InboxActionLog 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/log HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CommsGuid: 00000000000000000000000000000000,
	CampaignActionsRequestsId: 0
}
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
		}
	}
}