| Requires any of the roles: | Agent, Administrator, Agent, Administrator, Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/Document/{DocumentId} | ||
|---|---|---|---|
| GET,POST,PUT,DELETE,OPTIONS | /v1/Document/ |
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class DocumentRequest
{
public ArrayList<Document> Document = new ArrayList<Document>();
public UUID DocumentId = null;
public HashMap<String,String> Fields = new HashMap<String,String>();
public ArrayList<Document> getDocument() { return Document; }
public DocumentRequest setDocument(ArrayList<Document> value) { this.Document = value; return this; }
public UUID getDocumentId() { return DocumentId; }
public DocumentRequest setDocumentId(UUID value) { this.DocumentId = value; return this; }
public HashMap<String,String> getFields() { return Fields; }
public DocumentRequest setFields(HashMap<String,String> value) { this.Fields = 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 DocumentResponse
{
public ResponseStatus ResponseStatus = null;
public ArrayList<Document> Document = new ArrayList<Document>();
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public DocumentResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
public ArrayList<Document> getDocument() { return Document; }
public DocumentResponse setDocument(ArrayList<Document> value) { this.Document = value; return this; }
}
}
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/Document/{DocumentId} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Document:
[
{
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
}
],
DocumentId: 00000000000000000000000000000000,
Fields:
{
String: 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
}
},
Document:
[
{
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
}
]
}