Trendsic Platform Service

<back to all web services

FormListRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms
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 FormStats() = 
        member val Total:Int32 = new Int32() with get,set
        member val NeedDecision:Int32 = new Int32() with get,set
        member val Waiting:Int32 = new Int32() with get,set
        member val Overdue:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type FormCard() = 
        member val FormUID:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Slug:String = null with get,set
        member val Noun:String = null with get,set
        member val NumberPrefix:String = null with get,set
        member val Description:String = null with get,set
        member val Tone:String = null with get,set
        member val Status:String = null with get,set
        member val PublishedVersionNo:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PublishedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val PublishedBy:String = null with get,set
        member val DraftDirty:Boolean = new Boolean() with get,set
        member val DraftUpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DraftUpdatedBy:String = null with get,set
        member val PackLabel:String = null with get,set
        member val SettingsJson:String = null with get,set
        member val Stats:FormStats = null with get,set
        member val Offered:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type FormListResponse() = 
        member val Forms:ResizeArray<FormCard> = new ResizeArray<FormCard>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type FormListRequest() = 
        class end

F# FormListRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","PublishedBy":"String","DraftDirty":false,"DraftUpdatedAt":"0001-01-01T00:00:00.0000000","DraftUpdatedBy":"String","PackLabel":"String","SettingsJson":"String","Stats":{"Total":0,"NeedDecision":0,"Waiting":0,"Overdue":0},"Offered":["String"],"CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}