Trendsic Platform Service

<back to all web services

PlanSetUploadRequest

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

class SheetPin implements IConvertible
{
    int? SheetPinID;
    int? SheetID;
    String? EntityType;
    int? EntityID;
    String? EntityUID;
    double? X;
    double? Y;
    String? Label;
    String? CreatedBy;
    DateTime? CreatedAt;
    String? EntityNo;
    String? EntityTitle;
    String? EntityStatus;
    String? InspectionUID;
    String? SheetNumber;
    String? SheetTitle;
    int? PlanSetID;
    String? PlanSetUID;
    String? PlanSetName;

    SheetPin({this.SheetPinID,this.SheetID,this.EntityType,this.EntityID,this.EntityUID,this.X,this.Y,this.Label,this.CreatedBy,this.CreatedAt,this.EntityNo,this.EntityTitle,this.EntityStatus,this.InspectionUID,this.SheetNumber,this.SheetTitle,this.PlanSetID,this.PlanSetUID,this.PlanSetName});
    SheetPin.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SheetPinID = json['SheetPinID'];
        SheetID = json['SheetID'];
        EntityType = json['EntityType'];
        EntityID = json['EntityID'];
        EntityUID = json['EntityUID'];
        X = JsonConverters.toDouble(json['X']);
        Y = JsonConverters.toDouble(json['Y']);
        Label = json['Label'];
        CreatedBy = json['CreatedBy'];
        CreatedAt = JsonConverters.fromJson(json['CreatedAt'],'DateTime',context!);
        EntityNo = json['EntityNo'];
        EntityTitle = json['EntityTitle'];
        EntityStatus = json['EntityStatus'];
        InspectionUID = json['InspectionUID'];
        SheetNumber = json['SheetNumber'];
        SheetTitle = json['SheetTitle'];
        PlanSetID = json['PlanSetID'];
        PlanSetUID = json['PlanSetUID'];
        PlanSetName = json['PlanSetName'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SheetPinID': SheetPinID,
        'SheetID': SheetID,
        'EntityType': EntityType,
        'EntityID': EntityID,
        'EntityUID': EntityUID,
        'X': X,
        'Y': Y,
        'Label': Label,
        'CreatedBy': CreatedBy,
        'CreatedAt': JsonConverters.toJson(CreatedAt,'DateTime',context!),
        'EntityNo': EntityNo,
        'EntityTitle': EntityTitle,
        'EntityStatus': EntityStatus,
        'InspectionUID': InspectionUID,
        'SheetNumber': SheetNumber,
        'SheetTitle': SheetTitle,
        'PlanSetID': PlanSetID,
        'PlanSetUID': PlanSetUID,
        'PlanSetName': PlanSetName
    };

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

class Sheet implements IConvertible
{
    int? SheetID;
    int? PlanSetID;
    String? PlanSetUID;
    String? PlanSetName;
    int? ProjectID;
    int? PageIndex;
    String? AttachmentId;
    int? VersionNo;
    String? SheetNumber;
    String? SheetKey;
    String? Title;
    String? Discipline;
    String? Revision;
    DateTime? RevisionDate;
    double? WidthPt;
    double? HeightPt;
    String? ThumbKey;
    String? ThumbUrl;
    String? ThumbHash;
    String? ExtractSource;
    double? Confidence;
    String? ChangeKind;
    int? SupersedesSheetID;
    bool? IsCurrent;
    int? PinCount;
    String? UpdatedBy;
    DateTime? UpdatedAt;
    List<SheetPin>? Pins = [];

