Trendsic Platform Service

<back to all web services

PlanSetFromAttachmentRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/projects/{ProjectID}/plansets/from-attachment
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class PlanSet
            Public Overridable Property PlanSetID As Integer
            Public Overridable Property PlanSetUID As Guid
            Public Overridable Property ProjectID As Integer
            Public Overridable Property Name As String
            Public Overridable Property Source As String
            Public Overridable Property SourceLabel As String
            Public Overridable Property IssuedDate As Date?
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property AttachmentName As String
            Public Overridable Property FileSizeInKB As Double?
            Public Overridable Property VersionNo As Integer
            Public Overridable Property Status As String
            Public Overridable Property Progress As Integer
            Public Overridable Property PageCount As Integer
            Public Overridable Property SheetCount As Integer
            Public Overridable Property ExtractMode As String
            Public Overridable Property ErrorText As String
            Public Overridable Property SupersedesPlanSetID As Integer?
            Public Overridable Property SupersedesName As String
            Public Overridable Property IsCurrent As Boolean
            Public Overridable Property CreatedBy As String
            Public Overridable Property CreatedAt As Date?
            Public Overridable Property ProcessedAt As Date?
            Public Overridable Property AgeSeconds As Integer
            Public Overridable Property Sheets As List(Of Sheet) = New List(Of Sheet)
            Public Overridable Property Headline As String
        End Class

        Public Partial Class PlanSetFromAttachmentRequest
            Public Overridable Property ProjectID As Integer
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property Name As String
            Public Overridable Property Source As String
            Public Overridable Property IssuedDate As String
            Public Overridable Property SupersedesPlanSetUID As Guid?
            Public Overridable Property ExtractMode As String
            Public Overridable Property Standalone As Boolean
        End Class

        Public Partial Class PlanSetResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property PlanSet As PlanSet
            Public Overridable Property RemovedSheets As List(Of Sheet) = New List(Of Sheet)
        End Class

        Public Partial Class Sheet
            Public Overridable Property SheetID As Integer
            Public Overridable Property PlanSetID As Integer
            Public Overridable Property PlanSetUID As Guid?
            Public Overridable Property PlanSetName As String
            Public Overridable Property ProjectID As Integer
            Public Overridable Property PageIndex As Integer
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property VersionNo As Integer
            Public Overridable Property SheetNumber As String
            Public Overridable Property SheetKey As String
            Public Overridable Property Title As String
            Public Overridable Property Discipline As String
            Public Overridable Property Revision As String
            Public Overridable Property RevisionDate As Date?
            Public Overridable Property WidthPt As Double
            Public Overridable Property HeightPt As Double
            Public Overridable Property ThumbKey As String
            Public Overridable Property ThumbUrl As String
            Public Overridable Property ThumbHash As String
            Public Overridable Property ExtractSource As String
            Public Overridable Property Confidence As Double?
            Public Overridable Property ChangeKind As String
            Public Overridable Property SupersedesSheetID As Integer?
            Public Overridable Property IsCurrent As Boolean
            Public Overridable Property PinCount As Integer
            Public Overridable Property UpdatedBy As String
            Public Overridable Property UpdatedAt As Date?
            Public Overridable Property Pins As List(Of SheetPin) = New List(Of SheetPin)
        End Class

        Public Partial Class SheetPin
            Public Overridable Property SheetPinID As Integer
            Public Overridable Property SheetID As Integer
            Public Overridable Property EntityType As String
            Public Overridable Property EntityID As Integer?
            Public Overridable Property EntityUID As Guid?
            Public Overridable Property X As Double
            Public Overridable Property Y As Double
            Public Overridable Property Label As String
            Public Overridable Property CreatedBy As String
            Public Overridable Property CreatedAt As Date?
            Public Overridable Property EntityNo As String
            Public Overridable Property EntityTitle As String
            Public Overridable Property EntityStatus As String
            Public Overridable Property InspectionUID As Guid?
            Public Overridable Property SheetNumber As String
            Public Overridable Property SheetTitle As String
            Public Overridable Property PlanSetID As Integer?
            Public Overridable Property PlanSetUID As Guid?
            Public Overridable Property PlanSetName As String
        End Class
    End Namespace
End Namespace

VB.NET PlanSetFromAttachmentRequest 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.

POST /v1/projects/{ProjectID}/plansets/from-attachment HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ProjectID: 0,
	AttachmentId: 00000000000000000000000000000000,
	Name: String,
	Source: String,
	IssuedDate: String,
	SupersedesPlanSetUID: 00000000000000000000000000000000,
	ExtractMode: String,
	Standalone: False
}
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
		}
	},
	PlanSet: 
	{
		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
	},
	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-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
				}
			]
		}
	]
}