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}

export class Dropbox
{
    public Id: number;
    public AttachmentId: string;
    public FirstName: string;
    public LastName: string;
    public TableName: string;
    public RecordId: number;
    public Description: string;
    public DocumentType: string;
    public DocumentGroup: string;
    public DateAdded: string;
    public Locked: boolean;
    public FileSizeInKB: number;

    public constructor(init?: Partial<Dropbox>) { (Object as any).assign(this, init); }
}

export class DropboxExtended extends Dropbox
{
    public AttachmentName: string;
    public AgentName: string;
    public MimeType: string;
    public IsAgent: boolean;
    public IsContact: boolean;
    public IsShared: boolean;
    public CanShare: boolean;
    public ShareList: string;

    public constructor(init?: Partial<DropboxExtended>) { super(init); (Object as any).assign(this, init); }
}

export class DropboxResponse
{
    public ResponseStatus: ResponseStatus;
    public Dropbox: DropboxExtended[] = [];

    public constructor(init?: Partial<DropboxResponse>) { (Object as any).assign(this, init); }
}

export class DropboxRequest
{
    public Attachment: string;
    public Dropbox: Dropbox[] = [];
    public AttachmentId: string;
    public ID: number;
    public LoggedInAgent: number;
    public AgentName: string;
    public PageName: string;
    public TableName: string;
    public FieldName: string;
    public RecordIds: number[] = [];
    public IsNewApplication: boolean;
    public IsFactFillerPro: boolean;
    public AgentId: boolean;
    public AgentEmail: string;
    public FullNameAttachee: string;
    public IsFactFinder: boolean;
    public SharedId: number;
    public Sharer: number;
    public IsSecurities: boolean;
    public Locked: boolean;

    public constructor(init?: Partial<DropboxRequest>) { (Object as any).assign(this, init); }
}

TypeScript 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
		}
	]
}