Trendsic Platform Service

<back to all web services

PlanSetListRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/projects/{ProjectID}/plansets
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class PlanSetListRequest
{
    open var ProjectID:Int? = null
}

open class PlanSetListResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var PlanSets:ArrayList<PlanSet> = ArrayList<PlanSet>()
    open var CurrentSheetCount:Int? = null
    open var NeedsReviewCount:Int? = null
}

open class PlanSet
{
    open var PlanSetID:Int? = null
    open var PlanSetUID:UUID? = null
    open var ProjectID:Int? = null
    open var Name:String? = null
    open var Source:String? = null
    open var SourceLabel:String? = null
    open var IssuedDate:Date? = null
    open var AttachmentId:UUID? = null
    open var AttachmentName:String? = null
    open var FileSizeInKB:Double? = null
    open var VersionNo:Int? = null
    open var Status:String? = null
    open var Progress:Int? = null
    open var PageCount:Int? = null
    open var SheetCount:Int? = null
    open var ExtractMode:String? = null
    open var ErrorText:String? = null
    open var SupersedesPlanSetID:Int? = null
    open var SupersedesName:String? = null
    open var IsCurrent:Boolean? = null
    open var CreatedBy:String? = null
    open var CreatedAt:Date? = null
    open var ProcessedAt:Date? = null
    open var AgeSeconds:Int? = null
    open var Sheets:ArrayList<Sheet> = ArrayList<Sheet>()
    open var Headline:String? = null
}

open class Sheet
{
    open var SheetID:Int? = null
    open var PlanSetID:Int? = null
    open var PlanSetUID:UUID? = null
    open var PlanSetName:String? = null
    open var ProjectID:Int? = null
    open var PageIndex:Int? = null
    open var AttachmentId:UUID? = null
    open var VersionNo:Int? = null
    open var SheetNumber:String? = null
    open var SheetKey:String? = null
    open var Title:String? = null
    open var Discipline:String? = null
    open var Revision:String? = null
    open var RevisionDate:Date? = null
    open var WidthPt:Double? = null
    open var HeightPt:Double? = null
    open var ThumbKey:String? = null
    open var ThumbUrl:String? = null
    open var ThumbHash:String? = null
    open var ExtractSource:String? = null
    open var Confidence:Double? = null
    open var ChangeKind:String? = null
    open var SupersedesSheetID:Int? = null
    open var IsCurrent:Boolean? = null
    open var PinCount:Int? = null
    open var UpdatedBy:String? = null
    open var UpdatedAt:Date? = null
    open var Pins:ArrayList<SheetPin> = ArrayList<SheetPin>()
}

open class SheetPin
{
    open var SheetPinID:Int? = null
    open var SheetID:Int? = null
    open var EntityType:String? = null
    open var EntityID:Int? = null
    open var EntityUID:UUID? = null
    open var X:Double? = null
    open var Y:Double? = null
    open var Label:String? = null
    open var CreatedBy:String? = null
    open var CreatedAt:Date? = null
    open var EntityNo:String? = null
    open var EntityTitle:String? = null
    open var EntityStatus:String? = null
    open var InspectionUID:UUID? = null
    open var SheetNumber:String? = null
    open var SheetTitle:String? = null
    open var PlanSetID:Int? = null
    open var PlanSetUID:UUID? = null
    open var PlanSetName:String? = null
}

Kotlin PlanSetListRequest 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.

GET /v1/projects/{ProjectID}/plansets HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	PlanSets: 
	[
		{
			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
		}
	],
	CurrentSheetCount: 0,
	NeedsReviewCount: 0
}