Trendsic Platform Service

<back to all web services

FormSubmissionSearchRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/search
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class FormAnswerCond
    {
        public virtual string F { get; set; }
        public virtual string Op { get; set; }
        public virtual string V { get; set; }
    }

    public partial class FormFilterField
    {
        public virtual string K { get; set; }
        public virtual string L { get; set; }
        public virtual string T { get; set; }
        public virtual List<FormFilterOpt> Opts { get; set; } = [];
    }

    public partial class FormFilterOpt
    {
        public virtual string Id { get; set; }
        public virtual string L { get; set; }
    }

    public partial class FormInboxCount
    {
        public virtual string V { get; set; }
        public virtual string L { get; set; }
        public virtual int N { get; set; }
    }

    public partial class FormInboxCounts
    {
        public virtual List<FormInboxCount> Stages { get; set; } = [];
        public virtual List<FormInboxCount> Assignees { get; set; } = [];
        public virtual List<FormInboxCount> Branches { get; set; } = [];
        public virtual List<FormInboxCount> Tags { get; set; } = [];
        public virtual List<FormInboxCount> Forms { get; set; } = [];
        public virtual List<FormInboxCount> Flags { get; set; } = [];
    }

    public partial class FormInboxRow
    {
        public virtual Guid SubmissionUID { get; set; }
        public virtual Guid FormUID { get; set; }
        public virtual string FormName { get; set; }
        public virtual int VersionNo { get; set; }
        public virtual string Number { get; set; }
        public virtual string ApplicantName { get; set; }
        public virtual string Stage { get; set; }
        public virtual string StageLabel { get; set; }
        public virtual string StageTone { get; set; }
        public virtual int? AssigneeAgentId { get; set; }
        public virtual string AssigneeName { get; set; }
        public virtual string BranchName { get; set; }
        public virtual DateTime? SubmittedAt { get; set; }
        public virtual string SubmittedText { get; set; }
        public virtual List<string> Tags { get; set; } = [];
        public virtual int DocsOk { get; set; }
        public virtual int DocsNeed { get; set; }
        public virtual bool IsTest { get; set; }
        public virtual string VersionText { get; set; }
    }

    public partial class FormStageInfo
    {
        public virtual string Id { get; set; }
        public virtual string Label { get; set; }
        public virtual string Tone { get; set; }
        public virtual string Kind { get; set; }
    }

    public partial class FormSubmissionSearchRequest
    {
        public virtual Guid? FormUID { get; set; }
        public virtual string Mode { get; set; }
        public virtual List<Guid> Forms { get; set; } = [];
        public virtual List<string> Stages { get; set; } = [];
        public virtual List<int> Assignees { get; set; } = [];
        public virtual List<string> Branches { get; set; } = [];
        public virtual List<string> Tags { get; set; } = [];
        public virtual string Search { get; set; }
        public virtual string SortKey { get; set; }
        public virtual int SortDir { get; set; }
        public virtual int Skip { get; set; }
        public virtual int Take { get; set; }
        public virtual List<FormAnswerCond> Conds { get; set; } = [];
        public virtual List<string> Flags { get; set; } = [];
    }

    public partial class FormSubmissionSearchResponse
    {
        public virtual List<FormInboxRow> Rows { get; set; } = [];
        public virtual int Matching { get; set; }
        public virtual int ScopeTotal { get; set; }
        public virtual List<FormInboxCount> StageMatching { get; set; } = [];
        public virtual FormInboxCounts Counts { get; set; }
        public virtual List<FormStageInfo> Stages { get; set; } = [];
        public virtual bool Capped { get; set; }
        public virtual List<FormFilterField> FilterFields { get; set; } = [];
        public virtual List<string> TagOptions { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# FormSubmissionSearchRequest 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/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>