Trendsic Platform Service

<back to all web services

DocumentRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Document/{DocumentId}
GET,POST,PUT,DELETE,OPTIONS/v1/Document/
import Foundation
import ServiceStack

public class DocumentRequest : Codable
{
    public var document:[Document] = []
    public var documentId:String
    public var fields:[String:String] = [:]

    required public init(){}
}

public class Document : Codable
{
    public var documentId:String
    public var docType:String
    public var docCategory:String
    public var docSubCategory:String
    public var docTitle:String
    public var docDescription:String
    public var docData:[UInt8] = []
    public var docExpiration:Date?
    public var docMimeType:String
    public var displayOrder:Int
    public var fileSizeInKB:Double
    public var link:String
    public var uploadDate:Date?
    public var docKey:String

    required public init(){}
}

public class DocumentResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var document:[Document] = []

    required public init(){}
}

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

POST /v1/Document/{DocumentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
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"}],"DocumentId":"00000000000000000000000000000000","Fields":{"String":"String"}}

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"}},"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"}]}