| GET | /v1/forms/submissions/{SubmissionUID} |
|---|
export class FormStageInfo
{
public Id: string;
public Label: string;
public Tone: string;
public Kind: string;
public constructor(init?: Partial<FormStageInfo>) { (Object as any).assign(this, init); }
}
export class FormPerson
{
public AgentId: number;
public AgentName: string;
public constructor(init?: Partial<FormPerson>) { (Object as any).assign(this, init); }
}
export class FormRecordFile
{
public AttachmentId: string;
public Name: string;
public Kind: string;
public Size: string;
public Sensitive: boolean;
public Locked: boolean;
public constructor(init?: Partial<FormRecordFile>) { (Object as any).assign(this, init); }
}
export class FormRecordSig
{
public Pending: boolean;
public Mode: string;
public SignerName: string;
public Role: string;
public RecordId: number;
public ImageHash: string;
public DocumentDigest: string;
public Ip: string;
public Browser: string;
public ConsentStored: boolean;
public SignedText: string;
public HasImage: boolean;
public constructor(init?: Partial<FormRecordSig>) { (Object as any).assign(this, init); }
}
export class FormRecordRow
{
public K: string;
public L: string;
public T: string;
public Kind: string;
public V: string;
public Sensitive: boolean;
public CanReveal: boolean;
public Locked: boolean;
public Files: FormRecordFile[] = [];
public NoFiles: boolean;
public Sig: FormRecordSig;
public constructor(init?: Partial<FormRecordRow>) { (Object as any).assign(this, init); }
}
export class FormRecordSection
{
public Title: string;
public Rows: FormRecordRow[] = [];
public constructor(init?: Partial<FormRecordSection>) { (Object as any).assign(this, init); }
}
export class FormRecordDoc
{
public Name: string;
public Ok: boolean;
public Tag: string;
public Tone: string;
public constructor(init?: Partial<FormRecordDoc>) { (Object as any).assign(this, init); }
}
export class FormRecordComputed
{
public L: string;
public V: string;
public constructor(init?: Partial<FormRecordComputed>) { (Object as any).assign(this, init); }
}
export class FormRecordEvent
{
public Who: string;
public X: string;
public T: string;
public At: string;
public Dot: string;
public constructor(init?: Partial<FormRecordEvent>) { (Object as any).assign(this, init); }
}
export class FormSubmissionRecord
{
public SubmissionUID: string;
public FormUID: string;
public FormName: string;
public Noun: string;
public Number: string;
public ApplicantName: string;
public Stage: FormStageInfo;
public Tags: string[] = [];
public AssigneeAgentId?: number;
public AssigneeName: string;
public BranchName: string;
public SubmittedAt?: string;
public VersionNo: number;
public CurrentVersionNo: number;
public Email: string;
public Phone: string;
public ContactName: string;
public Meta: string;
public Stages: FormStageInfo[] = [];
public Moves: FormStageInfo[] = [];
public People: FormPerson[] = [];
public CanEdit: boolean;
public CanSensitive: boolean;
public Sections: FormRecordSection[] = [];
public Docs: FormRecordDoc[] = [];
public DocCount: string;
public Computed: FormRecordComputed[] = [];
public Timeline: FormRecordEvent[] = [];
public Notes: FormRecordEvent[] = [];
public Audit: FormRecordEvent[] = [];
public constructor(init?: Partial<FormSubmissionRecord>) { (Object as any).assign(this, init); }
}
export class FormSubmissionRecordResponse
{
public Record: FormSubmissionRecord;
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<FormSubmissionRecordResponse>) { (Object as any).assign(this, init); }
}
export class FormSubmissionRecordRequest
{
public SubmissionUID: string;
public constructor(init?: Partial<FormSubmissionRecordRequest>) { (Object as any).assign(this, init); }
}
TypeScript FormSubmissionRecordRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/forms/submissions/{SubmissionUID} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
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>