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

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

<FormSubmissionRecordResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Record>
    <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>
    <CanEdit>false</CanEdit>
    <CanSensitive>false</CanSensitive>
    <Computed>
      <FormRecordComputed>
        <L>String</L>
        <V>String</V>
      </FormRecordComputed>
    </Computed>
    <ContactName>String</ContactName>
    <CurrentVersionNo>0</CurrentVersionNo>
    <DocCount>String</DocCount>
    <Docs>
      <FormRecordDoc>
        <Name>String</Name>
        <Ok>false</Ok>
        <Tag>String</Tag>
        <Tone>String</Tone>
      </FormRecordDoc>
    </Docs>
    <Email>String</Email>
    <FormName>String</FormName>
    <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
    <Meta>String</Meta>
    <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>
    <People>
      <FormPerson>
        <AgentId>0</AgentId>
        <AgentName>String</AgentName>
      </FormPerson>
    </People>
    <Phone>String</Phone>
    <Sections>
      <FormRecordSection>
        <Rows>
          <FormRecordRow>
            <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>
            <NoFiles>false</NoFiles>
            <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>
    <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>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Tags>
    <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>
  </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>
</FormSubmissionRecordResponse>