Trendsic Platform Service

<back to all web services

FormReadinessRequest

Requires Authentication
The following routes are available for this service:
GET/v1/forms/{FormUID}/readiness
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 FormReadinessCheck() = 
        member val Level:String = null with get,set
        member val Text:String = null with get,set
        member val FixTab:String = null with get,set
        member val FixFieldKey:String = null with get,set
        member val FixLabel:String = null with get,set

    [<AllowNullLiteral>]
    type FormReadinessResponse() = 
        member val Checks:ResizeArray<FormReadinessCheck> = new ResizeArray<FormReadinessCheck>() with get,set
        member val Changes:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val NextVersion:Int32 = new Int32() with get,set
        member val IsFirstPublish:Boolean = new Boolean() with get,set
        member val NothingChanged:Boolean = new Boolean() with get,set
        member val CanPublish:Boolean = new Boolean() with get,set
        member val DraftRev:Int32 = new Int32() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type FormReadinessRequest() = 
        member val FormUID:Guid = new Guid() with get,set

F# FormReadinessRequest 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/{FormUID}/readiness HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormReadinessResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CanPublish>false</CanPublish>
  <Changes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Changes>
  <Checks>
    <FormReadinessCheck>
      <FixFieldKey>String</FixFieldKey>
      <FixLabel>String</FixLabel>
      <FixTab>String</FixTab>
      <Level>String</Level>
      <Text>String</Text>
    </FormReadinessCheck>
  </Checks>
  <DraftRev>0</DraftRev>
  <IsFirstPublish>false</IsFirstPublish>
  <NextVersion>0</NextVersion>
  <NothingChanged>false</NothingChanged>
  <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>
</FormReadinessResponse>