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
namespace CRM.AgencyPlatform.API.Internal

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

    [<AllowNullLiteral>]
    type FormSubmissionExportPreviewResponse() = 
        member val Rows:Int32 = new Int32() with get,set
        member val Cap:Int32 = new Int32() with get,set
        member val FormName:String = null with get,set
        member val CanExport:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type FormAnswerCond() = 
        member val F:String = null with get,set
        member val Op:String = null with get,set
        member val V:String = null with get,set

    [<AllowNullLiteral>]
    type FormSubmissionSearchRequest() = 
        member val FormUID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Mode:String = null with get,set
        member val Forms:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
        member val Stages:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Assignees:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val Branches:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Search:String = null with get,set
        member val SortKey:String = null with get,set
        member val SortDir:Int32 = new Int32() with get,set
        member val Skip:Int32 = new Int32() with get,set
        member val Take:Int32 = new Int32() with get,set
        member val Conds:ResizeArray<FormAnswerCond> = new ResizeArray<FormAnswerCond>() with get,set
        member val Flags:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type FormSubmissionExportPreviewRequest() = 
        member val Query:FormSubmissionSearchRequest = null with get,set
        member val SubmissionUIDs:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set

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