Trendsic Platform Service

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

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourceCategory:
    category_name: Optional[str] = None
    subcategories: List[str] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Document:
    document_id: Optional[str] = None
    doc_type: Optional[str] = None
    doc_category: Optional[str] = None
    doc_sub_category: Optional[str] = None
    doc_title: Optional[str] = None
    doc_description: Optional[str] = None
    doc_data: bytes = field(default_factory=list)
    doc_expiration: Optional[datetime.datetime] = None
    doc_mime_type: Optional[str] = None
    display_order: int = 0
    file_size_in_k_b: float = 0.0
    link: Optional[str] = None
    upload_date: Optional[datetime.datetime] = None
    doc_key: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Resource:
    resource_type: Optional[str] = None
    categories: List[ResourceCategory] = field(default_factory=list)
    documents: List[Document] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourceResponse:
    response_status: Optional[ResponseStatus] = None
    resource: List[Resource] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ResourceRequest:
    resource: List[Resource] = field(default_factory=list)

Python 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>