digitaluapi

<back to all web services

SaveCampaignActionClientForm

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

export class CampaignActionFile
{
    public Name: string;
    public FileType: string;
    public FileSize: string;
    public Extension: string;
    public UploadUrl: string;

    public constructor(init?: Partial<CampaignActionFile>) { (Object as any).assign(this, init); }
}

export class CampaignActionFormResults
{
    public CustomFormResults: string;
    public Comments: string;
    public CampaignActionFiles: CampaignActionFile[];

    public constructor(init?: Partial<CampaignActionFormResults>) { (Object as any).assign(this, init); }
}

export class CampaignActionsFormResponses
{
    // @DataMember(Order=1)
    // @Required()
    public Id: number;

    // @DataMember(Order=2)
    // @Required()
    // @References("typeof(digitaluapi.ServiceModel.Types.CampaignActions)")
    public CampaignActionsId: number;

    // @DataMember(Order=3)
    // @References("typeof(digitaluapi.ServiceModel.Types.Customers)")
    public CustomersId?: number;

    // @DataMember(Order=4)
    // @Required()
    // @Computed()
    public ActionTimestamp: string;

    // @DataMember(Order=5)
    public FormMetaResponses: CampaignActionFormResults;

    // @DataMember(Order=6)
    public FormMetaCustomResponses: { [index:string]: string; };

    // @DataMember(Order=7)
    public CampaignInstanceCommsId?: number;

    // @DataMember(Order=8)
    public FormMetaFilesResponses: CampaignActionFile[];

    // @DataMember(Order=9)
    public FormMetaComments: string;

    // @DataMember(Order=10)
    public StatusCodesId: number;

    // @DataMember(Order=11)
    public SentToEmailAddress: string;

    // @DataMember(Order=12)
    public VersionNumber: number;

    public constructor(init?: Partial<CampaignActionsFormResponses>) { (Object as any).assign(this, init); }
}

export class SaveCampaignActionClientFormResponse
{
    public CampaignActionsFormResponses: CampaignActionsFormResponses;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<SaveCampaignActionClientFormResponse>) { (Object as any).assign(this, init); }
}

export class SaveCampaignActionClientForm
{
    public CommsGuid: string;
    public CampaignActionsRequestsId: number;
    public Comments: string;
    public CampaignActionFiles: CampaignActionFile[];

    public constructor(init?: Partial<SaveCampaignActionClientForm>) { (Object as any).assign(this, init); }
}

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