Trendsic Platform Service

<back to all web services

CadRenderRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/cad/{AttachmentId}/render
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 CadDerivative
            Public Overridable Property CadDerivativeID As Integer
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property VersionNo As Integer
            Public Overridable Property Urn As String
            Public Overridable Property ObjectKey As String
            Public Overridable Property Status As String
            Public Overridable Property Progress As Integer
            Public Overridable Property StageLabel As String
            Public Overridable Property Has2d As Boolean
            Public Overridable Property Has3d As Boolean
            Public Overridable Property HasPdf As Boolean
            Public Overridable Property ThumbKey As String
            Public Overridable Property ThumbUrl As String
            Public Overridable Property PdfAttachmentId As Guid?
            Public Overridable Property ErrorText As String
            Public Overridable Property RequestedBy As String
            Public Overridable Property RequestedAt As Date?
            Public Overridable Property FinishedAt As Date?
            Public Overridable Property AgeSeconds As Integer
        End Class

        Public Partial Class CadRenderRequest
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property VersionNo As Integer?
        End Class

        Public Partial Class CadRenderResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Derivative As CadDerivative
        End Class
    End Namespace
End Namespace

VB.NET CadRenderRequest 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/cad/{AttachmentId}/render HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AttachmentId: 00000000000000000000000000000000,
	VersionNo: 0
}
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
		}
	},
	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
	}
}