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
PlanSetListRequest Parameters:
NameParameterData TypeRequiredDescription
ProjectIDpathintNo
PlanSetListResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
PlanSetsformList<PlanSet>No
CurrentSheetCountformintNo
NeedsReviewCountformintNo
PlanSet Parameters:
NameParameterData TypeRequiredDescription
PlanSetIDformintNo
PlanSetUIDformGuidNo
ProjectIDformintNo
NameformstringNo
SourceformstringNo
SourceLabelformstringNo
IssuedDateformDateTime?No
AttachmentIdformGuidNo
AttachmentNameformstringNo
FileSizeInKBformdouble?No
VersionNoformintNo
StatusformstringNo
ProgressformintNo
PageCountformintNo
SheetCountformintNo
ExtractModeformstringNo
ErrorTextformstringNo
SupersedesPlanSetIDformint?No
SupersedesNameformstringNo
IsCurrentformboolNo
CreatedByformstringNo
CreatedAtformDateTime?No
ProcessedAtformDateTime?No
AgeSecondsformintNo
SheetsformList<Sheet>No
HeadlineformstringNo
Sheet Parameters:
NameParameterData TypeRequiredDescription
SheetIDformintNo
PlanSetIDformintNo
PlanSetUIDformGuid?No
PlanSetNameformstringNo
ProjectIDformintNo
PageIndexformintNo
AttachmentIdformGuidNo
VersionNoformintNo
SheetNumberformstringNo
SheetKeyformstringNo
TitleformstringNo
DisciplineformstringNo
RevisionformstringNo
RevisionDateformDateTime?No
WidthPtformdoubleNo
HeightPtformdoubleNo
ThumbKeyformstringNo
ThumbUrlformstringNo
ThumbHashformstringNo
ExtractSourceformstringNo
Confidenceformdouble?No
ChangeKindformstringNo
SupersedesSheetIDformint?No
IsCurrentformboolNo
PinCountformintNo
UpdatedByformstringNo
UpdatedAtformDateTime?No
PinsformList<SheetPin>No
SheetPin Parameters:
NameParameterData TypeRequiredDescription
SheetPinIDformintNo
SheetIDformintNo
EntityTypeformstringNo
EntityIDformint?No
EntityUIDformGuid?No
XformdoubleNo
YformdoubleNo
LabelformstringNo
CreatedByformstringNo
CreatedAtformDateTime?No
EntityNoformstringNo
EntityTitleformstringNo
EntityStatusformstringNo
InspectionUIDformGuid?No
SheetNumberformstringNo
SheetTitleformstringNo
PlanSetIDformint?No
PlanSetUIDformGuid?No
PlanSetNameformstringNo

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>