| POST | /v1/forms/submissions/search |
|---|
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 FormInboxRow() =
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 VersionNo:Int32 = new Int32() with get,set
member val Number:String = null with get,set
member val ApplicantName:String = null with get,set
member val Stage:String = null with get,set
member val StageLabel:String = null with get,set
member val StageTone:String = null 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 SubmittedText:String = null with get,set
member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set
member val DocsOk:Int32 = new Int32() with get,set
member val DocsNeed:Int32 = new Int32() with get,set
member val IsTest:Boolean = new Boolean() with get,set
member val VersionText:String = null with get,set
[<AllowNullLiteral>]
type FormInboxCount() =
member val V:String = null with get,set
member val L:String = null with get,set
member val N:Int32 = new Int32() with get,set
[<AllowNullLiteral>]
type FormInboxCounts() =
member val Stages:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set
member val Assignees:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set
member val Branches:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set
member val Tags:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set
member val Forms:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set
member val Flags:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set
[<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 FormFilterOpt() =
member val Id:String = null with get,set
member val L:String = null with get,set
[<AllowNullLiteral>]
type FormFilterField() =
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 Opts:ResizeArray<FormFilterOpt> = new ResizeArray<FormFilterOpt>() with get,set
[<AllowNullLiteral>]
type FormSubmissionSearchResponse() =
member val Rows:ResizeArray<FormInboxRow> = new ResizeArray<FormInboxRow>() with get,set
member val Matching:Int32 = new Int32() with get,set
member val ScopeTotal:Int32 = new Int32() with get,set
member val StageMatching:ResizeArray<FormInboxCount> = new ResizeArray<FormInboxCount>() with get,set
member val Counts:FormInboxCounts = null with get,set
member val Stages:ResizeArray<FormStageInfo> = new ResizeArray<FormStageInfo>() with get,set
member val Capped:Boolean = new Boolean() with get,set
member val FilterFields:ResizeArray<FormFilterField> = new ResizeArray<FormFilterField>() with get,set
member val TagOptions:ResizeArray<String> = new ResizeArray<String>() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type FormAnswerCond() =
member val F:String = null with get,set
member val Op:String = null with get,set
member val V:String = null with get,set
[<AllowNullLiteral>]
type FormSubmissionSearchRequest() =
member val FormUID:Nullable<Guid> = new Nullable<Guid>() with get,set
member val Mode:String = null with get,set
member val Forms:ResizeArray<Guid> = new ResizeArray<Guid>() with get,set
member val Stages:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Assignees:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
member val Branches:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Tags:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Search:String = null with get,set
member val SortKey:String = null with get,set
member val SortDir:Int32 = new Int32() with get,set
member val Skip:Int32 = new Int32() with get,set
member val Take:Int32 = new Int32() with get,set
member val Conds:ResizeArray<FormAnswerCond> = new ResizeArray<FormAnswerCond>() with get,set
member val Flags:ResizeArray<String> = new ResizeArray<String>() with get,set
F# FormSubmissionSearchRequest DTOs
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/search HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FormSubmissionSearchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Assignees xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</Assignees>
<Branches xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Branches>
<Conds>
<FormAnswerCond>
<F>String</F>
<Op>String</Op>
<V>String</V>
</FormAnswerCond>
</Conds>
<Flags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Flags>
<FormUID>00000000-0000-0000-0000-000000000000</FormUID>
<Forms xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
</Forms>
<Mode>String</Mode>
<Search>String</Search>
<Skip>0</Skip>
<SortDir>0</SortDir>
<SortKey>String</SortKey>
<Stages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Stages>
<Tags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</Tags>
<Take>0</Take>
</FormSubmissionSearchRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<FormSubmissionSearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Capped>false</Capped>
<Counts>
<Assignees>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</Assignees>
<Branches>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</Branches>
<Flags>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</Flags>
<Forms>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</Forms>
<Stages>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</Stages>
<Tags>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</Tags>
</Counts>
<FilterFields>
<FormFilterField>
<K>String</K>
<L>String</L>
<Opts>
<FormFilterOpt>
<Id>String</Id>
<L>String</L>
</FormFilterOpt>
</Opts>
<T>String</T>
</FormFilterField>
</FilterFields>
<Matching>0</Matching>
<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>
<Rows>
<FormInboxRow>
<ApplicantName>String</ApplicantName>
<AssigneeAgentId>0</AssigneeAgentId>
<AssigneeName>String</AssigneeName>
<BranchName>String</BranchName>
<DocsNeed>0</DocsNeed>
<DocsOk>0</DocsOk>
<FormName>String</FormName>
<FormUID>00000000-0000-0000-0000-000000000000</FormUID>
<IsTest>false</IsTest>
<Number>String</Number>
<Stage>String</Stage>
<StageLabel>String</StageLabel>
<StageTone>String</StageTone>
<SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
<SubmittedAt>0001-01-01T00:00:00</SubmittedAt>
<SubmittedText>String</SubmittedText>
<Tags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Tags>
<VersionNo>0</VersionNo>
<VersionText>String</VersionText>
</FormInboxRow>
</Rows>
<ScopeTotal>0</ScopeTotal>
<StageMatching>
<FormInboxCount>
<L>String</L>
<N>0</N>
<V>String</V>
</FormInboxCount>
</StageMatching>
<Stages>
<FormStageInfo>
<Id>String</Id>
<Kind>String</Kind>
<Label>String</Label>
<Tone>String</Tone>
</FormStageInfo>
</Stages>
<TagOptions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>String</d2p1:string>
</TagOptions>
</FormSubmissionSearchResponse>