Trendsic Platform Service

<back to all web services

ContactImportUploadRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/ContactImportUpload/{AgentID}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class Attachment
            Public Overridable Property AttachmentId As Guid
            Public Overridable Property TableName As String
            Public Overridable Property FieldName As String
            Public Overridable Property RecordId As Integer
            Public Overridable Property AttachmentName As String
            Public Overridable Property MimeType As String
            Public Overridable Property AttachmentData As Byte() = New Byte(){}
            Public Overridable Property FileSizeInKB As Double
            Public Overridable Property CreatedDate As Date
            Public Overridable Property CreatedBy As String
            Public Overridable Property NeedsOCR As Boolean
            Public Overridable Property OCRDate As Date
            Public Overridable Property IsSecurities As Boolean
            Public Overridable Property AWSKey As String
            Public Overridable Property PresignedUrl As String
        End Class

        Public Partial Class ContactImportUploadRequest
            Public Overridable Property AgentID As Integer
            Public Overridable Property Attachment As List(Of Attachment) = New List(Of Attachment)
        End Class

        Public Partial Class ContactImportUploadResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Attachment As List(Of Attachment) = New List(Of Attachment)
        End Class
    End Namespace
End Namespace

VB.NET ContactImportUploadRequest 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/ContactImportUpload/{AgentID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ContactImportUploadRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AgentID>0</AgentID>
  <Attachment>
    <Attachment>
      <AWSKey>String</AWSKey>
      <AttachmentData>AA==</AttachmentData>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <AttachmentName>String</AttachmentName>
      <CreatedBy>String</CreatedBy>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <FieldName>String</FieldName>
      <FileSizeInKB>0</FileSizeInKB>
      <IsSecurities>false</IsSecurities>
      <MimeType>String</MimeType>
      <NeedsOCR>false</NeedsOCR>
      <OCRDate>0001-01-01T00:00:00</OCRDate>
      <PresignedUrl>String</PresignedUrl>
      <RecordId>0</RecordId>
      <TableName>String</TableName>
    </Attachment>
  </Attachment>
</ContactImportUploadRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ContactImportUploadResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Attachment>
    <Attachment>
      <AWSKey>String</AWSKey>
      <AttachmentData>AA==</AttachmentData>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <AttachmentName>String</AttachmentName>
      <CreatedBy>String</CreatedBy>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <FieldName>String</FieldName>
      <FileSizeInKB>0</FileSizeInKB>
      <IsSecurities>false</IsSecurities>
      <MimeType>String</MimeType>
      <NeedsOCR>false</NeedsOCR>
      <OCRDate>0001-01-01T00:00:00</OCRDate>
      <PresignedUrl>String</PresignedUrl>
      <RecordId>0</RecordId>
      <TableName>String</TableName>
    </Attachment>
  </Attachment>
  <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>
</ContactImportUploadResponse>