| 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} |
"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 .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
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/json
Content-Type: application/json
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-01T00:00:00.0000000","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: application/json
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-01T00:00:00.0000000","Locked":false,"FileSizeInKB":0}]}