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/

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 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 DocumentResponse:
    response_status: Optional[ResponseStatus] = None
    document: List[Document] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DocumentRequest:
    document: List[Document] = field(default_factory=list)
    document_id: Optional[str] = None
    fields: Dict[str, str] = field(default_factory=dict)

Python DocumentRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Document: 
	[
		{
			DocumentId: 00000000000000000000000000000000,
			DocType: String,
			DocCategory: String,
			DocSubCategory: String,
			DocTitle: String,
			DocDescription: String,
			DocData: AA==,
			DocExpiration: 0001-01-01,
			DocMimeType: String,
			DisplayOrder: 0,
			FileSizeInKB: 0,
			Link: String,
			UploadDate: 0001-01-01,
			DocKey: String
		}
	],
	DocumentId: 00000000000000000000000000000000,
	Fields: 
	{
		String: String
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Document: 
	[
		{
			DocumentId: 00000000000000000000000000000000,
			DocType: String,
			DocCategory: String,
			DocSubCategory: String,
			DocTitle: String,
			DocDescription: String,
			DocData: AA==,
			DocExpiration: 0001-01-01,
			DocMimeType: String,
			DisplayOrder: 0,
			FileSizeInKB: 0,
			Link: String,
			UploadDate: 0001-01-01,
			DocKey: String
		}
	]
}