Trendsic Platform Service

<back to all web services

FormSubmissionNoteRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/{SubmissionUID}/notes
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class FormSubmissionNoteRequest
{
    open var SubmissionUID:UUID? = null
    open var Text:String? = null
}

open class FormSubmissionRecordResponse
{
    open var Record:FormSubmissionRecord? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class FormSubmissionRecord
{
    open var SubmissionUID:UUID? = null
    open var FormUID:UUID? = null
    open var FormName:String? = null
    open var Noun:String? = null
    open var Number:String? = null
    open var ApplicantName:String? = null
    open var Stage:FormStageInfo? = null
    open var Tags:ArrayList<String> = ArrayList<String>()
    open var AssigneeAgentId:Int? = null
    open var AssigneeName:String? = null
    open var BranchName:String? = null
    open var SubmittedAt:Date? = null
    open var VersionNo:Int? = null
    open var CurrentVersionNo:Int? = null
    open var Email:String? = null
    open var Phone:String? = null
    open var ContactName:String? = null
    open var Meta:String? = null
    open var Stages:ArrayList<FormStageInfo> = ArrayList<FormStageInfo>()
    open var Moves:ArrayList<FormStageInfo> = ArrayList<FormStageInfo>()
    open var People:ArrayList<FormPerson> = ArrayList<FormPerson>()
    open var CanEdit:Boolean? = null
    open var CanSensitive:Boolean? = null
    open var Sections:ArrayList<FormRecordSection> = ArrayList<FormRecordSection>()
    open var Docs:ArrayList<FormRecordDoc> = ArrayList<FormRecordDoc>()
    open var DocCount:String? = null
    open var Computed:ArrayList<FormRecordComputed> = ArrayList<FormRecordComputed>()
    open var Timeline:ArrayList<FormRecordEvent> = ArrayList<FormRecordEvent>()
    open var Notes:ArrayList<FormRecordEvent> = ArrayList<FormRecordEvent>()
    open var Audit:ArrayList<FormRecordEvent> = ArrayList<FormRecordEvent>()
}

open class FormStageInfo
{
    open var Id:String? = null
    open var Label:String? = null
    open var Tone:String? = null
    open var Kind:String? = null
}

open class FormPerson
{
    open var AgentId:Int? = null
    open var AgentName:String? = null
}

open class FormRecordSection
{
    open var Title:String? = null
    open var Rows:ArrayList<FormRecordRow> = ArrayList<FormRecordRow>()
}

open class FormRecordRow
{
    open var K:String? = null
    open var L:String? = null
    open var T:String? = null
    open var Kind:String? = null
    open var V:String? = null
    open var Sensitive:Boolean? = null
    open var CanReveal:Boolean? = null
    open var Locked:Boolean? = null
    open var Files:ArrayList<FormRecordFile> = ArrayList<FormRecordFile>()
    open var NoFiles:Boolean? = null
    open var Sig:FormRecordSig? = null
}

open class FormRecordFile
{
    open var AttachmentId:UUID? = null
    open var Name:String? = null
    open var Kind:String? = null
    open var Size:String? = null
    open var Sensitive:Boolean? = null
    open var Locked:Boolean? = null
}

open class FormRecordSig
{
    open var Pending:Boolean? = null
    open var Mode:String? = null
    open var SignerName:String? = null
    open var Role:String? = null
    open var RecordId:Int? = null
    open var ImageHash:String? = null
    open var DocumentDigest:String? = null
    open var Ip:String? = null
    open var Browser:String? = null
    open var ConsentStored:Boolean? = null
    open var SignedText:String? = null
    open var HasImage:Boolean? = null
}

open class FormRecordDoc
{
    open var Name:String? = null
    open var Ok:Boolean? = null
    open var Tag:String? = null
    open var Tone:String? = null
}

open class FormRecordComputed
{
    open var L:String? = null
    open var V:String? = null
}

open class FormRecordEvent
{
    open var Who:String? = null
    open var X:String? = null
    open var T:String? = null
    open var At:Date? = null
    open var Dot:String? = null
}

Kotlin FormSubmissionNoteRequest 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.

POST /v1/forms/submissions/{SubmissionUID}/notes HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormSubmissionNoteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
  <Text>String</Text>
</FormSubmissionNoteRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormSubmissionRecordResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Record>
    <ApplicantName>String</ApplicantName>
    <AssigneeAgentId>0</AssigneeAgentId>
    <AssigneeName>String</AssigneeName>
    <Audit>
      <FormRecordEvent>
        <At>0001-01-01T00:00:00</At>
        <Dot>String</Dot>
        <T>String</T>
        <Who>String</Who>
        <X>String</X>
      </FormRecordEvent>
    </Audit>
    <BranchName>String</BranchName>
    <CanEdit>false</CanEdit>
    <CanSensitive>false</CanSensitive>
    <Computed>
      <FormRecordComputed>
        <L>String</L>
        <V>String</V>
      </FormRecordComputed>
    </Computed>
    <ContactName>String</ContactName>
    <CurrentVersionNo>0</CurrentVersionNo>
    <DocCount>String</DocCount>
    <Docs>
      <FormRecordDoc>
        <Name>String</Name>
        <Ok>false</Ok>
        <Tag>String</Tag>
        <Tone>String</Tone>
      </FormRecordDoc>
    </Docs>
    <Email>String</Email>
    <FormName>String</FormName>
    <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
    <Meta>String</Meta>
    <Moves>
      <FormStageInfo>
        <Id>String</Id>
        <Kind>String</Kind>
        <Label>String</Label>
        <Tone>String</Tone>
      </FormStageInfo>
    </Moves>
    <Notes>
      <FormRecordEvent>
        <At>0001-01-01T00:00:00</At>
        <Dot>String</Dot>
        <T>String</T>
        <Who>String</Who>
        <X>String</X>
      </FormRecordEvent>
    </Notes>
    <Noun>String</Noun>
    <Number>String</Number>
    <People>
      <FormPerson>
        <AgentId>0</AgentId>
        <AgentName>String</AgentName>
      </FormPerson>
    </People>
    <Phone>String</Phone>
    <Sections>
      <FormRecordSection>
        <Rows>
          <FormRecordRow>
            <CanReveal>false</CanReveal>
            <Files>
              <FormRecordFile>
                <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
                <Kind>String</Kind>
                <Locked>false</Locked>
                <Name>String</Name>
                <Sensitive>false</Sensitive>
                <Size>String</Size>
              </FormRecordFile>
            </Files>
            <K>String</K>
            <Kind>String</Kind>
            <L>String</L>
            <Locked>false</Locked>
            <NoFiles>false</NoFiles>
            <Sensitive>false</Sensitive>
            <Sig>
              <Browser>String</Browser>
              <ConsentStored>false</ConsentStored>
              <DocumentDigest>String</DocumentDigest>
              <HasImage>false</HasImage>
              <ImageHash>String</ImageHash>
              <Ip>String</Ip>
              <Mode>String</Mode>
              <Pending>false</Pending>
              <RecordId>0</RecordId>
              <Role>String</Role>
              <SignedText>String</SignedText>
              <SignerName>String</SignerName>
            </Sig>
            <T>String</T>
            <V>String</V>
          </FormRecordRow>
        </Rows>
        <Title>String</Title>
      </FormRecordSection>
    </Sections>
    <Stage>
      <Id>String</Id>
      <Kind>String</Kind>
      <Label>String</Label>
      <Tone>String</Tone>
    </Stage>
    <Stages>
      <FormStageInfo>
        <Id>String</Id>
        <Kind>String</Kind>
        <Label>String</Label>
        <Tone>String</Tone>
      </FormStageInfo>
    </Stages>
    <SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
    <SubmittedAt>0001-01-01T00:00:00</SubmittedAt>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Tags>
    <Timeline>
      <FormRecordEvent>
        <At>0001-01-01T00:00:00</At>
        <Dot>String</Dot>
        <T>String</T>
        <Who>String</Who>
        <X>String</X>
      </FormRecordEvent>
    </Timeline>
    <VersionNo>0</VersionNo>
  </Record>
  <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>
</FormSubmissionRecordResponse>