Trendsic Platform Service

<back to all web services

ResourceRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,OPTIONS/v1/Resource
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 Document
            Public Overridable Property DocumentId As Guid
            Public Overridable Property DocType As String
            Public Overridable Property DocCategory As String
            Public Overridable Property DocSubCategory As String
            Public Overridable Property DocTitle As String
            Public Overridable Property DocDescription As String
            Public Overridable Property DocData As Byte() = New Byte(){}
            Public Overridable Property DocExpiration As Date?
            Public Overridable Property DocMimeType As String
            Public Overridable Property DisplayOrder As Integer
            Public Overridable Property FileSizeInKB As Double
            Public Overridable Property Link As String
            Public Overridable Property UploadDate As Date?
            Public Overridable Property DocKey As String
        End Class

        Public Partial Class Resource
            Public Overridable Property ResourceType As String
            Public Overridable Property Categories As List(Of ResourceCategory) = New List(Of ResourceCategory)
            Public Overridable Property Documents As List(Of Document) = New List(Of Document)
        End Class

        Public Partial Class ResourceCategory
            Public Overridable Property CategoryName As String
            Public Overridable Property Subcategories As List(Of String) = New List(Of String)
        End Class

        Public Partial Class ResourceRequest
            Public Overridable Property Resource As List(Of Resource) = New List(Of Resource)
        End Class

        Public Partial Class ResourceResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Resource As List(Of Resource) = New List(Of Resource)
        End Class
    End Namespace
End Namespace

VB.NET ResourceRequest 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/Resource HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ResourceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Resource>
    <Resource>
      <Categories>
        <ResourceCategory>
          <CategoryName>String</CategoryName>
          <Subcategories xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </Subcategories>
        </ResourceCategory>
      </Categories>
      <Documents>
        <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>
      </Documents>
      <ResourceType>String</ResourceType>
    </Resource>
  </Resource>
</ResourceRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ResourceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Resource>
    <Resource>
      <Categories>
        <ResourceCategory>
          <CategoryName>String</CategoryName>
          <Subcategories xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </Subcategories>
        </ResourceCategory>
      </Categories>
      <Documents>
        <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>
      </Documents>
      <ResourceType>String</ResourceType>
    </Resource>
  </Resource>
  <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>
</ResourceResponse>