Trendsic Platform Service

<back to all web services

FormStartersRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/starters
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 FormStarter() = 
        member val TemplateUID:Guid = new Guid() with get,set
        member val Name: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 Pack:String = null with get,set
        member val PackName:String = null with get,set
        member val IsTenantTemplate:Boolean = new Boolean() with get,set
        member val PayloadJson:String = null with get,set

    [<AllowNullLiteral>]
    type FormStartersResponse() = 
        member val Starters:ResizeArray<FormStarter> = new ResizeArray<FormStarter>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

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

F# FormStartersRequest 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/starters HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormStartersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Starters>
    <FormStarter>
      <Description>String</Description>
      <IsTenantTemplate>false</IsTenantTemplate>
      <Name>String</Name>
      <Noun>String</Noun>
      <NumberPrefix>String</NumberPrefix>
      <Pack>String</Pack>
      <PackName>String</PackName>
      <PayloadJson>String</PayloadJson>
      <TemplateUID>00000000-0000-0000-0000-000000000000</TemplateUID>
    </FormStarter>
  </Starters>
</FormStartersResponse>