Trendsic Platform Service

<back to all web services

PDFDocumentRequest

The following routes are available for this service:
GET,OPTIONS/v1/PDFDocument/{DocumentId}
GET,OPTIONS/v1/PDFDocument/ByCard/{CardId}
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 PDFDocument
            Public Overridable Property DocumentId As Guid
            Public Overridable Property PDFDocument As Byte() = New Byte(){}
            Public Overridable Property DateCreated As Date
            Public Overridable Property CardId As Integer
        End Class

        Public Partial Class PDFDocumentRequest
            Public Overridable Property CardId As Integer
            Public Overridable Property DocumentId As Guid
            Public Overridable Property PDFDocument As List(Of PDFDocument) = New List(Of PDFDocument)
        End Class

        Public Partial Class PDFDocumentResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property PDFDocument As List(Of PDFDocument) = New List(Of PDFDocument)
        End Class
    End Namespace
End Namespace

VB.NET PDFDocumentRequest 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/PDFDocument/{DocumentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PDFDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <PDFDocument>
    <PDFDocument>
      <CardId>0</CardId>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
      <PDFDocument>AA==</PDFDocument>
    </PDFDocument>
  </PDFDocument>
  <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>
</PDFDocumentResponse>