digitaluapi

<back to all web services

InboxActionLog

The following routes are available for this service:
PUT POST/campaign/inbox/log
namespace digitaluapi.ServiceModel

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FormFieldOption() = 
        member val Value:String = null with get,set
        member val Label:String = null with get,set

    [<AllowNullLiteral>]
    type FormField() = 
        member val Id:Int32 = new Int32() with get,set
        member val ControlType:String = null with get,set
        member val Label:String = null with get,set
        member val Placeholder:String = null with get,set
        member val Help:String = null with get,set
        member val Name:String = null with get,set
        member val SortOrder:Int32 = new Int32() with get,set
        member val Options:ResizeArray<FormFieldOption> = null with get,set
        member val Validation:ResizeArray<String> = null with get,set

    [<AllowNullLiteral>]
    type CampaignActionFile() = 
        member val Name:String = null with get,set
        member val FileType:String = null with get,set
        member val FileSize:String = null with get,set
        member val Extension:String = null with get,set
        member val UploadUrl:String = null with get,set

    [<AllowNullLiteral>]
    type CampaignActions() = 
        [<DataMember(Order=1)>]
        [<Required>]
        member val Id:Int64 = new Int64() with get,set

        [<DataMember(Order=2)>]
        [<Required>]
        [<References(typeof<Campaigns>)>]
        member val CampaignsId:Int64 = new Int64() with get,set

        [<DataMember(Order=3)>]
        [<References(typeof<Actions>)>]
        member val ActionsId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember(Order=4)>]
        member val ButtonName:String = null with get,set

        [<DataMember(Order=5)>]
        [<References(typeof<ActionTypes>)>]
        member val ActionTypesId:Nullable<Int32> = new Nullable<Int32>() with get,set

        [<DataMember(Order=6)>]
        member val Description:String = null with get,set

        [<DataMember(Order=7)>]
        member val OfferOrder:Nullable<Int16> = new Nullable<Int16>() with get,set

        [<DataMember(Order=8)>]
        member val StandOut:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember(Order=9)>]
        [<Required>]
        member val PublicAccessGuid:Guid = new Guid() with get,set

        [<DataMember(Order=10)>]
        member val FormMeta:ResizeArray<FormField> = null with get,set

        [<DataMember(Order=11)>]
        member val Files:ResizeArray<CampaignActionFile> = null with get,set

        [<DataMember(Order=12)>]
        member val SentToEmailAddress:String = null with get,set

        [<DataMember(Order=13)>]
        member val CcEmailAddress:String = null with get,set

    [<AllowNullLiteral>]
    type InboxActionResponse() = 
        member val campaignAction:CampaignActions = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type InboxActionLog() = 
        member val CommsGuid:Guid = new Guid() with get,set
        member val CampaignActionsRequestsId:Int64 = new Int64() with get,set

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