Trendsic Platform Service

<back to all web services

ResourceRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,OPTIONS/v1/Resource
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class ResourceRequest
    {
        public ArrayList<Resource> Resource = new ArrayList<Resource>();
        
        public ArrayList<Resource> getResource() { return Resource; }
        public ResourceRequest setResource(ArrayList<Resource> value) { this.Resource = value; return this; }
    }

    public static class Resource
    {
        public String ResourceType = null;
        public ArrayList<ResourceCategory> Categories = new ArrayList<ResourceCategory>();
        public ArrayList<Document> Documents = new ArrayList<Document>();
        
        public String getResourceType() { return ResourceType; }
        public Resource setResourceType(String value) { this.ResourceType = value; return this; }
        public ArrayList<ResourceCategory> getCategories() { return Categories; }
        public Resource setCategories(ArrayList<ResourceCategory> value) { this.Categories = value; return this; }
        public ArrayList<Document> getDocuments() { return Documents; }
        public Resource setDocuments(ArrayList<Document> value) { this.Documents = value; return this; }
    }

    public static class ResourceCategory
    {
        public String CategoryName = null;
        public ArrayList<String> Subcategories = new ArrayList<String>();
        
        public String getCategoryName() { return CategoryName; }
        public ResourceCategory setCategoryName(String value) { this.CategoryName = value; return this; }
        public ArrayList<String> getSubcategories() { return Subcategories; }
        public ResourceCategory setSubcategories(ArrayList<String> value) { this.Subcategories = value; return this; }
    }

    public static class Document
    {
        public UUID DocumentId = null;
        public String DocType = null;
        public String DocCategory = null;
        public String DocSubCategory = null;
        public String DocTitle = null;
        public String DocDescription = null;
        public byte[] DocData = new byte[]{};
        public Date DocExpiration = null;
        public String DocMimeType = null;
        public Integer DisplayOrder = null;
        public Double FileSizeInKB = null;
        public String Link = null;
        public Date UploadDate = null;
        public String DocKey = null;
        
        public UUID getDocumentId() { return DocumentId; }
        public Document setDocumentId(UUID value) { this.DocumentId = value; return this; }
        public String getDocType() { return DocType; }
        public Document setDocType(String value) { this.DocType = value; return this; }
        public String getDocCategory() { return DocCategory; }
        public Document setDocCategory(String value) { this.DocCategory = value; return this; }
        public String getDocSubCategory() { return DocSubCategory; }
        public Document setDocSubCategory(String value) { this.DocSubCategory = value; return this; }
        public String getDocTitle() { return DocTitle; }
        public Document setDocTitle(String value) { this.DocTitle = value; return this; }
        public String getDocDescription() { return DocDescription; }
        public Document setDocDescription(String value) { this.DocDescription = value; return this; }
        public byte[] getDocData() { return DocData; }
        public Document setDocData(byte[] value) { this.DocData = value; return this; }
        public Date getDocExpiration() { return DocExpiration; }
        public Document setDocExpiration(Date value) { this.DocExpiration = value; return this; }
        public String getDocMimeType() { return DocMimeType; }
        public Document setDocMimeType(String value) { this.DocMimeType = value; return this; }
        public Integer getDisplayOrder() { return DisplayOrder; }
        public Document setDisplayOrder(Integer value) { this.DisplayOrder = value; return this; }
        public Double getFileSizeInKB() { return FileSizeInKB; }
        public Document setFileSizeInKB(Double value) { this.FileSizeInKB = value; return this; }
        public String getLink() { return Link; }
        public Document setLink(String value) { this.Link = value; return this; }
        public Date getUploadDate() { return UploadDate; }
        public Document setUploadDate(Date value) { this.UploadDate = value; return this; }
        public String getDocKey() { return DocKey; }
        public Document setDocKey(String value) { this.DocKey = value; return this; }
    }

    public static class ResourceResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<Resource> Resource = new ArrayList<Resource>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ResourceResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<Resource> getResource() { return Resource; }
        public ResourceResponse setResource(ArrayList<Resource> value) { this.Resource = value; return this; }
    }

}

Java ResourceRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
				}
			]
		}
	]
}