Trendsic Platform Service

<back to all web services

FormListRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class FormListRequest
{
}

open class FormListResponse
{
    open var Forms:ArrayList<FormCard> = ArrayList<FormCard>()
    open var ResponseStatus:ResponseStatus? = null
}

open class FormCard
{
    open var FormUID:UUID? = null
    open var Name:String? = null
    open var Slug:String? = null
    open var Noun:String? = null
    open var NumberPrefix:String? = null
    open var Description:String? = null
    open var Tone:String? = null
    open var Status:String? = null
    open var PublishedVersionNo:Int? = null
    open var PublishedAt:Date? = null
    open var PublishedBy:String? = null
    open var DraftDirty:Boolean? = null
    open var DraftUpdatedAt:Date? = null
    open var DraftUpdatedBy:String? = null
    open var PackLabel:String? = null
    open var SettingsJson:String? = null
    open var Stats:FormStats? = null
    open var Offered:ArrayList<String> = ArrayList<String>()
    open var CreatedBy:String? = null
    open var CreatedAt:Date? = null
    open var UpdatedAt:Date? = null
}

open class FormStats
{
    open var Total:Int? = null
    open var NeedDecision:Int? = null
    open var Waiting:Int? = null
    open var Overdue:Int? = null
}

Kotlin FormListRequest 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.

GET /v1/forms HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Forms: 
	[
		{
			FormUID: 00000000000000000000000000000000,
			Name: String,
			Slug: String,
			Noun: String,
			NumberPrefix: String,
			Description: String,
			Tone: String,
			Status: String,
			PublishedVersionNo: 0,
			PublishedAt: 0001-01-01,
			PublishedBy: String,
			DraftDirty: False,
			DraftUpdatedAt: 0001-01-01,
			DraftUpdatedBy: String,
			PackLabel: String,
			SettingsJson: String,
			Stats: 
			{
				Total: 0,
				NeedDecision: 0,
				Waiting: 0,
				Overdue: 0
			},
			Offered: 
			[
				String
			],
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			UpdatedAt: 0001-01-01
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}