Trendsic Platform Service

<back to all web services

FormSubmissionExportPreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/export/preview
import 'package:servicestack/servicestack.dart';

class FormSubmissionExportPreviewResponse implements IConvertible
{
    int? Rows;
    int? Cap;
    String? FormName;
    bool? CanExport;
    String? Message;
    ResponseStatus? ResponseStatus;

    FormSubmissionExportPreviewResponse({this.Rows,this.Cap,this.FormName,this.CanExport,this.Message,this.ResponseStatus});
    FormSubmissionExportPreviewResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Rows = json['Rows'];
        Cap = json['Cap'];
        FormName = json['FormName'];
        CanExport = json['CanExport'];
        Message = json['Message'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Rows': Rows,
        'Cap': Cap,
        'FormName': FormName,
        'CanExport': CanExport,
        'Message': Message,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "FormSubmissionExportPreviewResponse";
    TypeContext? context = _ctx;
}

class FormAnswerCond implements IConvertible
{
    String? F;
    String? Op;
    String? V;

    FormAnswerCond({this.F,this.Op,this.V});
    FormAnswerCond.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        F = json['F'];
        Op = json['Op'];
        V = json['V'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'F': F,
        'Op': Op,
        'V': V
    };

    getTypeName() => "FormAnswerCond";
    TypeContext? context = _ctx;
}

class FormSubmissionSearchRequest implements IConvertible
{
    String? FormUID;
    String? Mode;
    List<String>? Forms = [];
    List<String>? Stages = [];
    List<int>? Assignees = [];
    List<String>? Branches = [];
    List<String>? Tags = [];
    String? Search;
    String? SortKey;
    int? SortDir;
    int? Skip;
    int? Take;
    List<FormAnswerCond>? Conds = [];
    List<String>? Flags = [];

    FormSubmissionSearchRequest({this.FormUID,this.Mode,this.Forms,this.Stages,this.Assignees,this.Branches,this.Tags,this.Search,this.SortKey,this.SortDir,this.Skip,this.Take,this.Conds,this.Flags});
    FormSubmissionSearchRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FormUID = json['FormUID'];
        Mode = json['Mode'];
        Forms = JsonConverters.fromJson(json['Forms'],'List<String>',context!);
        Stages = JsonConverters.fromJson(json['Stages'],'List<String>',context!);
        Assignees = JsonConverters.fromJson(json['Assignees'],'List<int>',context!);
        Branches = JsonConverters.fromJson(json['Branches'],'List<String>',context!);
        Tags = JsonConverters.fromJson(json['Tags'],'List<String>',context!);
        Search = json['Search'];
        SortKey = json['SortKey'];
        SortDir = json['SortDir'];
        Skip = json['Skip'];
        Take = json['Take'];
        Conds = JsonConverters.fromJson(json['Conds'],'List<FormAnswerCond>',context!);
        Flags = JsonConverters.fromJson(json['Flags'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FormUID': FormUID,
        'Mode': Mode,
        'Forms': JsonConverters.toJson(Forms,'List<String>',context!),
        'Stages': JsonConverters.toJson(Stages,'List<String>',context!),
        'Assignees': JsonConverters.toJson(Assignees,'List<int>',context!),
        'Branches': JsonConverters.toJson(Branches,'List<String>',context!),
        'Tags': JsonConverters.toJson(Tags,'List<String>',context!),
        'Search': Search,
        'SortKey': SortKey,
        'SortDir': SortDir,
        'Skip': Skip,
        'Take': Take,
        'Conds': JsonConverters.toJson(Conds,'List<FormAnswerCond>',context!),
        'Flags': JsonConverters.toJson(Flags,'List<String>',context!)
    };

    getTypeName() => "FormSubmissionSearchRequest";
    TypeContext? context = _ctx;
}

class FormSubmissionExportPreviewRequest implements IConvertible
{
    FormSubmissionSearchRequest? Query;
    List<String>? SubmissionUIDs = [];

    FormSubmissionExportPreviewRequest({this.Query,this.SubmissionUIDs});
    FormSubmissionExportPreviewRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Query = JsonConverters.fromJson(json['Query'],'FormSubmissionSearchRequest',context!);
        SubmissionUIDs = JsonConverters.fromJson(json['SubmissionUIDs'],'List<String>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Query': JsonConverters.toJson(Query,'FormSubmissionSearchRequest',context!),
        'SubmissionUIDs': JsonConverters.toJson(SubmissionUIDs,'List<String>',context!)
    };

    getTypeName() => "FormSubmissionExportPreviewRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'FormSubmissionExportPreviewResponse': TypeInfo(TypeOf.Class, create:() => FormSubmissionExportPreviewResponse()),
    'FormAnswerCond': TypeInfo(TypeOf.Class, create:() => FormAnswerCond()),
    'FormSubmissionSearchRequest': TypeInfo(TypeOf.Class, create:() => FormSubmissionSearchRequest()),
    'List<FormAnswerCond>': TypeInfo(TypeOf.Class, create:() => <FormAnswerCond>[]),
    'FormSubmissionExportPreviewRequest': TypeInfo(TypeOf.Class, create:() => FormSubmissionExportPreviewRequest()),
});

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

<FormSubmissionExportPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Query>
    <Assignees xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </Assignees>
    <Branches xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Branches>
    <Conds>
      <FormAnswerCond>
        <F>String</F>
        <Op>String</Op>
        <V>String</V>
      </FormAnswerCond>
    </Conds>
    <Flags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Flags>
    <FormUID>00000000-0000-0000-0000-000000000000</FormUID>
    <Forms xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:guid>00000000-0000-0000-0000-000000000000</d3p1:guid>
    </Forms>
    <Mode>String</Mode>
    <Search>String</Search>
    <Skip>0</Skip>
    <SortDir>0</SortDir>
    <SortKey>String</SortKey>
    <Stages xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Stages>
    <Tags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Tags>
    <Take>0</Take>
  </Query>
  <SubmissionUIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </SubmissionUIDs>
</FormSubmissionExportPreviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormSubmissionExportPreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CanExport>false</CanExport>
  <Cap>0</Cap>
  <FormName>String</FormName>
  <Message>String</Message>
  <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>0</Rows>
</FormSubmissionExportPreviewResponse>