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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type FormStageInfo() = 
        member val Id:String = null with get,set
        member val Label:String = null with get,set
        member val Tone:String = null with get,set
        member val Kind:String = null with get,set

    [<AllowNullLiteral>]
    type FormPerson() = 
        member val AgentId:Int32 = new Int32() with get,set
        member val AgentName:String = null with get,set

    [<AllowNullLiteral>]
    type FormRecordFile() = 
        member val AttachmentId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Kind:String = null with get,set
        member val Size:String = null with get,set
        member val Sensitive:Boolean = new Boolean() with get,set
        member val Locked:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type FormRecordSig() = 
        member val Pending:Boolean = new Boolean() with get,set
        member val Mode:String = null with get,set
        member val SignerName:String = null with get,set
        member val Role:String = null with get,set
        member val RecordId:Int32 = new Int32() with get,set
        member val ImageHash:String = null with get,set
        member val DocumentDigest:String = null with get,set
        member val Ip:String = null with get,set
        member val Browser:String = null with get,set
        member val ConsentStored:Boolean = new Boolean() with get,set
        member val SignedText:String = null with get,set
        member val HasImage:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type FormRecordRow() = 
        member val K:String = null with get,set
        member val L:String = null with get,set
        member val T:String = null with get,set
        member val Kind:String = null with get,set
        member val V:String = null with get,set
        member val Sensitive:Boolean = new Boolean() with get,set
        member val CanReveal:Boolean = new Boolean() with get,set
        member val Locked:Boolean = new Boolean() with get,set
        member val Files:ResizeArray<FormRecordFile> = new ResizeArray<FormRecordFile>() with get,set
        member val NoFiles:Boolean = new Boolean() with get,set
        member val Sig:FormRecordSig = null with get,set
        member val Asked:Boolean = new Boolean() with get,set
        member val Changed:Boolean = new Boolean() with get,set
        member val Prev:String = null with get,set

    [<AllowNullLiteral>]
    type FormRecordSection() = 
        member val Title:String = null with get,set
        member val Rows:ResizeArray<FormRecordRow> = new ResizeArray<FormRecordRow>() with get,set

    [<AllowNullLiteral>]
    type FormRecordDoc() = 
        member val Name:String = null with get,set
        member val Ok:Boolean = new Boolean() with get,set
        member val Tag:String = null with get,set
        member val Tone:String = null with get,set

    [<AllowNullLiteral>]
    type FormRecordComputed() = 
        member val L:String = null with get,set
        member val V:String = null with get,set

    [<AllowNullLiteral>]
    type FormRecordEvent() = 
        member val Who:String = null with get,set
        member val X:String = null with get,set
        member val T:String = null with get,set
        member val At:DateTime = new DateTime() with get,set
        member val Dot:String = null with get,set

    [<AllowNullLiteral>]
    type FormRecordRequest() = 
        member val RequestUID:Guid = new Guid() with get,set
        member val Keys:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Resign:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Note:String = null with get,set
        member val By:String = null with get,set
        member val At:String = null with get,set

    [<AllowNullLiteral>]
    type FormRecordDecision() = 
        member val Outcome:String = null with get,set
        member val Tone:String = null with get,set
        member val Reason:String = null with get,set
        member val Note:String = null with get,set
        member val Text:String = null with get,set
        member val HasCounter:Boolean = new Boolean() with get,set
        member val Typed:Boolean = new Boolean() with get,set
        member val Drawn:Boolean = new Boolean() with get,set
        member val SigName:String = null with get,set
        member val SigMeta:String = null with get,set

    [<AllowNullLiteral>]
    type FormRecordEarlierDecision() = 
        member val Outcome:String = null with get,set
        member val Tone:String = null with get,set
        member val Reason:String = null with get,set
        member val Note:String = null with get,set
        member val Text:String = null with get,set
        member val Counter:String = null with get,set
        member val Reopened:String = null with get,set

    [<AllowNullLiteral>]
    type FormRecordSigEntry() = 
        member val RecordId:Int32 = new Int32() with get,set
        member val Key:String = null with get,set
        member val Label:String = null with get,set
        member val Role:String = null with get,set
        member val SignerName:String = null with get,set
        member val Mode:String = null with get,set
        member val HasImage:Boolean = new Boolean() with get,set
        member val ConsentStored:Boolean = new Boolean() with get,set
        member val Replaced:Boolean = new Boolean() with get,set
        member val Counter:Boolean = new Boolean() with get,set
        member val Reopened:Boolean = new Boolean() with get,set
        member val Meta:String = null with get,set

    [<AllowNullLiteral>]
    type FormRecordReplacedRow() = 
        member val K:String = null with get,set
        member val L:String = null with get,set
        member val Kind:String = null with get,set
        member val V:String = null with get,set
        member val Sensitive:Boolean = new Boolean() with get,set
        member val CanReveal:Boolean = new Boolean() with get,set
        member val Locked:Boolean = new Boolean() with get,set
        member val Files:ResizeArray<FormRecordFile> = new ResizeArray<FormRecordFile>() with get,set

    [<AllowNullLiteral>]
    type FormRecordReplaced() = 
        member val RequestUID:Guid = new Guid() with get,set
        member val AskedBy:String = null with get,set
        member val AskedAt:String = null with get,set
        member val AnsweredAt:String = null with get,set
        member val Covering:String = null with get,set
        member val Rows:ResizeArray<FormRecordReplacedRow> = new ResizeArray<FormRecordReplacedRow>() with get,set

    [<AllowNullLiteral>]
    type FormSubmissionRecord() = 
        member val SubmissionUID:Guid = new Guid() with get,set
        member val FormUID:Guid = new Guid() with get,set
        member val FormName:String = null with get,set
        member val Noun:String = null with get,set
        member val Number:String = null with get,set
        member val ApplicantName:String = null with get,set
        member val Stage:FormStageInfo = null with get,set
        member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val AssigneeAgentId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val AssigneeName:String = null with get,set
        member val BranchName:String = null with get,set
        member val SubmittedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val VersionNo:Int32 = new Int32() with get,set
        member val CurrentVersionNo:Int32 = new Int32() with get,set
        member val Email:String = null with get,set
        member val Phone:String = null with get,set
        member val ContactName:String = null with get,set
        member val Meta:String = null with get,set
        member val Stages:ResizeArray<FormStageInfo> = new ResizeArray<FormStageInfo>() with get,set
        member val Moves:ResizeArray<FormStageInfo> = new ResizeArray<FormStageInfo>() with get,set
        member val People:ResizeArray<FormPerson> = new ResizeArray<FormPerson>() with get,set
        member val CanEdit:Boolean = new Boolean() with get,set
        member val CanSensitive:Boolean = new Boolean() with get,set
        member val Sections:ResizeArray<FormRecordSection> = new ResizeArray<FormRecordSection>() with get,set
        member val Docs:ResizeArray<FormRecordDoc> = new ResizeArray<FormRecordDoc>() with get,set
        member val DocCount:String = null with get,set
        member val Computed:ResizeArray<FormRecordComputed> = new ResizeArray<FormRecordComputed>() with get,set
        member val Timeline:ResizeArray<FormRecordEvent> = new ResizeArray<FormRecordEvent>() with get,set
        member val Notes:ResizeArray<FormRecordEvent> = new ResizeArray<FormRecordEvent>() with get,set
        member val Audit:ResizeArray<FormRecordEvent> = new ResizeArray<FormRecordEvent>() with get,set
        member val IsTest:Boolean = new Boolean() with get,set
        member val VersionText:String = null with get,set
        member val TenantName:String = null with get,set
        member val SubmittedIso:String = null with get,set
        member val OpenRequest:FormRecordRequest = null with get,set
        member val CanRequest:Boolean = new Boolean() with get,set
        member val RequestTip:String = null with get,set
        member val Decision:FormRecordDecision = null with get,set
        member val Earlier:ResizeArray<FormRecordEarlierDecision> = new ResizeArray<FormRecordEarlierDecision>() with get,set
        member val CanDecide:Boolean = new Boolean() with get,set
        member val DecideTip:String = null with get,set
        member val MoveTip:String = null with get,set
        member val DueAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Overdue:Boolean = new Boolean() with get,set
        member val AgeText:String = null with get,set
        member val DueText:String = null with get,set
        member val Signatures:ResizeArray<FormRecordSigEntry> = new ResizeArray<FormRecordSigEntry>() with get,set
        member val Replaced:ResizeArray<FormRecordReplaced> = new ResizeArray<FormRecordReplaced>() with get,set

    [<AllowNullLiteral>]
    type FormSubmissionRecordResponse() = 
        member val Record:FormSubmissionRecord = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type FormFillReceiptLine() = 
        member val Channel:String = null with get,set
        member val To:String = null with get,set
        member val Outcome:String = null with get,set

    [<AllowNullLiteral>]
    type FormSubmissionRequestInfoResponse() = 
        inherit FormSubmissionRecordResponse()
        member val Sent:ResizeArray<FormFillReceiptLine> = new ResizeArray<FormFillReceiptLine>() with get,set

    [<AllowNullLiteral>]
    type FormCounterSignature() = 
        member val Mode:String = null with get,set
        member val Name:String = null with get,set
        member val Png:String = null with get,set

    [<AllowNullLiteral>]
    type FormSubmissionDecideRequest() = 
        member val SubmissionUID:Guid = new Guid() with get,set
        member val Outcome:String = null with get,set
        member val Reason:String = null with get,set
        member val Note:String = null with get,set
        member val Counter:FormCounterSignature = null with get,set
        member val From:String = null with get,set

F# 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"}}}