Trendsic Platform Service

<back to all web services

CRMimageRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/CRMimage/{ContactId}
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 CRMimageRequest
            Public Overridable Property Document As List(Of Document) = New List(Of Document)
            Public Overridable Property ContactId As Integer
            Public Overridable Property Fields As Dictionary(Of String, String) = New Dictionary(Of String, String)
        End Class

        Public Partial Class Document
            Public Overridable Property DocumentId As Guid
            Public Overridable Property DocType As String
            Public Overridable Property DocCategory As String
            Public Overridable Property DocSubCategory As String
            Public Overridable Property DocTitle As String
            Public Overridable Property DocDescription As String
            Public Overridable Property DocData As Byte() = New Byte(){}
            Public Overridable Property DocExpiration As Date?
            Public Overridable Property DocMimeType As String
            Public Overridable Property DisplayOrder As Integer
            Public Overridable Property FileSizeInKB As Double
            Public Overridable Property Link As String
            Public Overridable Property UploadDate As Date?
            Public Overridable Property DocKey As String
        End Class

        Public Partial Class DocumentResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Document As List(Of Document) = New List(Of Document)
        End Class
    End Namespace
End Namespace

VB.NET CRMimageRequest 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

HTTP + JSON

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

POST /v1/CRMimage/{ContactId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Document":[{"DocumentId":"00000000000000000000000000000000","DocType":"String","DocCategory":"String","DocSubCategory":"String","DocTitle":"String","DocDescription":"String","DocData":"AA==","DocExpiration":"0001-01-01T00:00:00.0000000","DocMimeType":"String","DisplayOrder":0,"FileSizeInKB":0,"Link":"String","UploadDate":"0001-01-01T00:00:00.0000000","DocKey":"String"}],"ContactId":0,"Fields":{"String":"String"}}
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"}},"Document":[{"DocumentId":"00000000000000000000000000000000","DocType":"String","DocCategory":"String","DocSubCategory":"String","DocTitle":"String","DocDescription":"String","DocData":"AA==","DocExpiration":"0001-01-01T00:00:00.0000000","DocMimeType":"String","DisplayOrder":0,"FileSizeInKB":0,"Link":"String","UploadDate":"0001-01-01T00:00:00.0000000","DocKey":"String"}]}