digitaluapi

InboxActionLog

The following routes are available for this service:
PUT POST	/campaign/inbox/log

import Foundation
import ServiceStack

public class InboxActionLog : Codable
{
    public var commsGuid:String
    public var campaignActionsRequestsId:Int

    required public init(){}
}

public class InboxActionResponse : Codable
{
    public var campaignAction:CampaignActions
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class CampaignActions : Codable
{
    // @DataMember(Order=1)
    // @Required()
    public var id:Int?

    // @DataMember(Order=2)
    // @Required()
    // @References(typeof(Campaigns))
    public var campaignsId:Int?

    // @DataMember(Order=3)
    // @References(typeof(Actions))
    public var actionsId:Int?

    // @DataMember(Order=4)
    public var buttonName:String

    // @DataMember(Order=5)
    // @References(typeof(ActionTypes))
    public var actionTypesId:Int?

    // @DataMember(Order=6)
    public var Description:String

    // @DataMember(Order=7)
    public var offerOrder:Int16?

    // @DataMember(Order=8)
    public var standOut:Bool?

    // @DataMember(Order=9)
    // @Required()
    public var publicAccessGuid:String?

    // @DataMember(Order=10)
    public var formMeta:[FormField]

    // @DataMember(Order=11)
    public var files:[CampaignActionFile]

    // @DataMember(Order=12)
    public var sentToEmailAddress:String

    // @DataMember(Order=13)
    public var ccEmailAddress:String

    required public init(){}
}

public class FormField : Codable
{
    public var id:Int
    public var controlType:String
    public var label:String
    public var placeholder:String
    public var help:String
    public var name:String
    public var sortOrder:Int
    public var options:[FormFieldOption]
    public var validation:[String]

    required public init(){}
}

public class FormFieldOption : Codable
{
    public var value:String
    public var label:String

    required public init(){}
}

public class CampaignActionFile : Codable
{
    public var name:String
    public var fileType:String
    public var fileSize:String
    public var `extension`:String
    public var uploadUrl:String

    required public init(){}
}

Swift 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
		}
	}
}