Trendsic Platform Service

<back to all web services

FormSubmissionRequestPreviewRequest

Requires Authentication
The following routes are available for this service:
POST/v1/forms/submissions/{SubmissionUID}/request-info/preview
import 'package:servicestack/servicestack.dart';

class FormRequestItem implements IConvertible
{
    String? K;
    String? L;
    String? Tag;
    String? Tone;
    bool? Pre;
    bool? IsSignature;
    bool? IsSensitive;
    int? Pi;

    FormRequestItem({this.K,this.L,this.Tag,this.Tone,this.Pre,this.IsSignature,this.IsSensitive,this.Pi});
    FormRequestItem.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        K = json['K'];
        L = json['L'];
        Tag = json['Tag'];
        Tone = json['Tone'];
        Pre = json['Pre'];
        IsSignature = json['IsSignature'];
        IsSensitive = json['IsSensitive'];
        Pi = json['Pi'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'K': K,
        'L': L,
        'Tag': Tag,
        'Tone': Tone,
        'Pre': Pre,
        'IsSignature': IsSignature,
        'IsSensitive': IsSensitive,
        'Pi': Pi
    };

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

class FormRequestPlan implements IConvertible
{
    List<FormRequestItem>? Items = [];
    List<String>? Keys = [];
    List<String>? Resign = [];
    List<String>? ResignKeys = [];
    String? Channels;
    String? StageLabel;
    String? Consequence;
    String? Applicant;
    String? Stage;
    bool? CanSend;
    String? Refusal;

    FormRequestPlan({this.Items,this.Keys,this.Resign,this.ResignKeys,this.Channels,this.StageLabel,this.Consequence,this.Applicant,this.Stage,this.CanSend,this.Refusal});
    FormRequestPlan.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Items = JsonConverters.fromJson(json['Items'],'List<FormRequestItem>',context!);
        Keys = JsonConverters.fromJson(json['Keys'],'List<String>',context!);
        Resign = JsonConverters.fromJson(json['Resign'],'List<String>',context!);
        ResignKeys = JsonConverters.fromJson(json['ResignKeys'],'List<String>',context!);
        Channels = json['Channels'];
        StageLabel = json['StageLabel'];
        Consequence = json['Consequence'];
        Applicant = json['Applicant'];
        Stage = json['Stage'];
        CanSend = json['CanSend'];
        Refusal = json['Refusal'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Items': JsonConverters.toJson(Items,'List<FormRequestItem>',context!),
        'Keys': JsonConverters.toJson(Keys,'List<String>',context!),
        'Resign': JsonConverters.toJson(Resign,'List<String>',context!),
        'ResignKeys': JsonConverters.toJson(ResignKeys,'List<String>',context!),
        'Channels': Channels,
        'StageLabel': StageLabel,
        'Consequence': Consequence,
        'Applicant': Applicant,
        'Stage': Stage,
        'CanSend': CanSend,
        'Refusal': Refusal
    };

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

class FormSubmissionRequestPreviewResponse implements IConvertible
{
    FormRequestPlan? Plan;
    ResponseStatus? ResponseStatus;

    FormSubmissionRequestPreviewResponse({this.Plan,this.ResponseStatus});
    FormSubmissionRequestPreviewResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Plan = JsonConverters.fromJson(json['Plan'],'FormRequestPlan',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Plan': JsonConverters.toJson(Plan,'FormRequestPlan',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

class FormSubmissionRequestPreviewRequest implements IConvertible
{
    String? SubmissionUID;
    List<String>? Keys = [];

    FormSubmissionRequestPreviewRequest({this.SubmissionUID,this.Keys});
    FormSubmissionRequestPreviewRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'FormRequestItem': TypeInfo(TypeOf.Class, create:() => FormRequestItem()),
    'FormRequestPlan': TypeInfo(TypeOf.Class, create:() => FormRequestPlan()),
    'List<FormRequestItem>': TypeInfo(TypeOf.Class, create:() => <FormRequestItem>[]),
    'FormSubmissionRequestPreviewResponse': TypeInfo(TypeOf.Class, create:() => FormSubmissionRequestPreviewResponse()),
    'FormSubmissionRequestPreviewRequest': TypeInfo(TypeOf.Class, create:() => FormSubmissionRequestPreviewRequest()),
});

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

<FormSubmissionRequestPreviewRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Keys xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Keys>
  <SubmissionUID>00000000-0000-0000-0000-000000000000</SubmissionUID>
</FormSubmissionRequestPreviewRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FormSubmissionRequestPreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Plan>
    <Applicant>String</Applicant>
    <CanSend>false</CanSend>
    <Channels>String</Channels>
    <Consequence>String</Consequence>
    <Items>
      <FormRequestItem>
        <IsSensitive>false</IsSensitive>
        <IsSignature>false</IsSignature>
        <K>String</K>
        <L>String</L>
        <Pi>0</Pi>
        <Pre>false</Pre>
        <Tag>String</Tag>
        <Tone>String</Tone>
      </FormRequestItem>
    </Items>
    <Keys xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Keys>
    <Refusal>String</Refusal>
    <Resign xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Resign>
    <ResignKeys xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </ResignKeys>
    <Stage>String</Stage>
    <StageLabel>String</StageLabel>
  </Plan>
  <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>
</FormSubmissionRequestPreviewResponse>