Trendsic Platform Service

<back to all web services

ImportPreviewRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/import/{Type}/preview
import 'package:servicestack/servicestack.dart';

class ImportRowResult implements IConvertible
{
    int? Line;
    String? Action;
    String? Field;
    String? Message;
    String? Summary;

    ImportRowResult({this.Line,this.Action,this.Field,this.Message,this.Summary});
    ImportRowResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Line = json['Line'];
        Action = json['Action'];
        Field = json['Field'];
        Message = json['Message'];
        Summary = json['Summary'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Line': Line,
        'Action': Action,
        'Field': Field,
        'Message': Message,
        'Summary': Summary
    };

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

class ImportResult implements IConvertible
{
    String? ImportType;
    String? FileName;
    bool? DryRun;
    int? ImportBatchId;
    int? TotalRows;
    int? NewRows;
    int? UpdatedRows;
    int? SkippedRows;
    int? ErrorRows;
    List<ImportRowResult>? Rows = [];
    ResponseStatus? ResponseStatus;

    ImportResult({this.ImportType,this.FileName,this.DryRun,this.ImportBatchId,this.TotalRows,this.NewRows,this.UpdatedRows,this.SkippedRows,this.ErrorRows,this.Rows,this.ResponseStatus});
    ImportResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ImportType = json['ImportType'];
        FileName = json['FileName'];
        DryRun = json['DryRun'];
        ImportBatchId = json['ImportBatchId'];
        TotalRows = json['TotalRows'];
        NewRows = json['NewRows'];
        UpdatedRows = json['UpdatedRows'];
        SkippedRows = json['SkippedRows'];
        ErrorRows = json['ErrorRows'];
        Rows = JsonConverters.fromJson(json['Rows'],'List<ImportRowResult>',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ImportType': ImportType,
        'FileName': FileName,
        'DryRun': DryRun,
        'ImportBatchId': ImportBatchId,
        'TotalRows': TotalRows,
        'NewRows': NewRows,
        'UpdatedRows': UpdatedRows,
        'SkippedRows': SkippedRows,
        'ErrorRows': ErrorRows,
        'Rows': JsonConverters.toJson(Rows,'List<ImportRowResult>',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

class ImportPreviewRequest implements IConvertible
{
    String? Type;

    ImportPreviewRequest({this.Type});
    ImportPreviewRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Type': Type
    };

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

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

Dart ImportPreviewRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/import/{Type}/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Type":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ImportType":"String","FileName":"String","DryRun":false,"ImportBatchId":0,"TotalRows":0,"NewRows":0,"UpdatedRows":0,"SkippedRows":0,"ErrorRows":0,"Rows":[{"Line":0,"Action":"String","Field":"String","Message":"String","Summary":"String"}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}