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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class PlanSet
    {
        public virtual int PlanSetID { get; set; }
        public virtual Guid PlanSetUID { get; set; }
        public virtual int ProjectID { get; set; }
        public virtual string Name { get; set; }
        public virtual string Source { get; set; }
        public virtual string SourceLabel { get; set; }
        public virtual DateTime? IssuedDate { get; set; }
        public virtual Guid AttachmentId { get; set; }
        public virtual string AttachmentName { get; set; }
        public virtual double? FileSizeInKB { get; set; }
        public virtual int VersionNo { get; set; }
        public virtual string Status { get; set; }
        public virtual int Progress { get; set; }
        public virtual int PageCount { get; set; }
        public virtual int SheetCount { get; set; }
        public virtual string ExtractMode { get; set; }
        public virtual string ErrorText { get; set; }
        public virtual int? SupersedesPlanSetID { get; set; }
        public virtual string SupersedesName { get; set; }
        public virtual bool IsCurrent { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual DateTime? CreatedAt { get; set; }
        public virtual DateTime? ProcessedAt { get; set; }
        public virtual int AgeSeconds { get; set; }
        public virtual List<Sheet> Sheets { get; set; } = [];
        public virtual string Headline { get; set; }
    }

    public partial class PlanSetListRequest
    {
        public virtual int ProjectID { get; set; }
    }

    public partial class PlanSetListResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<PlanSet> PlanSets { get; set; } = [];
        public virtual int CurrentSheetCount { get; set; }
        public virtual int NeedsReviewCount { get; set; }
    }

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

    public partial class SheetPin
    {
        public virtual int SheetPinID { get; set; }
        public virtual int SheetID { get; set; }
        public virtual string EntityType { get; set; }
        public virtual int? EntityID { get; set; }
        public virtual Guid? EntityUID { get; set; }
        public virtual double X { get; set; }
        public virtual double Y { get; set; }
        public virtual string Label { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual DateTime? CreatedAt { get; set; }
        public virtual string EntityNo { get; set; }
        public virtual string EntityTitle { get; set; }
        public virtual string EntityStatus { get; set; }
        public virtual Guid? InspectionUID { get; set; }
        public virtual string SheetNumber { get; set; }
        public virtual string SheetTitle { get; set; }
        public virtual int? PlanSetID { get; set; }
        public virtual Guid? PlanSetUID { get; set; }
        public virtual string PlanSetName { get; set; }
    }

}

C# 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
}