| Requires any of the roles: | Agent, Administrator, Agent, Administrator |
| GET,POST,OPTIONS | /v1/Resource |
|---|
import Foundation
import ServiceStack
public class ResourceRequest : Codable
{
public var resource:[Resource] = []
required public init(){}
}
public class Resource : Codable
{
public var resourceType:String
public var categories:[ResourceCategory] = []
public var documents:[Document] = []
required public init(){}
}
public class ResourceCategory : Codable
{
public var categoryName:String
public var subcategories:[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 ResourceResponse : Codable
{
public var responseStatus:ResponseStatus
public var resource:[Resource] = []
required public init(){}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/Resource HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Resource:
[
{
ResourceType: String,
Categories:
[
{
CategoryName: String,
Subcategories:
[
String
]
}
],
Documents:
[
{
DocumentId: 00000000000000000000000000000000,
DocType: String,
DocCategory: String,
DocSubCategory: String,
DocTitle: String,
DocDescription: String,
DocData: AA==,
DocExpiration: 0001-01-01,
DocMimeType: String,
DisplayOrder: 0,
FileSizeInKB: 0,
Link: String,
UploadDate: 0001-01-01,
DocKey: String
}
]
}
]
}
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
}
},
Resource:
[
{
ResourceType: String,
Categories:
[
{
CategoryName: String,
Subcategories:
[
String
]
}
],
Documents:
[
{
DocumentId: 00000000000000000000000000000000,
DocType: String,
DocCategory: String,
DocSubCategory: String,
DocTitle: String,
DocDescription: String,
DocData: AA==,
DocExpiration: 0001-01-01,
DocMimeType: String,
DisplayOrder: 0,
FileSizeInKB: 0,
Link: String,
UploadDate: 0001-01-01,
DocKey: String
}
]
}
]
}