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
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class Document
    {
        public virtual Guid DocumentId { get; set; }
        public virtual string DocType { get; set; }
        public virtual string DocCategory { get; set; }
        public virtual string DocSubCategory { get; set; }
        public virtual string DocTitle { get; set; }
        public virtual string DocDescription { get; set; }
        public virtual byte[] DocData { get; set; } = [];
        public virtual DateTime? DocExpiration { get; set; }
        public virtual string DocMimeType { get; set; }
        public virtual int DisplayOrder { get; set; }
        public virtual double FileSizeInKB { get; set; }
        public virtual string Link { get; set; }
        public virtual DateTime? UploadDate { get; set; }
        public virtual string DocKey { get; set; }
    }

    public partial class Resource
    {
        public virtual string ResourceType { get; set; }
        public virtual List<ResourceCategory> Categories { get; set; } = [];
        public virtual List<Document> Documents { get; set; } = [];
    }

    public partial class ResourceCategory
    {
        public virtual string CategoryName { get; set; }
        public virtual List<string> Subcategories { get; set; } = [];
    }

    public partial class ResourceRequest
    {
        public virtual List<Resource> Resource { get; set; } = [];
    }

    public partial class ResourceResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<Resource> Resource { get; set; } = [];
    }

}

C# 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>