    Sheet({this.SheetID,this.PlanSetID,this.PlanSetUID,this.PlanSetName,this.ProjectID,this.PageIndex,this.AttachmentId,this.VersionNo,this.SheetNumber,this.SheetKey,this.Title,this.Discipline,this.Revision,this.RevisionDate,this.WidthPt,this.HeightPt,this.ThumbKey,this.ThumbUrl,this.ThumbHash,this.ExtractSource,this.Confidence,this.ChangeKind,this.SupersedesSheetID,this.IsCurrent,this.PinCount,this.UpdatedBy,this.UpdatedAt,this.Pins});
    Sheet.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        SheetID = json['SheetID'];
        PlanSetID = json['PlanSetID'];
        PlanSetUID = json['PlanSetUID'];
        PlanSetName = json['PlanSetName'];
        ProjectID = json['ProjectID'];
        PageIndex = json['PageIndex'];
        AttachmentId = json['AttachmentId'];
        VersionNo = json['VersionNo'];
        SheetNumber = json['SheetNumber'];
        SheetKey = json['SheetKey'];
        Title = json['Title'];
        Discipline = json['Discipline'];
        Revision = json['Revision'];
        RevisionDate = JsonConverters.fromJson(json['RevisionDate'],'DateTime',context!);
        WidthPt = JsonConverters.toDouble(json['WidthPt']);
        HeightPt = JsonConverters.toDouble(json['HeightPt']);
        ThumbKey = json['ThumbKey'];
        ThumbUrl = json['ThumbUrl'];
        ThumbHash = json['ThumbHash'];
        ExtractSource = json['ExtractSource'];
        Confidence = JsonConverters.toDouble(json['Confidence']);
        ChangeKind = json['ChangeKind'];
        SupersedesSheetID = json['SupersedesSheetID'];
        IsCurrent = json['IsCurrent'];
        PinCount = json['PinCount'];
        UpdatedBy = json['UpdatedBy'];
        UpdatedAt = JsonConverters.fromJson(json['UpdatedAt'],'DateTime',context!);
        Pins = JsonConverters.fromJson(json['Pins'],'List<SheetPin>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'SheetID': SheetID,
        'PlanSetID': PlanSetID,
        'PlanSetUID': PlanSetUID,
        'PlanSetName': PlanSetName,
        'ProjectID': ProjectID,
        'PageIndex': PageIndex,
        'AttachmentId': AttachmentId,
        'VersionNo': VersionNo,
        'SheetNumber': SheetNumber,
        'SheetKey': SheetKey,
        'Title': Title,
        'Discipline': Discipline,
        'Revision': Revision,
        'RevisionDate': JsonConverters.toJson(RevisionDate,'DateTime',context!),
        'WidthPt': WidthPt,
        'HeightPt': HeightPt,
        'ThumbKey': ThumbKey,
        'ThumbUrl': ThumbUrl,
        'ThumbHash': ThumbHash,
        'ExtractSource': ExtractSource,
        'Confidence': Confidence,
        'ChangeKind': ChangeKind,
        'SupersedesSheetID': SupersedesSheetID,
        'IsCurrent': IsCurrent,
        'PinCount': PinCount,
        'UpdatedBy': UpdatedBy,
        'UpdatedAt': JsonConverters.toJson(UpdatedAt,'DateTime',context!),
        'Pins': JsonConverters.toJson(Pins,'List<SheetPin>',context!)
    };

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

class PlanSet implements IConvertible
{
    int? PlanSetID;
    String? PlanSetUID;
    int? ProjectID;
    String? Name;
    String? Source;
    String? SourceLabel;
    DateTime? IssuedDate;
    String? AttachmentId;
    String? AttachmentName;
    double? FileSizeInKB;
    int? VersionNo;
    String? Status;
    int? Progress;
    int? PageCount;
    int? SheetCount;
    String? ExtractMode;
    String? ErrorText;
    int? SupersedesPlanSetID;
    String? SupersedesName;
    bool? IsCurrent;
    String? CreatedBy;
    DateTime? CreatedAt;
    DateTime? ProcessedAt;
    int? AgeSeconds;
    List<Sheet>? Sheets = [];
    String? Headline;

