Trendsic Platform Service

<back to all web services

FormSubmissionExportPreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/export/preview
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class FormAnswerCond
    {
        public virtual string F { get; set; }
        public virtual string Op { get; set; }
        public virtual string V { get; set; }
    }

    public partial class FormSubmissionExportPreviewRequest
    {
        public virtual FormSubmissionSearchRequest Query { get; set; }
        public virtual List<Guid> SubmissionUIDs { get; set; } = [];
    }

    public partial class FormSubmissionExportPreviewResponse
    {
        public virtual int Rows { get; set; }
        public virtual int Cap { get; set; }
        public virtual string FormName { get; set; }
        public virtual bool CanExport { get; set; }
        public virtual string Message { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class FormSubmissionSearchRequest
    {
        public virtual Guid? FormUID { get; set; }
        public virtual string Mode { get; set; }
        public virtual List<Guid> Forms { get; set; } = [];
        public virtual List<string> Stages { get; set; } = [];
        public virtual List<int> Assignees { get; set; } = [];
        public virtual List<string> Branches { get; set; } = [];
        public virtual List<string> Tags { get; set; } = [];
        public virtual string Search { get; set; }
        public virtual string SortKey { get; set; }
        public virtual int SortDir { get; set; }
        public virtual int Skip { get; set; }
        public virtual int Take { get; set; }
        public virtual List<FormAnswerCond> Conds { get; set; } = [];
        public virtual List<string> Flags { get; set; } = [];
    }

}

C# FormSubmissionExportPreviewRequest 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 /v1/forms/submissions/export/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Query: 
	{
		FormUID: 00000000000000000000000000000000,
		Mode: String,
		Forms: 
		[
			00000000000000000000000000000000
		],
		Stages: 
		[
			String
		],
		Assignees: 
		[
			0
		],
		Branches: 
		[
			String
		],
		Tags: 
		[
			String
		],
		Search: String,
		SortKey: String,
		SortDir: 0,
		Skip: 0,
		Take: 0,
		Conds: 
		[
			{
				F: String,
				Op: String,
				V: String
			}
		],
		Flags: 
		[
			String
		]
	},
	SubmissionUIDs: 
	[
		00000000000000000000000000000000
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Rows: 0,
	Cap: 0,
	FormName: String,
	CanExport: False,
	Message: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}