Trendsic Platform Service

<back to all web services

FormSubmissionDecideRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/{SubmissionUID}/decide

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 Asked: boolean;
    public Changed: boolean;
    public Prev: string;

    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 FormRecordRequest
{
    public RequestUID: string;
    public Keys: string[] = [];
    public Resign: string[] = [];
    public Note: string;
    public By: string;
    public At: string;

    public constructor(init?: Partial<FormRecordRequest>) { (Object as any).assign(this, init); }
}

export class FormRecordDecision
{
    public Outcome: string;
    public Tone: string;
    public Reason: string;
    public Note: string;
    public Text: string;
    public HasCounter: boolean;
    public Typed: boolean;
    public Drawn: boolean;
    public SigName: string;
    public SigMeta: string;

    public constructor(init?: Partial<FormRecordDecision>) { (Object as any).assign(this, init); }
}

export class FormRecordEarlierDecision
{
    public Outcome: string;
    public Tone: string;
    public Reason: string;
    public Note: string;
    public Text: string;
    public Counter: string;
    public Reopened: string;

    public constructor(init?: Partial<FormRecordEarlierDecision>) { (Object as any).assign(this, init); }
}

export class FormRecordSigEntry
{
    public RecordId: number;
    public Key: string;
    public Label: string;
    public Role: string;
    public SignerName: string;
    public Mode: string;
    public HasImage: boolean;
    public ConsentStored: boolean;
    public Replaced: boolean;
    public Counter: boolean;
    public Reopened: boolean;
    public Meta: string;

    public constructor(init?: Partial<FormRecordSigEntry>) { (Object as any).assign(this, init); }
}

export class FormRecordReplacedRow
{
    public K: string;
    public L: string;
    public Kind: string;
    public V: string;
    public Sensitive: boolean;
    public CanReveal: boolean;
    public Locked: boolean;
    public Files: FormRecordFile[] = [];

    public constructor(init?: Partial<FormRecordReplacedRow>) { (Object as any).assign(this, init); }
}

export class FormRecordReplaced
{
    public RequestUID: string;
    public AskedBy: string;
    public AskedAt: string;
    public AnsweredAt: string;
    public Covering: string;
    public Rows: FormRecordReplacedRow[] = [];

    public constructor(init?: Partial<FormRecordReplaced>) { (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 IsTest: boolean;
    public VersionText: string;
    public TenantName: string;
    public SubmittedIso: string;
    public OpenRequest: FormRecordRequest;
    public CanRequest: boolean;
    public RequestTip: string;
    public Decision: FormRecordDecision;
    public Earlier: FormRecordEarlierDecision[] = [];
    public CanDecide: boolean;
    public DecideTip: string;
    public MoveTip: string;
    public DueAt?: string;
    public Overdue: boolean;
    public AgeText: string;
    public DueText: string;
    public Signatures: FormRecordSigEntry[] = [];
    public Replaced: FormRecordReplaced[] = [];

    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 FormFillReceiptLine
{
    public Channel: string;
    public To: string;
    public Outcome: string;

    public constructor(init?: Partial<FormFillReceiptLine>) { (Object as any).assign(this, init); }
}

export class FormSubmissionRequestInfoResponse extends FormSubmissionRecordResponse
{
    public Sent: FormFillReceiptLine[] = [];

    public constructor(init?: Partial<FormSubmissionRequestInfoResponse>) { super(init); (Object as any).assign(this, init); }
}

export class FormCounterSignature
{
    public Mode: string;
    public Name: string;
    public Png: string;

    public constructor(init?: Partial<FormCounterSignature>) { (Object as any).assign(this, init); }
}

export class FormSubmissionDecideRequest
{
    public SubmissionUID: string;
    public Outcome: string;
    public Reason: string;
    public Note: string;
    public Counter: FormCounterSignature;
    public From: string;

    public constructor(init?: Partial<FormSubmissionDecideRequest>) { (Object as any).assign(this, init); }
}

TypeScript FormSubmissionDecideRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{"SubmissionUID":"00000000000000000000000000000000","Outcome":"String","Reason":"String","Note":"String","Counter":{"Mode":"String","Name":"String","Png":"String"},"From":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Sent":[{"Channel":"String","To":"String","Outcome":"String"}],"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},"Asked":false,"Changed":false,"Prev":"String"}]}],"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"}],"IsTest":false,"VersionText":"String","TenantName":"String","SubmittedIso":"String","OpenRequest":{"RequestUID":"00000000000000000000000000000000","Keys":["String"],"Resign":["String"],"Note":"String","By":"String","At":"String"},"CanRequest":false,"RequestTip":"String","Decision":{"Outcome":"String","Tone":"String","Reason":"String","Note":"String","Text":"String","HasCounter":false,"Typed":false,"Drawn":false,"SigName":"String","SigMeta":"String"},"Earlier":[{"Outcome":"String","Tone":"String","Reason":"String","Note":"String","Text":"String","Counter":"String","Reopened":"String"}],"CanDecide":false,"DecideTip":"String","MoveTip":"String","DueAt":"0001-01-01T00:00:00.0000000","Overdue":false,"AgeText":"String","DueText":"String","Signatures":[{"RecordId":0,"Key":"String","Label":"String","Role":"String","SignerName":"String","Mode":"String","HasImage":false,"ConsentStored":false,"Replaced":false,"Counter":false,"Reopened":false,"Meta":"String"}],"Replaced":[{"RequestUID":"00000000000000000000000000000000","AskedBy":"String","AskedAt":"String","AnsweredAt":"String","Covering":"String","Rows":[{"K":"String","L":"String","Kind":"String","V":"String","Sensitive":false,"CanReveal":false,"Locked":false,"Files":[{"AttachmentId":"00000000000000000000000000000000","Name":"String","Kind":"String","Size":"String","Sensitive":false,"Locked":false}]}]}]},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}