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 .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>