Trendsic Platform Service

PlanSetListRequest

The following routes are available for this service:
GET,OPTIONS	/v1/projects/{ProjectID}/plansets

import Foundation
import ServiceStack

public class PlanSetListRequest : Codable
{
    public var projectID:Int

    required public init(){}
}

public class PlanSetListResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var planSets:[PlanSet] = []
    public var currentSheetCount:Int
    public var needsReviewCount:Int

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

GET /v1/projects/{ProjectID}/plansets HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PlanSetListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CurrentSheetCount>0</CurrentSheetCount>
  <NeedsReviewCount>0</NeedsReviewCount>
  <PlanSets>
    <PlanSet>
      <AgeSeconds>0</AgeSeconds>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <AttachmentName>String</AttachmentName>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <ErrorText>String</ErrorText>
      <ExtractMode>String</ExtractMode>
      <FileSizeInKB>0</FileSizeInKB>
      <Headline>String</Headline>
      <IsCurrent>false</IsCurrent>
      <IssuedDate>0001-01-01T00:00:00</IssuedDate>
      <Name>String</Name>
      <PageCount>0</PageCount>
      <PlanSetID>0</PlanSetID>
      <PlanSetUID>00000000-0000-0000-0000-000000000000</PlanSetUID>
      <ProcessedAt>0001-01-01T00:00:00</ProcessedAt>
      <Progress>0</Progress>
      <ProjectID>0</ProjectID>
      <SheetCount>0</SheetCount>
      <Sheets>
        <Sheet>
          <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
          <ChangeKind>String</ChangeKind>
          <Confidence>0</Confidence>
          <Discipline>String</Discipline>
          <ExtractSource>String</ExtractSource>
          <HeightPt>0</HeightPt>
          <IsCurrent>false</IsCurrent>
          <PageIndex>0</PageIndex>
          <PinCount>0</PinCount>
          <Pins>
            <SheetPin>
              <CreatedAt>0001-01-01T00:00:00</CreatedAt>
              <CreatedBy>String</CreatedBy>
              <EntityID>0</EntityID>
              <EntityNo>String</EntityNo>
              <EntityStatus>String</EntityStatus>
              <EntityTitle>String</EntityTitle>
              <EntityType>String</EntityType>
              <EntityUID>00000000-0000-0000-0000-000000000000</EntityUID>
              <InspectionUID>00000000-0000-0000-0000-000000000000</InspectionUID>
              <Label>String</Label>
              <PlanSetID>0</PlanSetID>
              <PlanSetName>String</PlanSetName>
              <PlanSetUID>00000000-0000-0000-0000-000000000000</PlanSetUID>
              <SheetID>0</SheetID>
              <SheetNumber>String</SheetNumber>
              <SheetPinID>0</SheetPinID>
              <SheetTitle>String</SheetTitle>
              <X>0</X>
              <Y>0</Y>
            </SheetPin>
          </Pins>
          <PlanSetID>0</PlanSetID>
          <PlanSetName>String</PlanSetName>
          <PlanSetUID>00000000-0000-0000-0000-000000000000</PlanSetUID>
          <ProjectID>0</ProjectID>
          <Revision>String</Revision>
          <RevisionDate>0001-01-01T00:00:00</RevisionDate>
          <SheetID>0</SheetID>
          <SheetKey>String</SheetKey>
          <SheetNumber>String</SheetNumber>
          <SupersedesSheetID>0</SupersedesSheetID>
          <ThumbHash>String</ThumbHash>
          <ThumbKey>String</ThumbKey>
          <ThumbUrl>String</ThumbUrl>
          <Title>String</Title>
          <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
          <UpdatedBy>String</UpdatedBy>
          <VersionNo>0</VersionNo>
          <WidthPt>0</WidthPt>
        </Sheet>
      </Sheets>
      <Source>String</Source>
      <SourceLabel>String</SourceLabel>
      <Status>String</Status>
      <SupersedesName>String</SupersedesName>
      <SupersedesPlanSetID>0</SupersedesPlanSetID>
      <VersionNo>0</VersionNo>
    </PlanSet>
  </PlanSets>
  <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>
</PlanSetListResponse>