Trendsic Platform Service

<back to all web services

FormReadinessRequest

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

public class dtos
{

    public static class FormReadinessRequest
    {
        public UUID FormUID = null;
        
        public UUID getFormUID() { return FormUID; }
        public FormReadinessRequest setFormUID(UUID value) { this.FormUID = value; return this; }
    }

    public static class FormReadinessResponse
    {
        public ArrayList<FormReadinessCheck> Checks = new ArrayList<FormReadinessCheck>();
        public ArrayList<String> Changes = new ArrayList<String>();
        public Integer NextVersion = null;
        public Boolean IsFirstPublish = null;
        public Boolean NothingChanged = null;
        public Boolean CanPublish = null;
        public Integer DraftRev = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<FormReadinessCheck> getChecks() { return Checks; }
        public FormReadinessResponse setChecks(ArrayList<FormReadinessCheck> value) { this.Checks = value; return this; }
        public ArrayList<String> getChanges() { return Changes; }
        public FormReadinessResponse setChanges(ArrayList<String> value) { this.Changes = value; return this; }
        public Integer getNextVersion() { return NextVersion; }
        public FormReadinessResponse setNextVersion(Integer value) { this.NextVersion = value; return this; }
        public Boolean getIsFirstPublish() { return IsFirstPublish; }
        public FormReadinessResponse setIsFirstPublish(Boolean value) { this.IsFirstPublish = value; return this; }
        public Boolean isNothingChanged() { return NothingChanged; }
        public FormReadinessResponse setNothingChanged(Boolean value) { this.NothingChanged = value; return this; }
        public Boolean isCanPublish() { return CanPublish; }
        public FormReadinessResponse setCanPublish(Boolean value) { this.CanPublish = value; return this; }
        public Integer getDraftRev() { return DraftRev; }
        public FormReadinessResponse setDraftRev(Integer value) { this.DraftRev = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public FormReadinessResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class FormReadinessCheck
    {
        public String Level = null;
        public String Text = null;
        public String FixTab = null;
        public String FixFieldKey = null;
        public String FixLabel = null;
        
        public String getLevel() { return Level; }
        public FormReadinessCheck setLevel(String value) { this.Level = value; return this; }
        public String getText() { return Text; }
        public FormReadinessCheck setText(String value) { this.Text = value; return this; }
        public String getFixTab() { return FixTab; }
        public FormReadinessCheck setFixTab(String value) { this.FixTab = value; return this; }
        public String getFixFieldKey() { return FixFieldKey; }
        public FormReadinessCheck setFixFieldKey(String value) { this.FixFieldKey = value; return this; }
        public String getFixLabel() { return FixLabel; }
        public FormReadinessCheck setFixLabel(String value) { this.FixLabel = value; return this; }
    }

}

Java 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>