Trendsic Platform Service

DocumentRequest

**Requires Authentication**
Requires any of the roles:	Agent, Administrator, Agent, Administrator, Agent, Administrator

The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS	/v1/Document/{DocumentId}
GET,POST,PUT,DELETE,OPTIONS	/v1/Document/

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 Document() = 
        member val DocumentId:Guid = new Guid() with get,set
        member val DocType:String = null with get,set
        member val DocCategory:String = null with get,set
        member val DocSubCategory:String = null with get,set
        member val DocTitle:String = null with get,set
        member val DocDescription:String = null with get,set
        member val DocData:Byte[] = [||] with get,set
        member val DocExpiration:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DocMimeType:String = null with get,set
        member val DisplayOrder:Int32 = new Int32() with get,set
        member val FileSizeInKB:Double = new Double() with get,set
        member val Link:String = null with get,set
        member val UploadDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DocKey:String = null with get,set

    [<AllowNullLiteral>]
    type DocumentResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Document:ResizeArray<Document> = new ResizeArray<Document>() with get,set

    [<AllowNullLiteral>]
    type DocumentRequest() = 
        member val Document:ResizeArray<Document> = new ResizeArray<Document>() with get,set
        member val DocumentId:Guid = new Guid() with get,set
        member val Fields:Dictionary<String, String> = new Dictionary<String, String>() with get,set

F# DocumentRequest 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.

POST /v1/Document/{DocumentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<DocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Document>
    <Document>
      <DisplayOrder>0</DisplayOrder>
      <DocCategory>String</DocCategory>
      <DocData>AA==</DocData>
      <DocDescription>String</DocDescription>
      <DocExpiration>0001-01-01T00:00:00</DocExpiration>
      <DocKey>String</DocKey>
      <DocMimeType>String</DocMimeType>
      <DocSubCategory>String</DocSubCategory>
      <DocTitle>String</DocTitle>
      <DocType>String</DocType>
      <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
      <FileSizeInKB>0</FileSizeInKB>
      <Link>String</Link>
      <UploadDate>0001-01-01T00:00:00</UploadDate>
    </Document>
  </Document>
  <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
  <Fields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Fields>
</DocumentRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<DocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Document>
    <Document>
      <DisplayOrder>0</DisplayOrder>
      <DocCategory>String</DocCategory>
      <DocData>AA==</DocData>
      <DocDescription>String</DocDescription>
      <DocExpiration>0001-01-01T00:00:00</DocExpiration>
      <DocKey>String</DocKey>
      <DocMimeType>String</DocMimeType>
      <DocSubCategory>String</DocSubCategory>
      <DocTitle>String</DocTitle>
      <DocType>String</DocType>
      <DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
      <FileSizeInKB>0</FileSizeInKB>
      <Link>String</Link>
      <UploadDate>0001-01-01T00:00:00</UploadDate>
    </Document>
  </Document>
  <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>
</DocumentResponse>