    PlanSet({this.PlanSetID,this.PlanSetUID,this.ProjectID,this.Name,this.Source,this.SourceLabel,this.IssuedDate,this.AttachmentId,this.AttachmentName,this.FileSizeInKB,this.VersionNo,this.Status,this.Progress,this.PageCount,this.SheetCount,this.ExtractMode,this.ErrorText,this.SupersedesPlanSetID,this.SupersedesName,this.IsCurrent,this.CreatedBy,this.CreatedAt,this.ProcessedAt,this.AgeSeconds,this.Sheets,this.Headline});
    PlanSet.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        PlanSetID = json['PlanSetID'];
        PlanSetUID = json['PlanSetUID'];
        ProjectID = json['ProjectID'];
        Name = json['Name'];
        Source = json['Source'];
        SourceLabel = json['SourceLabel'];
        IssuedDate = JsonConverters.fromJson(json['IssuedDate'],'DateTime',context!);
        AttachmentId = json['AttachmentId'];
        AttachmentName = json['AttachmentName'];
        FileSizeInKB = JsonConverters.toDouble(json['FileSizeInKB']);
        VersionNo = json['VersionNo'];
        Status = json['Status'];
        Progress = json['Progress'];
        PageCount = json['PageCount'];
        SheetCount = json['SheetCount'];
        ExtractMode = json['ExtractMode'];
        ErrorText = json['ErrorText'];
        SupersedesPlanSetID = json['SupersedesPlanSetID'];
        SupersedesName = json['SupersedesName'];
        IsCurrent = json['IsCurrent'];
        CreatedBy = json['CreatedBy'];
        CreatedAt = JsonConverters.fromJson(json['CreatedAt'],'DateTime',context!);
        ProcessedAt = JsonConverters.fromJson(json['ProcessedAt'],'DateTime',context!);
        AgeSeconds = json['AgeSeconds'];
        Sheets = JsonConverters.fromJson(json['Sheets'],'List<Sheet>',context!);
        Headline = json['Headline'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'PlanSetID': PlanSetID,
        'PlanSetUID': PlanSetUID,
        'ProjectID': ProjectID,
        'Name': Name,
        'Source': Source,
        'SourceLabel': SourceLabel,
        'IssuedDate': JsonConverters.toJson(IssuedDate,'DateTime',context!),
        'AttachmentId': AttachmentId,
        'AttachmentName': AttachmentName,
        'FileSizeInKB': FileSizeInKB,
        'VersionNo': VersionNo,
        'Status': Status,
        'Progress': Progress,
        'PageCount': PageCount,
        'SheetCount': SheetCount,
        'ExtractMode': ExtractMode,
        'ErrorText': ErrorText,
        'SupersedesPlanSetID': SupersedesPlanSetID,
        'SupersedesName': SupersedesName,
        'IsCurrent': IsCurrent,
        'CreatedBy': CreatedBy,
        'CreatedAt': JsonConverters.toJson(CreatedAt,'DateTime',context!),
        'ProcessedAt': JsonConverters.toJson(ProcessedAt,'DateTime',context!),
        'AgeSeconds': AgeSeconds,
        'Sheets': JsonConverters.toJson(Sheets,'List<Sheet>',context!),
        'Headline': Headline
    };

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

class PlanSetResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    PlanSet? PlanSet;
    List<Sheet>? RemovedSheets = [];

    PlanSetResponse({this.ResponseStatus,this.PlanSet,this.RemovedSheets});
    PlanSetResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'PlanSet': JsonConverters.toJson(PlanSet,'PlanSet',context!),
        'RemovedSheets': JsonConverters.toJson(RemovedSheets,'List<Sheet>',context!)
    };

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

class PlanSetUploadRequest implements IConvertible
{
    int? ProjectID;
    String? Name;
    String? Source;
    String? IssuedDate;
    String? SupersedesPlanSetUID;
    String? ExtractMode;
    bool? Standalone;

