| POST | /v1/forms/submissions/{SubmissionUID}/decide |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SubmissionUID | path | Guid | No | |
| Outcome | body | string | No | |
| Reason | body | string | No | |
| Note | body | string | No | |
| Counter | body | FormCounterSignature | No | |
| From | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Mode | form | string | No | |
| Name | form | string | No | |
| Png | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Sent | form | List<FormFillReceiptLine> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Record | form | FormSubmissionRecord | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SubmissionUID | form | Guid | No | |
| FormUID | form | Guid | No | |
| FormName | form | string | No | |
| Noun | form | string | No | |
| Number | form | string | No | |
| ApplicantName | form | string | No | |
| Stage | form | FormStageInfo | No | |
| Tags | form | List<string> | No | |
| AssigneeAgentId | form | int? | No | |
| AssigneeName | form | string | No | |
| BranchName | form | string | No | |
| SubmittedAt | form | DateTime? | No | |
| VersionNo | form | int | No | |
| CurrentVersionNo | form | int | No | |
| form | string | No | ||
| Phone | form | string | No | |
| ContactName | form | string | No | |
| Meta | form | string | No | |
| Stages | form | List<FormStageInfo> | No | |
| Moves | form | List<FormStageInfo> | No | |
| People | form | List<FormPerson> | No | |
| CanEdit | form | bool | No | |
| CanSensitive | form | bool | No | |
| Sections | form | List<FormRecordSection> | No | |
| Docs | form | List<FormRecordDoc> | No | |
| DocCount | form | string | No | |
| Computed | form | List<FormRecordComputed> | No | |
| Timeline | form | List<FormRecordEvent> | No | |
| Notes | form | List<FormRecordEvent> | No | |
| Audit | form | List<FormRecordEvent> | No | |
| IsTest | form | bool | No | |
| VersionText | form | string | No | |
| TenantName | form | string | No | |
| SubmittedIso | form | string | No | |
| OpenRequest | form | FormRecordRequest | No | |
| CanRequest | form | bool | No | |
| RequestTip | form | string | No | |
| Decision | form | FormRecordDecision | No | |
| Earlier | form | List<FormRecordEarlierDecision> | No | |
| CanDecide | form | bool | No | |
| DecideTip | form | string | No | |
| MoveTip | form | string | No | |
| DueAt | form | DateTime? | No | |
| Overdue | form | bool | No | |
| AgeText | form | string | No | |
| DueText | form | string | No | |
| Signatures | form | List<FormRecordSigEntry> | No | |
| Replaced | form | List<FormRecordReplaced> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | string | No | |
| Label | form | string | No | |
| Tone | form | string | No | |
| Kind | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AgentId | form | int | No | |
| AgentName | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Title | form | string | No | |
| Rows | form | List<FormRecordRow> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| K | form | string | No | |
| L | form | string | No | |
| T | form | string | No | |
| Kind | form | string | No | |
| V | form | string | No | |
| Sensitive | form | bool | No | |
| CanReveal | form | bool | No | |
| Locked | form | bool | No | |
| Files | form | List<FormRecordFile> | No | |
| NoFiles | form | bool | No | |
| Sig | form | FormRecordSig | No | |
| Asked | form | bool | No | |
| Changed | form | bool | No | |
| Prev | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| AttachmentId | form | Guid | No | |
| Name | form | string | No | |
| Kind | form | string | No | |
| Size | form | string | No | |
| Sensitive | form | bool | No | |
| Locked | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Pending | form | bool | No | |
| Mode | form | string | No | |
| SignerName | form | string | No | |
| Role | form | string | No | |
| RecordId | form | int | No | |
| ImageHash | form | string | No | |
| DocumentDigest | form | string | No | |
| Ip | form | string | No | |
| Browser | form | string | No | |
| ConsentStored | form | bool | No | |
| SignedText | form | string | No | |
| HasImage | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Name | form | string | No | |
| Ok | form | bool | No | |
| Tag | form | string | No | |
| Tone | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| L | form | string | No | |
| V | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Who | form | string | No | |
| X | form | string | No | |
| T | form | string | No | |
| At | form | DateTime | No | |
| Dot | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RequestUID | form | Guid | No | |
| Keys | form | List<string> | No | |
| Resign | form | List<string> | No | |
| Note | form | string | No | |
| By | form | string | No | |
| At | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Outcome | form | string | No | |
| Tone | form | string | No | |
| Reason | form | string | No | |
| Note | form | string | No | |
| Text | form | string | No | |
| HasCounter | form | bool | No | |
| Typed | form | bool | No | |
| Drawn | form | bool | No | |
| SigName | form | string | No | |
| SigMeta | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Outcome | form | string | No | |
| Tone | form | string | No | |
| Reason | form | string | No | |
| Note | form | string | No | |
| Text | form | string | No | |
| Counter | form | string | No | |
| Reopened | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RecordId | form | int | No | |
| Key | form | string | No | |
| Label | form | string | No | |
| Role | form | string | No | |
| SignerName | form | string | No | |
| Mode | form | string | No | |
| HasImage | form | bool | No | |
| ConsentStored | form | bool | No | |
| Replaced | form | bool | No | |
| Counter | form | bool | No | |
| Reopened | form | bool | No | |
| Meta | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| RequestUID | form | Guid | No | |
| AskedBy | form | string | No | |
| AskedAt | form | string | No | |
| AnsweredAt | form | string | No | |
| Covering | form | string | No | |
| Rows | form | List<FormRecordReplacedRow> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| K | form | string | No | |
| L | form | string | No | |
| Kind | form | string | No | |
| V | form | string | No | |
| Sensitive | form | bool | No | |
| CanReveal | form | bool | No | |
| Locked | form | bool | No | |
| Files | form | List<FormRecordFile> | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Channel | form | string | No | |
| To | form | string | No | |
| Outcome | form | string | No |
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.
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>