Trendsic Platform Service

<back to all web services

DropboxDocumentGroupRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Dropbox/DocumentGroups/{ContactId}
GET,OPTIONS/v1/Dropbox/DocumentGroups/Agent/{AgentId}
"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 DropboxDocumentGroupRequest {
    /** @param {{Dropbox?:Dropbox[],ContactId?:number,AgentId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Dropbox[]} */
    Dropbox = [];
    /** @type {number} */
    ContactId;
    /** @type {number} */
    AgentId;
}

JavaScript DropboxDocumentGroupRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/Dropbox/DocumentGroups/{ContactId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl

HTTP/1.1 200 OK
Content-Type: text/jsonl
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}]}