Trendsic Platform Service

<back to all web services

PlanSetDetailRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/plansets/{PlanSetUID}
import Foundation
import ServiceStack

public class PlanSetDetailRequest : Codable
{
    public var planSetUID:String

    required public init(){}
}

public class PlanSetResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var planSet:PlanSet
    public var removedSheets:[Sheet] = []

    required public init(){}
}

public class PlanSet : Codable
{
    public var planSetID:Int
    public var planSetUID:String
    public var projectID:Int
    public var name:String
    public var source:String
    public var sourceLabel:String
    public var issuedDate:Date?
    public var attachmentId:String
    public var attachmentName:String
    public var fileSizeInKB:Double?
    public var versionNo:Int
    public var status:String
    public var progress:Int
    public var pageCount:Int
    public var sheetCount:Int
    public var extractMode:String
    public var errorText:String
    public var supersedesPlanSetID:Int?
    public var supersedesName:String
    public var isCurrent:Bool
    public var createdBy:String
    public var createdAt:Date?
    public var processedAt:Date?
    public var ageSeconds:Int
    public var sheets:[Sheet] = []
    public var headline:String

    required public init(){}
}

public class Sheet : Codable
{
    public var sheetID:Int
    public var planSetID:Int
    public var planSetUID:String?
    public var planSetName:String
    public var projectID:Int
    public var pageIndex:Int
    public var attachmentId:String
    public var versionNo:Int
    public var sheetNumber:String
    public var sheetKey:String
    public var title:String
    public var discipline:String
    public var revision:String
    public var revisionDate:Date?
    public var widthPt:Double
    public var heightPt:Double
    public var thumbKey:String
    public var thumbUrl:String
    public var thumbHash:String
    public var extractSource:String
    public var confidence:Double?
    public var changeKind:String
    public var supersedesSheetID:Int?
    public var isCurrent:Bool
    public var pinCount:Int
    public var updatedBy:String
    public var updatedAt:Date?
    public var pins:[SheetPin] = []

    required public init(){}
}

public class SheetPin : Codable
{
    public var sheetPinID:Int
    public var sheetID:Int
    public var entityType:String
    public var entityID:Int?
    public var entityUID:String?
    public var x:Double
    public var y:Double
    public var label:String
    public var createdBy:String
    public var createdAt:Date?
    public var entityNo:String
    public var entityTitle:String
    public var entityStatus:String
    public var inspectionUID:String?
    public var sheetNumber:String
    public var sheetTitle:String
    public var planSetID:Int?
    public var planSetUID:String?
    public var planSetName:String

    required public init(){}
}


Swift PlanSetDetailRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /v1/plansets/{PlanSetUID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","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-01T00:00:00.0000000","ProcessedAt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","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-01T00:00:00.0000000","Pins":[{"SheetPinID":0,"SheetID":0,"EntityType":"String","EntityID":0,"EntityUID":"00000000000000000000000000000000","X":0,"Y":0,"Label":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","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-01T00:00:00.0000000","Pins":[{"SheetPinID":0,"SheetID":0,"EntityType":"String","EntityID":0,"EntityUID":"00000000000000000000000000000000","X":0,"Y":0,"Label":"String","CreatedBy":"String","CreatedAt":"0001-01-01T00:00:00.0000000","EntityNo":"String","EntityTitle":"String","EntityStatus":"String","InspectionUID":"00000000000000000000000000000000","SheetNumber":"String","SheetTitle":"String","PlanSetID":0,"PlanSetUID":"00000000000000000000000000000000","PlanSetName":"String"}]}]}