Trendsic Platform Service

<back to all web services

CadInfoRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/cad/{AttachmentId}/{VersionNo}
GET,OPTIONS/v1/cad/{AttachmentId}
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 CadCompanion
    {
        public virtual Guid AttachmentId { get; set; }
        public virtual string AttachmentName { get; set; }
        public virtual DateTime? CreatedDate { get; set; }
        public virtual double? FileSizeInKB { get; set; }
    }

    public partial class CadDerivative
    {
        public virtual int CadDerivativeID { get; set; }
        public virtual Guid AttachmentId { get; set; }
        public virtual int VersionNo { get; set; }
        public virtual string Urn { get; set; }
        public virtual string ObjectKey { get; set; }
        public virtual string Status { get; set; }
        public virtual int Progress { get; set; }
        public virtual string StageLabel { get; set; }
        public virtual bool Has2d { get; set; }
        public virtual bool Has3d { get; set; }
        public virtual bool HasPdf { get; set; }
        public virtual string ThumbKey { get; set; }
        public virtual string ThumbUrl { get; set; }
        public virtual Guid? PdfAttachmentId { get; set; }
        public virtual string ErrorText { get; set; }
        public virtual string RequestedBy { get; set; }
        public virtual DateTime? RequestedAt { get; set; }
        public virtual DateTime? FinishedAt { get; set; }
        public virtual int AgeSeconds { get; set; }
    }

    public partial class CadFileInfo
    {
        public virtual int CadFileInfoID { get; set; }
        public virtual Guid AttachmentId { get; set; }
        public virtual int VersionNo { get; set; }
        public virtual string FileName { get; set; }
        public virtual string Format { get; set; }
        public virtual string FormatLabel { get; set; }
        public virtual string CadVersion { get; set; }
        public virtual string CadVersionCode { get; set; }
        public virtual string Units { get; set; }
        public virtual string DrawingNumber { get; set; }
        public virtual string Title { get; set; }
        public virtual int LayoutCount { get; set; }
        public virtual List<CadLayout> Layouts { get; set; } = [];
        public virtual int LayerCount { get; set; }
        public virtual int EntityCount { get; set; }
        public virtual int TextChars { get; set; }
        public virtual string ExtractedText { get; set; }
        public virtual string Reader { get; set; }
        public virtual string Status { get; set; }
        public virtual string ErrorText { get; set; }
        public virtual DateTime? CreatedAt { get; set; }
        public virtual DateTime? UpdatedAt { get; set; }
        public virtual int AgeSeconds { get; set; }
    }

    public partial class CadInfoRequest
    {
        public virtual Guid AttachmentId { get; set; }
        public virtual int? VersionNo { get; set; }
    }

    public partial class CadInfoResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual Guid AttachmentId { get; set; }
        public virtual string FileName { get; set; }
        public virtual CadFileInfo Info { get; set; }
        public virtual CadDerivative Derivative { get; set; }
        public virtual List<CadCompanion> Companions { get; set; } = [];
        public virtual bool ApsConnected { get; set; }
        public virtual bool CanRender { get; set; }
        public virtual string ViewerScriptUrl { get; set; }
        public virtual string ViewerStyleUrl { get; set; }
    }

    public partial class CadLayout
    {
        public virtual string Name { get; set; }
        public virtual bool IsPaperSpace { get; set; }
    }

}

C# CadInfoRequest 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/cad/{AttachmentId}/{VersionNo} 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
		}
	},
	AttachmentId: 00000000000000000000000000000000,
	FileName: String,
	Info: 
	{
		CadFileInfoID: 0,
		AttachmentId: 00000000000000000000000000000000,
		VersionNo: 0,
		FileName: String,
		Format: String,
		FormatLabel: String,
		CadVersion: String,
		CadVersionCode: String,
		Units: String,
		DrawingNumber: String,
		Title: String,
		LayoutCount: 0,
		Layouts: 
		[
			{
				Name: String,
				IsPaperSpace: False
			}
		],
		LayerCount: 0,
		EntityCount: 0,
		TextChars: 0,
		ExtractedText: String,
		Reader: String,
		Status: String,
		ErrorText: String,
		CreatedAt: 0001-01-01,
		UpdatedAt: 0001-01-01,
		AgeSeconds: 0
	},
	Derivative: 
	{
		CadDerivativeID: 0,
		AttachmentId: 00000000000000000000000000000000,
		VersionNo: 0,
		Urn: String,
		ObjectKey: String,
		Status: String,
		Progress: 0,
		StageLabel: String,
		Has2d: False,
		Has3d: False,
		HasPdf: False,
		ThumbKey: String,
		ThumbUrl: String,
		PdfAttachmentId: 00000000000000000000000000000000,
		ErrorText: String,
		RequestedBy: String,
		RequestedAt: 0001-01-01,
		FinishedAt: 0001-01-01,
		AgeSeconds: 0
	},
	Companions: 
	[
		{
			AttachmentId: 00000000000000000000000000000000,
			AttachmentName: String,
			CreatedDate: 0001-01-01,
			FileSizeInKB: 0
		}
	],
	ApsConnected: False,
	CanRender: False,
	ViewerScriptUrl: String,
	ViewerStyleUrl: String
}