Trendsic Platform Service

<back to all web services

FormSubmissionRecordRequest

Requires Authentication
The following routes are available for this service:
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 .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Record":{"SubmissionUID":"00000000000000000000000000000000","FormUID":"00000000000000000000000000000000","FormName":"String","Noun":"String","Number":"String","ApplicantName":"String","Stage":{"Id":"String","Label":"String","Tone":"String","Kind":"String"},"Tags":["String"],"AssigneeAgentId":0,"AssigneeName":"String","BranchName":"String","SubmittedAt":"0001-01-01T00:00:00.0000000","VersionNo":0,"CurrentVersionNo":0,"Email":"String","Phone":"String","ContactName":"String","Meta":"String","Stages":[{"Id":"String","Label":"String","Tone":"String","Kind":"String"}],"Moves":[{"Id":"String","Label":"String","Tone":"String","Kind":"String"}],"People":[{"AgentId":0,"AgentName":"String"}],"CanEdit":false,"CanSensitive":false,"Sections":[{"Title":"String","Rows":[{"K":"String","L":"String","T":"String","Kind":"String","V":"String","Sensitive":false,"CanReveal":false,"Locked":false,"Files":[{"AttachmentId":"00000000000000000000000000000000","Name":"String","Kind":"String","Size":"String","Sensitive":false,"Locked":false}],"NoFiles":false,"Sig":{"Pending":false,"Mode":"String","SignerName":"String","Role":"String","RecordId":0,"ImageHash":"String","DocumentDigest":"String","Ip":"String","Browser":"String","ConsentStored":false,"SignedText":"String","HasImage":false}}]}],"Docs":[{"Name":"String","Ok":false,"Tag":"String","Tone":"String"}],"DocCount":"String","Computed":[{"L":"String","V":"String"}],"Timeline":[{"Who":"String","X":"String","T":"String","At":"0001-01-01T00:00:00.0000000","Dot":"String"}],"Notes":[{"Who":"String","X":"String","T":"String","At":"0001-01-01T00:00:00.0000000","Dot":"String"}],"Audit":[{"Who":"String","X":"String","T":"String","At":"0001-01-01T00:00:00.0000000","Dot":"String"}]},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}