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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Forms>
    <FormCard>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <Description>String</Description>
      <DraftDirty>false</DraftDirty>
      <DraftUpdatedAt>0001-01-01T00:00:00</DraftUpdatedAt>
      <DraftUpdatedBy>String</DraftUpdatedBy>
      <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
      <Name>String</Name>
      <Noun>String</Noun>
      <NumberPrefix>String</NumberPrefix>
      <Offered xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Offered>
      <PackLabel>String</PackLabel>
      <PublishedAt>0001-01-01T00:00:00</PublishedAt>
      <PublishedBy>String</PublishedBy>
      <PublishedVersionNo>0</PublishedVersionNo>
      <SettingsJson>String</SettingsJson>
      <Slug>String</Slug>
      <Stats>
        <NeedDecision>0</NeedDecision>
        <Overdue>0</Overdue>
        <Total>0</Total>
        <Waiting>0</Waiting>
      </Stats>
      <Status>String</Status>
      <Tone>String</Tone>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    </FormCard>
  </Forms>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</FormListResponse>