    PlanSetUploadRequest({this.ProjectID,this.Name,this.Source,this.IssuedDate,this.SupersedesPlanSetUID,this.ExtractMode,this.Standalone});
    PlanSetUploadRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ProjectID = json['ProjectID'];
        Name = json['Name'];
        Source = json['Source'];
        IssuedDate = json['IssuedDate'];
        SupersedesPlanSetUID = json['SupersedesPlanSetUID'];
        ExtractMode = json['ExtractMode'];
        Standalone = json['Standalone'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ProjectID': ProjectID,
        'Name': Name,
        'Source': Source,
        'IssuedDate': IssuedDate,
        'SupersedesPlanSetUID': SupersedesPlanSetUID,
        'ExtractMode': ExtractMode,
        'Standalone': Standalone
    };

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'SheetPin': TypeInfo(TypeOf.Class, create:() => SheetPin()),
    'Sheet': TypeInfo(TypeOf.Class, create:() => Sheet()),
    'List<SheetPin>': TypeInfo(TypeOf.Class, create:() => <SheetPin>[]),
    'PlanSet': TypeInfo(TypeOf.Class, create:() => PlanSet()),
    'List<Sheet>': TypeInfo(TypeOf.Class, create:() => <Sheet>[]),
    'PlanSetResponse': TypeInfo(TypeOf.Class, create:() => PlanSetResponse()),
    'PlanSetUploadRequest': TypeInfo(TypeOf.Class, create:() => PlanSetUploadRequest()),
});

Dart PlanSetUploadRequest DTOs

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

HTTP + JSV

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

POST /v1/projects/{ProjectID}/plansets HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProjectID: 0,
	Name: String,
	Source: String,
	IssuedDate: String,
	SupersedesPlanSetUID: 00000000000000000000000000000000,
	ExtractMode: String,
	Standalone: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	PlanSet: 
	{
		PlanSetID: 0,
		PlanSetUID: 00000000000000000000000000000000,
		ProjectID: 0,
		Name: String,
		Source: String,
		SourceLabel: String,
		IssuedDate: 0001-01-01,
		AttachmentId: 00000000000000000000000000000000,
		AttachmentName: String,
		FileSizeInKB: 0,
		VersionNo: 0,
		Status: String,
		Progress: 0,
		PageCount: 0,
		SheetCount: 0,
		ExtractMode: String,
		ErrorText: String,
		SupersedesPlanSetID: 0,
		SupersedesName: String,
		IsCurrent: False,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		ProcessedAt: 0001-01-01,
		AgeSeconds: 0,
		Sheets: 
		[
			{
				SheetID: 0,
				PlanSetID: 0,
				PlanSetUID: 00000000000000000000000000000000,
				PlanSetName: String,
				ProjectID: 0,
				PageIndex: 0,
				AttachmentId: 00000000000000000000000000000000,
				VersionNo: 0,
				SheetNumber: String,
				SheetKey: String,
				Title: String,
				Discipline: String,
				Revision: String,
				RevisionDate: 0001-01-01,
				WidthPt: 0,
				HeightPt: 0,
				ThumbKey: String,
				ThumbUrl: String,
				ThumbHash: String,
				ExtractSource: String,
				Confidence: 0,
				ChangeKind: String,
				SupersedesSheetID: 0,
				IsCurrent: False,
				PinCount: 0,
				UpdatedBy: String,
				UpdatedAt: 0001-01-01,
				Pins: 
				[
					{
						SheetPinID: 0,
						SheetID: 0,
						EntityType: String,
						EntityID: 0,
						EntityUID: 00000000000000000000000000000000,
						X: 0,
						Y: 0,
						Label: String,
						CreatedBy: String,
						CreatedAt: 0001-01-01,
						EntityNo: String,
						EntityTitle: String,
						EntityStatus: String,
						InspectionUID: 00000000000000000000000000000000,
						SheetNumber: String,
						SheetTitle: String,
						PlanSetID: 0,
						PlanSetUID: 00000000000000000000000000000000,
						PlanSetName: String
					}
				]
			}
		],
		Headline: String
	},
	RemovedSheets: 
	[
		{
			SheetID: 0,
			PlanSetID: 0,
			PlanSetUID: 00000000000000000000000000000000,
			PlanSetName: String,
			ProjectID: 0,
			PageIndex: 0,
			AttachmentId: 00000000000000000000000000000000,
			VersionNo: 0,
			SheetNumber: String,
			SheetKey: String,
			Title: String,
			Discipline: String,
			Revision: String,
			RevisionDate: 0001-01-01,
			WidthPt: 0,
			HeightPt: 0,
			ThumbKey: String,
			ThumbUrl: String,
			ThumbHash: String,
			ExtractSource: String,
			Confidence: 0,
			ChangeKind: String,
			SupersedesSheetID: 0,
			IsCurrent: False,
			PinCount: 0,
			UpdatedBy: String,
			UpdatedAt: 0001-01-01,
			Pins: 
			[
				{
					SheetPinID: 0,
					SheetID: 0,
					EntityType: String,
					EntityID: 0,
					EntityUID: 00000000000000000000000000000000,
					X: 0,
					Y: 0,
					Label: String,
					CreatedBy: String,
					CreatedAt: 0001-01-01,
					EntityNo: String,
					EntityTitle: String,
					EntityStatus: String,
					InspectionUID: 00000000000000000000000000000000,
					SheetNumber: String,
					SheetTitle: String,
					PlanSetID: 0,
					PlanSetUID: 00000000000000000000000000000000,
					PlanSetName: String
				}
			]
		}
	]
}