| Requires any of the roles: | Worker, Agent, Administrator, Worker, Agent, Administrator |
| 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
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<DropboxRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<AgentEmail>String</AgentEmail>
<AgentId>false</AgentId>
<AgentName>String</AgentName>
<Attachment>String</Attachment>
<AttachmentId>String</AttachmentId>
<Dropbox>
<Dropbox>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<DateAdded>0001-01-01T00:00:00</DateAdded>
<Description>String</Description>
<DocumentGroup>String</DocumentGroup>
<DocumentType>String</DocumentType>
<FileSizeInKB>0</FileSizeInKB>
<FirstName>String</FirstName>
<Id>0</Id>
<LastName>String</LastName>
<Locked>false</Locked>
<RecordId>0</RecordId>
<TableName>String</TableName>
</Dropbox>
</Dropbox>
<FieldName>String</FieldName>
<FullNameAttachee>String</FullNameAttachee>
<ID>0</ID>
<IsFactFillerPro>false</IsFactFillerPro>
<IsFactFinder>false</IsFactFinder>
<IsNewApplication>false</IsNewApplication>
<IsSecurities>false</IsSecurities>
<Locked>false</Locked>
<LoggedInAgent>0</LoggedInAgent>
<PageName>String</PageName>
<RecordIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>0</d2p1:int>
</RecordIds>
<SharedId>0</SharedId>
<Sharer>0</Sharer>
<TableName>String</TableName>
</DropboxRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DropboxResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Dropbox>
<DropboxExtended>
<AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
<DateAdded>0001-01-01T00:00:00</DateAdded>
<Description>String</Description>
<DocumentGroup>String</DocumentGroup>
<DocumentType>String</DocumentType>
<FileSizeInKB>0</FileSizeInKB>
<FirstName>String</FirstName>
<Id>0</Id>
<LastName>String</LastName>
<Locked>false</Locked>
<RecordId>0</RecordId>
<TableName>String</TableName>
<AgentName>String</AgentName>
<AttachmentName>String</AttachmentName>
<CanShare>false</CanShare>
<IsAgent>false</IsAgent>
<IsContact>false</IsContact>
<IsShared>false</IsShared>
<MimeType>String</MimeType>
<ShareList>String</ShareList>
</DropboxExtended>
</Dropbox>
<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>
</DropboxResponse>