Trendsic Platform Service

<back to all web services

CadRenderStatusRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/cad/{AttachmentId}/render/status
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 CadDerivative() = 
        member val CadDerivativeID: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 Urn:String = null with get,set
        member val ObjectKey:String = null with get,set
        member val Status:String = null with get,set
        member val Progress:Int32 = new Int32() with get,set
        member val StageLabel:String = null with get,set
        member val Has2d:Boolean = new Boolean() with get,set
        member val Has3d:Boolean = new Boolean() with get,set
        member val HasPdf:Boolean = new Boolean() with get,set
        member val ThumbKey:String = null with get,set
        member val ThumbUrl:String = null with get,set
        member val PdfAttachmentId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val ErrorText:String = null with get,set
        member val RequestedBy:String = null with get,set
        member val RequestedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val FinishedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AgeSeconds:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CadRenderResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Derivative:CadDerivative = null with get,set

    [<AllowNullLiteral>]
    type CadRenderStatusRequest() = 
        member val AttachmentId:Guid = new Guid() with get,set
        member val VersionNo:Nullable<Int32> = new Nullable<Int32>() with get,set

F# CadRenderStatusRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/cad/{AttachmentId}/render/status HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CadRenderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Derivative>
    <AgeSeconds>0</AgeSeconds>
    <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
    <CadDerivativeID>0</CadDerivativeID>
    <ErrorText>String</ErrorText>
    <FinishedAt>0001-01-01T00:00:00</FinishedAt>
    <Has2d>false</Has2d>
    <Has3d>false</Has3d>
    <HasPdf>false</HasPdf>
    <ObjectKey>String</ObjectKey>
    <PdfAttachmentId>00000000-0000-0000-0000-000000000000</PdfAttachmentId>
    <Progress>0</Progress>
    <RequestedAt>0001-01-01T00:00:00</RequestedAt>
    <RequestedBy>String</RequestedBy>
    <StageLabel>String</StageLabel>
    <Status>String</Status>
    <ThumbKey>String</ThumbKey>
    <ThumbUrl>String</ThumbUrl>
    <Urn>String</Urn>
    <VersionNo>0</VersionNo>
  </Derivative>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CadRenderResponse>