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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SheetPin() = 
        member val SheetPinID:Int32 = new Int32() with get,set
        member val SheetID:Int32 = new Int32() with get,set
        member val EntityType:String = null with get,set
        member val EntityID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val EntityUID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val X:Double = new Double() with get,set
        member val Y:Double = new Double() with get,set
        member val Label:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val EntityNo:String = null with get,set
        member val EntityTitle:String = null with get,set
        member val EntityStatus:String = null with get,set
        member val InspectionUID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val SheetNumber:String = null with get,set
        member val SheetTitle:String = null with get,set
        member val PlanSetID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PlanSetUID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val PlanSetName:String = null with get,set

    [<AllowNullLiteral>]
    type Sheet() = 
        member val SheetID:Int32 = new Int32() with get,set
        member val PlanSetID:Int32 = new Int32() with get,set
        member val PlanSetUID:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val PlanSetName:String = null with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val PageIndex:Int32 = new Int32() with get,set
        member val AttachmentId:Guid = new Guid() with get,set
        member val VersionNo:Int32 = new Int32() with get,set
        member val SheetNumber:String = null with get,set
        member val SheetKey:String = null with get,set
        member val Title:String = null with get,set
        member val Discipline:String = null with get,set
        member val Revision:String = null with get,set
        member val RevisionDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val WidthPt:Double = new Double() with get,set
        member val HeightPt:Double = new Double() with get,set
        member val ThumbKey:String = null with get,set
        member val ThumbUrl:String = null with get,set
        member val ThumbHash:String = null with get,set
        member val ExtractSource:String = null with get,set
        member val Confidence:Nullable<Double> = new Nullable<Double>() with get,set
        member val ChangeKind:String = null with get,set
        member val SupersedesSheetID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val IsCurrent:Boolean = new Boolean() with get,set
        member val PinCount:Int32 = new Int32() with get,set
        member val UpdatedBy:String = null with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Pins:ResizeArray<SheetPin> = new ResizeArray<SheetPin>() with get,set

    [<AllowNullLiteral>]
    type PlanSet() = 
        member val PlanSetID:Int32 = new Int32() with get,set
        member val PlanSetUID:Guid = new Guid() with get,set
        member val ProjectID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Source:String = null with get,set
        member val SourceLabel:String = null with get,set
        member val IssuedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AttachmentId:Guid = new Guid() with get,set
        member val AttachmentName:String = null with get,set
        member val FileSizeInKB:Nullable<Double> = new Nullable<Double>() with get,set
        member val VersionNo:Int32 = new Int32() with get,set
        member val Status:String = null with get,set
        member val Progress:Int32 = new Int32() with get,set
        member val PageCount:Int32 = new Int32() with get,set
        member val SheetCount:Int32 = new Int32() with get,set
        member val ExtractMode:String = null with get,set
        member val ErrorText:String = null with get,set
        member val SupersedesPlanSetID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val SupersedesName:String = null with get,set
        member val IsCurrent:Boolean = new Boolean() with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ProcessedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AgeSeconds:Int32 = new Int32() with get,set
        member val Sheets:ResizeArray<Sheet> = new ResizeArray<Sheet>() with get,set
        member val Headline:String = null with get,set

    [<AllowNullLiteral>]
    type PlanSetListResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val PlanSets:ResizeArray<PlanSet> = new ResizeArray<PlanSet>() with get,set
        member val CurrentSheetCount:Int32 = new Int32() with get,set
        member val NeedsReviewCount:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type PlanSetListRequest() = 
        member val ProjectID:Int32 = new Int32() with get,set

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