Trendsic Platform Service

<back to all web services

DropboxRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator, Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Dropbox/{AgentName}
POST,OPTIONS/v1/Dropbox/{AttachmentId}
GET,POST,OPTIONS/v1/Dropbox
GET,OPTIONS/v1/Dropbox/ByAgentID/{ID}
GET,OPTIONS/v1/Dropbox/ByAgentID/{ID}/{LoggedInAgent}/{PageName}
GET,OPTIONS/v1/Dropbox/ByAgentID/{ID}/{PageName}
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 Dropbox:
    id: int = 0
    attachment_id: Optional[str] = None
    first_name: Optional[str] = None
    last_name: Optional[str] = None
    table_name: Optional[str] = None
    record_id: int = 0
    description: Optional[str] = None
    document_type: Optional[str] = None
    document_group: Optional[str] = None
    date_added: datetime.datetime = datetime.datetime(1, 1, 1)
    locked: bool = False
    file_size_in_k_b: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DropboxExtended(Dropbox):
    attachment_name: Optional[str] = None
    agent_name: Optional[str] = None
    mime_type: Optional[str] = None
    is_agent: bool = False
    is_contact: bool = False
    is_shared: bool = False
    can_share: bool = False
    share_list: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DropboxRequest:
    attachment: Optional[str] = None
    dropbox: List[Dropbox] = field(default_factory=list)
    attachment_id: Optional[str] = None
    id: int = 0
    logged_in_agent: int = 0
    agent_name: Optional[str] = None
    page_name: Optional[str] = None
    table_name: Optional[str] = None
    field_name: Optional[str] = None
    record_ids: List[int] = field(default_factory=list)
    is_new_application: bool = False
    is_fact_filler_pro: bool = False
    agent_id: bool = False
    agent_email: Optional[str] = None
    full_name_attachee: Optional[str] = None
    is_fact_finder: bool = False
    shared_id: int = 0
    sharer: int = 0
    is_securities: bool = False
    locked: bool = False

Python DropboxRequest 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/Dropbox/{AttachmentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Attachment: String,
	Dropbox: 
	[
		{
			Id: 0,
			AttachmentId: 00000000000000000000000000000000,
			FirstName: String,
			LastName: String,
			TableName: String,
			RecordId: 0,
			Description: String,
			DocumentType: String,
			DocumentGroup: String,
			DateAdded: 0001-01-01,
			Locked: False,
			FileSizeInKB: 0
		}
	],
	AttachmentId: String,
	ID: 0,
	LoggedInAgent: 0,
	AgentName: String,
	PageName: String,
	TableName: String,
	FieldName: String,
	RecordIds: 
	[
		0
	],
	IsNewApplication: False,
	IsFactFillerPro: False,
	AgentId: False,
	AgentEmail: String,
	FullNameAttachee: String,
	IsFactFinder: False,
	SharedId: 0,
	Sharer: 0,
	IsSecurities: False,
	Locked: False
}
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
		}
	},
	Dropbox: 
	[
		{
			AttachmentName: String,
			AgentName: String,
			MimeType: String,
			IsAgent: False,
			IsContact: False,
			IsShared: False,
			CanShare: False,
			ShareList: String,
			Id: 0,
			AttachmentId: 00000000000000000000000000000000,
			FirstName: String,
			LastName: String,
			TableName: String,
			RecordId: 0,
			Description: String,
			DocumentType: String,
			DocumentGroup: String,
			DateAdded: 0001-01-01,
			Locked: False,
			FileSizeInKB: 0
		}
	]
}