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.*;

public class dtos
{

    public static class FormSubmissionNoteRequest
    {
        public UUID SubmissionUID = null;
        public String Text = null;
        
        public UUID getSubmissionUID() { return SubmissionUID; }
        public FormSubmissionNoteRequest setSubmissionUID(UUID value) { this.SubmissionUID = value; return this; }
        public String getText() { return Text; }
        public FormSubmissionNoteRequest setText(String value) { this.Text = value; return this; }
    }

    public static class FormSubmissionRecordResponse
    {
        public FormSubmissionRecord Record = null;
        public ResponseStatus ResponseStatus = null;
        
        public FormSubmissionRecord getRecord() { return Record; }
        public FormSubmissionRecordResponse setRecord(FormSubmissionRecord value) { this.Record = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public FormSubmissionRecordResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class FormSubmissionRecord
    {
        public UUID SubmissionUID = null;
        public UUID FormUID = null;
        public String FormName = null;
        public String Noun = null;
        public String Number = null;
        public String ApplicantName = null;
        public FormStageInfo Stage = null;
        public ArrayList<String> Tags = new ArrayList<String>();
        public Integer AssigneeAgentId = null;
        public String AssigneeName = null;
        public String BranchName = null;
        public Date SubmittedAt = null;
        public Integer VersionNo = null;
        public Integer CurrentVersionNo = null;
        public String Email = null;
        public String Phone = null;
        public String ContactName = null;
        public String Meta = null;
        public ArrayList<FormStageInfo> Stages = new ArrayList<FormStageInfo>();
        public ArrayList<FormStageInfo> Moves = new ArrayList<FormStageInfo>();
        public ArrayList<FormPerson> People = new ArrayList<FormPerson>();
        public Boolean CanEdit = null;
        public Boolean CanSensitive = null;
        public ArrayList<FormRecordSection> Sections = new ArrayList<FormRecordSection>();
        public ArrayList<FormRecordDoc> Docs = new ArrayList<FormRecordDoc>();
        public String DocCount = null;
        public ArrayList<FormRecordComputed> Computed = new ArrayList<FormRecordComputed>();
        public ArrayList<FormRecordEvent> Timeline = new ArrayList<FormRecordEvent>();
        public ArrayList<FormRecordEvent> Notes = new ArrayList<FormRecordEvent>();
        public ArrayList<FormRecordEvent> Audit = new ArrayList<FormRecordEvent>();
        
        public UUID getSubmissionUID() { return SubmissionUID; }
        public FormSubmissionRecord setSubmissionUID(UUID value) { this.SubmissionUID = value; return this; }
        public UUID getFormUID() { return FormUID; }
        public FormSubmissionRecord setFormUID(UUID value) { this.FormUID = value; return this; }
        public String getFormName() { return FormName; }
        public FormSubmissionRecord setFormName(String value) { this.FormName = value; return this; }
        public String getNoun() { return Noun; }
        public FormSubmissionRecord setNoun(String value) { this.Noun = value; return this; }
        public String getNumber() { return Number; }
        public FormSubmissionRecord setNumber(String value) { this.Number = value; return this; }
        public String getApplicantName() { return ApplicantName; }
        public FormSubmissionRecord setApplicantName(String value) { this.ApplicantName = value; return this; }
        public FormStageInfo getStage() { return Stage; }
        public FormSubmissionRecord setStage(FormStageInfo value) { this.Stage = value; return this; }
        public ArrayList<String> getTags() { return Tags; }
        public FormSubmissionRecord setTags(ArrayList<String> value) { this.Tags = value; return this; }
        public Integer getAssigneeAgentId() { return AssigneeAgentId; }
        public FormSubmissionRecord setAssigneeAgentId(Integer value) { this.AssigneeAgentId = value; return this; }
        public String getAssigneeName() { return AssigneeName; }
        public FormSubmissionRecord setAssigneeName(String value) { this.AssigneeName = value; return this; }
        public String getBranchName() { return BranchName; }
        public FormSubmissionRecord setBranchName(String value) { this.BranchName = value; return this; }
        public Date getSubmittedAt() { return SubmittedAt; }
        public FormSubmissionRecord setSubmittedAt(Date value) { this.SubmittedAt = value; return this; }
        public Integer getVersionNo() { return VersionNo; }
        public FormSubmissionRecord setVersionNo(Integer value) { this.VersionNo = value; return this; }
        public Integer getCurrentVersionNo() { return CurrentVersionNo; }
        public FormSubmissionRecord setCurrentVersionNo(Integer value) { this.CurrentVersionNo = value; return this; }
        public String getEmail() { return Email; }
        public FormSubmissionRecord setEmail(String value) { this.Email = value; return this; }
        public String getPhone() { return Phone; }
        public FormSubmissionRecord setPhone(String value) { this.Phone = value; return this; }
        public String getContactName() { return ContactName; }
        public FormSubmissionRecord setContactName(String value) { this.ContactName = value; return this; }
        public String getMeta() { return Meta; }
        public FormSubmissionRecord setMeta(String value) { this.Meta = value; return this; }
        public ArrayList<FormStageInfo> getStages() { return Stages; }
        public FormSubmissionRecord setStages(ArrayList<FormStageInfo> value) { this.Stages = value; return this; }
        public ArrayList<FormStageInfo> getMoves() { return Moves; }
        public FormSubmissionRecord setMoves(ArrayList<FormStageInfo> value) { this.Moves = value; return this; }
        public ArrayList<FormPerson> getPeople() { return People; }
        public FormSubmissionRecord setPeople(ArrayList<FormPerson> value) { this.People = value; return this; }
        public Boolean isCanEdit() { return CanEdit; }
        public FormSubmissionRecord setCanEdit(Boolean value) { this.CanEdit = value; return this; }
        public Boolean isCanSensitive() { return CanSensitive; }
        public FormSubmissionRecord setCanSensitive(Boolean value) { this.CanSensitive = value; return this; }
        public ArrayList<FormRecordSection> getSections() { return Sections; }
        public FormSubmissionRecord setSections(ArrayList<FormRecordSection> value) { this.Sections = value; return this; }
        public ArrayList<FormRecordDoc> getDocs() { return Docs; }
        public FormSubmissionRecord setDocs(ArrayList<FormRecordDoc> value) { this.Docs = value; return this; }
        public String getDocCount() { return DocCount; }
        public FormSubmissionRecord setDocCount(String value) { this.DocCount = value; return this; }
        public ArrayList<FormRecordComputed> getComputed() { return Computed; }
        public FormSubmissionRecord setComputed(ArrayList<FormRecordComputed> value) { this.Computed = value; return this; }
        public ArrayList<FormRecordEvent> getTimeline() { return Timeline; }
        public FormSubmissionRecord setTimeline(ArrayList<FormRecordEvent> value) { this.Timeline = value; return this; }
        public ArrayList<FormRecordEvent> getNotes() { return Notes; }
        public FormSubmissionRecord setNotes(ArrayList<FormRecordEvent> value) { this.Notes = value; return this; }
        public ArrayList<FormRecordEvent> getAudit() { return Audit; }
        public FormSubmissionRecord setAudit(ArrayList<FormRecordEvent> value) { this.Audit = value; return this; }
    }

    public static class FormStageInfo
    {
        public String Id = null;
        public String Label = null;
        public String Tone = null;
        public String Kind = null;
        
        public String getId() { return Id; }
        public FormStageInfo setId(String value) { this.Id = value; return this; }
        public String getLabel() { return Label; }
        public FormStageInfo setLabel(String value) { this.Label = value; return this; }
        public String getTone() { return Tone; }
        public FormStageInfo setTone(String value) { this.Tone = value; return this; }
        public String getKind() { return Kind; }
        public FormStageInfo setKind(String value) { this.Kind = value; return this; }
    }

    public static class FormPerson
    {
        public Integer AgentId = null;
        public String AgentName = null;
        
        public Integer getAgentId() { return AgentId; }
        public FormPerson setAgentId(Integer value) { this.AgentId = value; return this; }
        public String getAgentName() { return AgentName; }
        public FormPerson setAgentName(String value) { this.AgentName = value; return this; }
    }

    public static class FormRecordSection
    {
        public String Title = null;
        public ArrayList<FormRecordRow> Rows = new ArrayList<FormRecordRow>();
        
        public String getTitle() { return Title; }
        public FormRecordSection setTitle(String value) { this.Title = value; return this; }
        public ArrayList<FormRecordRow> getRows() { return Rows; }
        public FormRecordSection setRows(ArrayList<FormRecordRow> value) { this.Rows = value; return this; }
    }

    public static class FormRecordRow
    {
        public String K = null;
        public String L = null;
        public String T = null;
        public String Kind = null;
        public String V = null;
        public Boolean Sensitive = null;
        public Boolean CanReveal = null;
        public Boolean Locked = null;
        public ArrayList<FormRecordFile> Files = new ArrayList<FormRecordFile>();
        public Boolean NoFiles = null;
        public FormRecordSig Sig = null;
        
        public String getK() { return K; }
        public FormRecordRow setK(String value) { this.K = value; return this; }
        public String getL() { return L; }
        public FormRecordRow setL(String value) { this.L = value; return this; }
        public String getT() { return T; }
        public FormRecordRow setT(String value) { this.T = value; return this; }
        public String getKind() { return Kind; }
        public FormRecordRow setKind(String value) { this.Kind = value; return this; }
        public String getV() { return V; }
        public FormRecordRow setV(String value) { this.V = value; return this; }
        public Boolean isSensitive() { return Sensitive; }
        public FormRecordRow setSensitive(Boolean value) { this.Sensitive = value; return this; }
        public Boolean isCanReveal() { return CanReveal; }
        public FormRecordRow setCanReveal(Boolean value) { this.CanReveal = value; return this; }
        public Boolean isLocked() { return Locked; }
        public FormRecordRow setLocked(Boolean value) { this.Locked = value; return this; }
        public ArrayList<FormRecordFile> getFiles() { return Files; }
        public FormRecordRow setFiles(ArrayList<FormRecordFile> value) { this.Files = value; return this; }
        public Boolean isNoFiles() { return NoFiles; }
        public FormRecordRow setNoFiles(Boolean value) { this.NoFiles = value; return this; }
        public FormRecordSig getSig() { return Sig; }
        public FormRecordRow setSig(FormRecordSig value) { this.Sig = value; return this; }
    }

    public static class FormRecordFile
    {
        public UUID AttachmentId = null;
        public String Name = null;
        public String Kind = null;
        public String Size = null;
        public Boolean Sensitive = null;
        public Boolean Locked = null;
        
        public UUID getAttachmentId() { return AttachmentId; }
        public FormRecordFile setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public String getName() { return Name; }
        public FormRecordFile setName(String value) { this.Name = value; return this; }
        public String getKind() { return Kind; }
        public FormRecordFile setKind(String value) { this.Kind = value; return this; }
        public String getSize() { return Size; }
        public FormRecordFile setSize(String value) { this.Size = value; return this; }
        public Boolean isSensitive() { return Sensitive; }
        public FormRecordFile setSensitive(Boolean value) { this.Sensitive = value; return this; }
        public Boolean isLocked() { return Locked; }
        public FormRecordFile setLocked(Boolean value) { this.Locked = value; return this; }
    }

    public static class FormRecordSig
    {
        public Boolean Pending = null;
        public String Mode = null;
        public String SignerName = null;
        public String Role = null;
        public Integer RecordId = null;
        public String ImageHash = null;
        public String DocumentDigest = null;
        public String Ip = null;
        public String Browser = null;
        public Boolean ConsentStored = null;
        public String SignedText = null;
        public Boolean HasImage = null;
        
        public Boolean isPending() { return Pending; }
        public FormRecordSig setPending(Boolean value) { this.Pending = value; return this; }
        public String getMode() { return Mode; }
        public FormRecordSig setMode(String value) { this.Mode = value; return this; }
        public String getSignerName() { return SignerName; }
        public FormRecordSig setSignerName(String value) { this.SignerName = value; return this; }
        public String getRole() { return Role; }
        public FormRecordSig setRole(String value) { this.Role = value; return this; }
        public Integer getRecordId() { return RecordId; }
        public FormRecordSig setRecordId(Integer value) { this.RecordId = value; return this; }
        public String getImageHash() { return ImageHash; }
        public FormRecordSig setImageHash(String value) { this.ImageHash = value; return this; }
        public String getDocumentDigest() { return DocumentDigest; }
        public FormRecordSig setDocumentDigest(String value) { this.DocumentDigest = value; return this; }
        public String getIp() { return Ip; }
        public FormRecordSig setIp(String value) { this.Ip = value; return this; }
        public String getBrowser() { return Browser; }
        public FormRecordSig setBrowser(String value) { this.Browser = value; return this; }
        public Boolean isConsentStored() { return ConsentStored; }
        public FormRecordSig setConsentStored(Boolean value) { this.ConsentStored = value; return this; }
        public String getSignedText() { return SignedText; }
        public FormRecordSig setSignedText(String value) { this.SignedText = value; return this; }
        public Boolean isHasImage() { return HasImage; }
        public FormRecordSig setHasImage(Boolean value) { this.HasImage = value; return this; }
    }

    public static class FormRecordDoc
    {
        public String Name = null;
        public Boolean Ok = null;
        public String Tag = null;
        public String Tone = null;
        
        public String getName() { return Name; }
        public FormRecordDoc setName(String value) { this.Name = value; return this; }
        public Boolean isOk() { return Ok; }
        public FormRecordDoc setOk(Boolean value) { this.Ok = value; return this; }
        public String getTag() { return Tag; }
        public FormRecordDoc setTag(String value) { this.Tag = value; return this; }
        public String getTone() { return Tone; }
        public FormRecordDoc setTone(String value) { this.Tone = value; return this; }
    }

    public static class FormRecordComputed
    {
        public String L = null;
        public String V = null;
        
        public String getL() { return L; }
        public FormRecordComputed setL(String value) { this.L = value; return this; }
        public String getV() { return V; }
        public FormRecordComputed setV(String value) { this.V = value; return this; }
    }

    public static class FormRecordEvent
    {
        public String Who = null;
        public String X = null;
        public String T = null;
        public Date At = null;
        public String Dot = null;
        
        public String getWho() { return Who; }
        public FormRecordEvent setWho(String value) { this.Who = value; return this; }
        public String getX() { return X; }
        public FormRecordEvent setX(String value) { this.X = value; return this; }
        public String getT() { return T; }
        public FormRecordEvent setT(String value) { this.T = value; return this; }
        public Date getAt() { return At; }
        public FormRecordEvent setAt(Date value) { this.At = value; return this; }
        public String getDot() { return Dot; }
        public FormRecordEvent setDot(String value) { this.Dot = value; return this; }
    }

}

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