Trendsic Platform Service

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}

"use strict";
export class Dropbox {
    /** @param {{Id?:number,AttachmentId?:string,FirstName?:string,LastName?:string,TableName?:string,RecordId?:number,Description?:string,DocumentType?:string,DocumentGroup?:string,DateAdded?:string,Locked?:boolean,FileSizeInKB?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    AttachmentId;
    /** @type {string} */
    FirstName;
    /** @type {string} */
    LastName;
    /** @type {string} */
    TableName;
    /** @type {number} */
    RecordId;
    /** @type {string} */
    Description;
    /** @type {string} */
    DocumentType;
    /** @type {string} */
    DocumentGroup;
    /** @type {string} */
    DateAdded;
    /** @type {boolean} */
    Locked;
    /** @type {number} */
    FileSizeInKB;
}
export class DropboxExtended extends Dropbox {
    /** @param {{AttachmentName?:string,AgentName?:string,MimeType?:string,IsAgent?:boolean,IsContact?:boolean,IsShared?:boolean,CanShare?:boolean,ShareList?:string,Id?:number,AttachmentId?:string,FirstName?:string,LastName?:string,TableName?:string,RecordId?:number,Description?:string,DocumentType?:string,DocumentGroup?:string,DateAdded?:string,Locked?:boolean,FileSizeInKB?:number}} [init] */
    constructor(init) { super(init); Object.assign(this, init) }
    /** @type {string} */
    AttachmentName;
    /** @type {string} */
    AgentName;
    /** @type {string} */
    MimeType;
    /** @type {boolean} */
    IsAgent;
    /** @type {boolean} */
    IsContact;
    /** @type {boolean} */
    IsShared;
    /** @type {boolean} */
    CanShare;
    /** @type {string} */
    ShareList;
}
export class DropboxResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Dropbox?:DropboxExtended[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {DropboxExtended[]} */
    Dropbox = [];
}
export class DropboxRequest {
    /** @param {{Attachment?:string,Dropbox?:Dropbox[],AttachmentId?:string,ID?:number,LoggedInAgent?:number,AgentName?:string,PageName?:string,TableName?:string,FieldName?:string,RecordIds?:number[],IsNewApplication?:boolean,IsFactFillerPro?:boolean,AgentId?:boolean,AgentEmail?:string,FullNameAttachee?:string,IsFactFinder?:boolean,SharedId?:number,Sharer?:number,IsSecurities?:boolean,Locked?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Attachment;
    /** @type {Dropbox[]} */
    Dropbox = [];
    /** @type {string} */
    AttachmentId;
    /** @type {number} */
    ID;
    /** @type {number} */
    LoggedInAgent;
    /** @type {string} */
    AgentName;
    /** @type {string} */
    PageName;
    /** @type {string} */
    TableName;
    /** @type {string} */
    FieldName;
    /** @type {number[]} */
    RecordIds = [];
    /** @type {boolean} */
    IsNewApplication;
    /** @type {boolean} */
    IsFactFillerPro;
    /** @type {boolean} */
    AgentId;
    /** @type {string} */
    AgentEmail;
    /** @type {string} */
    FullNameAttachee;
    /** @type {boolean} */
    IsFactFinder;
    /** @type {number} */
    SharedId;
    /** @type {number} */
    Sharer;
    /** @type {boolean} */
    IsSecurities;
    /** @type {boolean} */
    Locked;
}

JavaScript DropboxRequest 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/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>