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
"use strict";
export class FormStageInfo {
    /** @param {{Id?:string,Label?:string,Tone?:string,Kind?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Label;
    /** @type {string} */
    Tone;
    /** @type {string} */
    Kind;
}
export class FormPerson {
    /** @param {{AgentId?:number,AgentName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgentId;
    /** @type {string} */
    AgentName;
}
export class FormRecordFile {
    /** @param {{AttachmentId?:string,Name?:string,Kind?:string,Size?:string,Sensitive?:boolean,Locked?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    AttachmentId;
    /** @type {string} */
    Name;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Size;
    /** @type {boolean} */
    Sensitive;
    /** @type {boolean} */
    Locked;
}
export class FormRecordSig {
    /** @param {{Pending?:boolean,Mode?:string,SignerName?:string,Role?:string,RecordId?:number,ImageHash?:string,DocumentDigest?:string,Ip?:string,Browser?:string,ConsentStored?:boolean,SignedText?:string,HasImage?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Pending;
    /** @type {string} */
    Mode;
    /** @type {string} */
    SignerName;
    /** @type {string} */
    Role;
    /** @type {number} */
    RecordId;
    /** @type {string} */
    ImageHash;
    /** @type {string} */
    DocumentDigest;
    /** @type {string} */
    Ip;
    /** @type {string} */
    Browser;
    /** @type {boolean} */
    ConsentStored;
    /** @type {string} */
    SignedText;
    /** @type {boolean} */
    HasImage;
}
export class FormRecordRow {
    /** @param {{K?:string,L?:string,T?:string,Kind?:string,V?:string,Sensitive?:boolean,CanReveal?:boolean,Locked?:boolean,Files?:FormRecordFile[],NoFiles?:boolean,Sig?:FormRecordSig,Asked?:boolean,Changed?:boolean,Prev?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    K;
    /** @type {string} */
    L;
    /** @type {string} */
    T;
    /** @type {string} */
    Kind;
    /** @type {string} */
    V;
    /** @type {boolean} */
    Sensitive;
    /** @type {boolean} */
    CanReveal;
    /** @type {boolean} */
    Locked;
    /** @type {FormRecordFile[]} */
    Files = [];
    /** @type {boolean} */
    NoFiles;
    /** @type {FormRecordSig} */
    Sig;
    /** @type {boolean} */
    Asked;
    /** @type {boolean} */
    Changed;
    /** @type {string} */
    Prev;
}
export class FormRecordSection {
    /** @param {{Title?:string,Rows?:FormRecordRow[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Title;
    /** @type {FormRecordRow[]} */
    Rows = [];
}
export class FormRecordDoc {
    /** @param {{Name?:string,Ok?:boolean,Tag?:string,Tone?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {boolean} */
    Ok;
    /** @type {string} */
    Tag;
    /** @type {string} */
    Tone;
}
export class FormRecordComputed {
    /** @param {{L?:string,V?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    L;
    /** @type {string} */
    V;
}
export class FormRecordEvent {
    /** @param {{Who?:string,X?:string,T?:string,At?:string,Dot?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Who;
    /** @type {string} */
    X;
    /** @type {string} */
    T;
    /** @type {string} */
    At;
    /** @type {string} */
    Dot;
}
export class FormRecordRequest {
    /** @param {{RequestUID?:string,Keys?:string[],Resign?:string[],Note?:string,By?:string,At?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RequestUID;
    /** @type {string[]} */
    Keys = [];
    /** @type {string[]} */
    Resign = [];
    /** @type {string} */
    Note;
    /** @type {string} */
    By;
    /** @type {string} */
    At;
}
export class FormRecordDecision {
    /** @param {{Outcome?:string,Tone?:string,Reason?:string,Note?:string,Text?:string,HasCounter?:boolean,Typed?:boolean,Drawn?:boolean,SigName?:string,SigMeta?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Outcome;
    /** @type {string} */
    Tone;
    /** @type {string} */
    Reason;
    /** @type {string} */
    Note;
    /** @type {string} */
    Text;
    /** @type {boolean} */
    HasCounter;
    /** @type {boolean} */
    Typed;
    /** @type {boolean} */
    Drawn;
    /** @type {string} */
    SigName;
    /** @type {string} */
    SigMeta;
}
export class FormRecordEarlierDecision {
    /** @param {{Outcome?:string,Tone?:string,Reason?:string,Note?:string,Text?:string,Counter?:string,Reopened?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Outcome;
    /** @type {string} */
    Tone;
    /** @type {string} */
    Reason;
    /** @type {string} */
    Note;
    /** @type {string} */
    Text;
    /** @type {string} */
    Counter;
    /** @type {string} */
    Reopened;
}
export class FormRecordSigEntry {
    /** @param {{RecordId?:number,Key?:string,Label?:string,Role?:string,SignerName?:string,Mode?:string,HasImage?:boolean,ConsentStored?:boolean,Replaced?:boolean,Counter?:boolean,Reopened?:boolean,Meta?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    RecordId;
    /** @type {string} */
    Key;
    /** @type {string} */
    Label;
    /** @type {string} */
    Role;
    /** @type {string} */
    SignerName;
    /** @type {string} */
    Mode;
    /** @type {boolean} */
    HasImage;
    /** @type {boolean} */
    ConsentStored;
    /** @type {boolean} */
    Replaced;
    /** @type {boolean} */
    Counter;
    /** @type {boolean} */
    Reopened;
    /** @type {string} */
    Meta;
}
export class FormRecordReplacedRow {
    /** @param {{K?:string,L?:string,Kind?:string,V?:string,Sensitive?:boolean,CanReveal?:boolean,Locked?:boolean,Files?:FormRecordFile[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    K;
    /** @type {string} */
    L;
    /** @type {string} */
    Kind;
    /** @type {string} */
    V;
    /** @type {boolean} */
    Sensitive;
    /** @type {boolean} */
    CanReveal;
    /** @type {boolean} */
    Locked;
    /** @type {FormRecordFile[]} */
    Files = [];
}
export class FormRecordReplaced {
    /** @param {{RequestUID?:string,AskedBy?:string,AskedAt?:string,AnsweredAt?:string,Covering?:string,Rows?:FormRecordReplacedRow[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    RequestUID;
    /** @type {string} */
    AskedBy;
    /** @type {string} */
    AskedAt;
    /** @type {string} */
    AnsweredAt;
    /** @type {string} */
    Covering;
    /** @type {FormRecordReplacedRow[]} */
    Rows = [];
}
export class FormSubmissionRecord {
    /** @param {{SubmissionUID?:string,FormUID?:string,FormName?:string,Noun?:string,Number?:string,ApplicantName?:string,Stage?:FormStageInfo,Tags?:string[],AssigneeAgentId?:number,AssigneeName?:string,BranchName?:string,SubmittedAt?:string,VersionNo?:number,CurrentVersionNo?:number,Email?:string,Phone?:string,ContactName?:string,Meta?:string,Stages?:FormStageInfo[],Moves?:FormStageInfo[],People?:FormPerson[],CanEdit?:boolean,CanSensitive?:boolean,Sections?:FormRecordSection[],Docs?:FormRecordDoc[],DocCount?:string,Computed?:FormRecordComputed[],Timeline?:FormRecordEvent[],Notes?:FormRecordEvent[],Audit?:FormRecordEvent[],IsTest?:boolean,VersionText?:string,TenantName?:string,SubmittedIso?:string,OpenRequest?:FormRecordRequest,CanRequest?:boolean,RequestTip?:string,Decision?:FormRecordDecision,Earlier?:FormRecordEarlierDecision[],CanDecide?:boolean,DecideTip?:string,MoveTip?:string,DueAt?:string,Overdue?:boolean,AgeText?:string,DueText?:string,Signatures?:FormRecordSigEntry[],Replaced?:FormRecordReplaced[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SubmissionUID;
    /** @type {string} */
    FormUID;
    /** @type {string} */
    FormName;
    /** @type {string} */
    Noun;
    /** @type {string} */
    Number;
    /** @type {string} */
    ApplicantName;
    /** @type {FormStageInfo} */
    Stage;
    /** @type {string[]} */
    Tags = [];
    /** @type {?number} */
    AssigneeAgentId;
    /** @type {string} */
    AssigneeName;
    /** @type {string} */
    BranchName;
    /** @type {?string} */
    SubmittedAt;
    /** @type {number} */
    VersionNo;
    /** @type {number} */
    CurrentVersionNo;
    /** @type {string} */
    Email;
    /** @type {string} */
    Phone;
    /** @type {string} */
    ContactName;
    /** @type {string} */
    Meta;
    /** @type {FormStageInfo[]} */
    Stages = [];
    /** @type {FormStageInfo[]} */
    Moves = [];
    /** @type {FormPerson[]} */
    People = [];
    /** @type {boolean} */
    CanEdit;
    /** @type {boolean} */
    CanSensitive;
    /** @type {FormRecordSection[]} */
    Sections = [];
    /** @type {FormRecordDoc[]} */
    Docs = [];
    /** @type {string} */
    DocCount;
    /** @type {FormRecordComputed[]} */
    Computed = [];
    /** @type {FormRecordEvent[]} */
    Timeline = [];
    /** @type {FormRecordEvent[]} */
    Notes = [];
    /** @type {FormRecordEvent[]} */
    Audit = [];
    /** @type {boolean} */
    IsTest;
    /** @type {string} */
    VersionText;
    /** @type {string} */
    TenantName;
    /** @type {string} */
    SubmittedIso;
    /** @type {FormRecordRequest} */
    OpenRequest;
    /** @type {boolean} */
    CanRequest;
    /** @type {string} */
    RequestTip;
    /** @type {FormRecordDecision} */
    Decision;
    /** @type {FormRecordEarlierDecision[]} */
    Earlier = [];
    /** @type {boolean} */
    CanDecide;
    /** @type {string} */
    DecideTip;
    /** @type {string} */
    MoveTip;
    /** @type {?string} */
    DueAt;
    /** @type {boolean} */
    Overdue;
    /** @type {string} */
    AgeText;
    /** @type {string} */
    DueText;
    /** @type {FormRecordSigEntry[]} */
    Signatures = [];
    /** @type {FormRecordReplaced[]} */
    Replaced = [];
}
export class FormSubmissionRecordResponse {
    /** @param {{Record?:FormSubmissionRecord,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FormSubmissionRecord} */
    Record;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormFillReceiptLine {
    /** @param {{Channel?:string,To?:string,Outcome?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Channel;
    /** @type {string} */
    To;
    /** @type {string} */
    Outcome;
}
export class FormSubmissionRequestInfoResponse extends FormSubmissionRecordResponse {
    /** @param {{Sent?:FormFillReceiptLine[],Record?:FormSubmissionRecord,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {FormFillReceiptLine[]} */
    Sent = [];
}
export class FormCounterSignature {
    /** @param {{Mode?:string,Name?:string,Png?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Mode;
    /** @type {string} */
    Name;
    /** @type {string} */
    Png;
}
export class FormSubmissionDecideRequest {
    /** @param {{SubmissionUID?:string,Outcome?:string,Reason?:string,Note?:string,Counter?:FormCounterSignature,From?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    SubmissionUID;
    /** @type {string} */
    Outcome;
    /** @type {string} */
    Reason;
    /** @type {string} */
    Note;
    /** @type {FormCounterSignature} */
    Counter;
    /** @type {string} */
    From;
}

JavaScript FormSubmissionDecideRequest 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}/decide HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FormSubmissionDecideRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Counter>
    <Mode>String</Mode>
    <Name>String</Name>
    <Png>String</Png>
  </Counter>
  <From>String</From>
  <Note>String</Note>
  <Outcome>String</Outcome>
  <Reason>String</Reason>
  <SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
</FormSubmissionDecideRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormSubmissionRequestInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Record>
    <AgeText>String</AgeText>
    <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>
    <CanDecide>false</CanDecide>
    <CanEdit>false</CanEdit>
    <CanRequest>false</CanRequest>
    <CanSensitive>false</CanSensitive>
    <Computed>
      <FormRecordComputed>
        <L>String</L>
        <V>String</V>
      </FormRecordComputed>
    </Computed>
    <ContactName>String</ContactName>
    <CurrentVersionNo>0</CurrentVersionNo>
    <DecideTip>String</DecideTip>
    <Decision>
      <Drawn>false</Drawn>
      <HasCounter>false</HasCounter>
      <Note>String</Note>
      <Outcome>String</Outcome>
      <Reason>String</Reason>
      <SigMeta>String</SigMeta>
      <SigName>String</SigName>
      <Text>String</Text>
      <Tone>String</Tone>
      <Typed>false</Typed>
    </Decision>
    <DocCount>String</DocCount>
    <Docs>
      <FormRecordDoc>
        <Name>String</Name>
        <Ok>false</Ok>
        <Tag>String</Tag>
        <Tone>String</Tone>
      </FormRecordDoc>
    </Docs>
    <DueAt>0001-01-01T00:00:00</DueAt>
    <DueText>String</DueText>
    <Earlier>
      <FormRecordEarlierDecision>
        <Counter>String</Counter>
        <Note>String</Note>
        <Outcome>String</Outcome>
        <Reason>String</Reason>
        <Reopened>String</Reopened>
        <Text>String</Text>
        <Tone>String</Tone>
      </FormRecordEarlierDecision>
    </Earlier>
    <Email>String</Email>
    <FormName>String</FormName>
    <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
    <IsTest>false</IsTest>
    <Meta>String</Meta>
    <MoveTip>String</MoveTip>
    <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>
    <OpenRequest>
      <At>String</At>
      <By>String</By>
      <Keys xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Keys>
      <Note>String</Note>
      <RequestUID>00000000-0000-0000-0000-000000000000</RequestUID>
      <Resign xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Resign>
    </OpenRequest>
    <Overdue>false</Overdue>
    <People>
      <FormPerson>
        <AgentId>0</AgentId>
        <AgentName>String</AgentName>
      </FormPerson>
    </People>
    <Phone>String</Phone>
    <Replaced>
      <FormRecordReplaced>
        <AnsweredAt>String</AnsweredAt>
        <AskedAt>String</AskedAt>
        <AskedBy>String</AskedBy>
        <Covering>String</Covering>
        <RequestUID>00000000-0000-0000-0000-000000000000</RequestUID>
        <Rows>
          <FormRecordReplacedRow>
            <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>
            <Sensitive>false</Sensitive>
            <V>String</V>
          </FormRecordReplacedRow>
        </Rows>
      </FormRecordReplaced>
    </Replaced>
    <RequestTip>String</RequestTip>
    <Sections>
      <FormRecordSection>
        <Rows>
          <FormRecordRow>
            <Asked>false</Asked>
            <CanReveal>false</CanReveal>
            <Changed>false</Changed>
            <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>
            <Prev>String</Prev>
            <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>
    <Signatures>
      <FormRecordSigEntry>
        <ConsentStored>false</ConsentStored>
        <Counter>false</Counter>
        <HasImage>false</HasImage>
        <Key>String</Key>
        <Label>String</Label>
        <Meta>String</Meta>
        <Mode>String</Mode>
        <RecordId>0</RecordId>
        <Reopened>false</Reopened>
        <Replaced>false</Replaced>
        <Role>String</Role>
        <SignerName>String</SignerName>
      </FormRecordSigEntry>
    </Signatures>
    <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>
    <SubmittedIso>String</SubmittedIso>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Tags>
    <TenantName>String</TenantName>
    <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>
    <VersionText>String</VersionText>
  </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>
  <Sent>
    <FormFillReceiptLine>
      <Channel>String</Channel>
      <Outcome>String</Outcome>
      <To>String</To>
    </FormFillReceiptLine>
  </Sent>
</FormSubmissionRequestInfoResponse>