Trendsic Platform Service

<back to all web services

FormSubmissionStageRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/{SubmissionUID}/stage
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

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

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

    [<AllowNullLiteral>]
    type FormSubmissionStageRequest() = 
        member val SubmissionUID:Guid = new Guid() with get,set
        member val Stage:String = null with get,set
        member val From:String = null with get,set

F# FormSubmissionStageRequest DTOs

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

HTTP + CSV

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

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

{"SubmissionUID":"00000000000000000000000000000000","Stage":"String","From":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"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}}]}],"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"}]},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}