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