| Requires any of the roles: | Agent, Administrator |
| GET,POST,PUT,DELETE,OPTIONS | /v1/CRMimage/{ContactId} |
|---|
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;
public class dtos
{
public static class CRMimageRequest
{
public ArrayList<Document> Document = new ArrayList<Document>();
public Integer ContactId = null;
public HashMap<String,String> Fields = new HashMap<String,String>();
public ArrayList<Document> getDocument() { return Document; }
public CRMimageRequest setDocument(ArrayList<Document> value) { this.Document = value; return this; }
public Integer getContactId() { return ContactId; }
public CRMimageRequest setContactId(Integer value) { this.ContactId = value; return this; }
public HashMap<String,String> getFields() { return Fields; }
public CRMimageRequest 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 .xml suffix or ?format=xml
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/xml
Content-Type: application/xml
Content-Length: length
<CRMimageRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<ContactId>0</ContactId>
<Document>
<Document>
<DisplayOrder>0</DisplayOrder>
<DocCategory>String</DocCategory>
<DocData>AA==</DocData>
<DocDescription>String</DocDescription>
<DocExpiration>0001-01-01T00:00:00</DocExpiration>
<DocKey>String</DocKey>
<DocMimeType>String</DocMimeType>
<DocSubCategory>String</DocSubCategory>
<DocTitle>String</DocTitle>
<DocType>String</DocType>
<DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
<FileSizeInKB>0</FileSizeInKB>
<Link>String</Link>
<UploadDate>0001-01-01T00:00:00</UploadDate>
</Document>
</Document>
<Fields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Fields>
</CRMimageRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<DocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Document>
<Document>
<DisplayOrder>0</DisplayOrder>
<DocCategory>String</DocCategory>
<DocData>AA==</DocData>
<DocDescription>String</DocDescription>
<DocExpiration>0001-01-01T00:00:00</DocExpiration>
<DocKey>String</DocKey>
<DocMimeType>String</DocMimeType>
<DocSubCategory>String</DocSubCategory>
<DocTitle>String</DocTitle>
<DocType>String</DocType>
<DocumentId>00000000-0000-0000-0000-000000000000</DocumentId>
<FileSizeInKB>0</FileSizeInKB>
<Link>String</Link>
<UploadDate>0001-01-01T00:00:00</UploadDate>
</Document>
</Document>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</DocumentResponse>