Trendsic Platform Service

<back to all web services

CustomerAttachmentRequest

The following routes are available for this service:
DELETE,OPTIONS/v1/CustomerAttachment/{AttachmentId}
POST,OPTIONS/v1/CustomerAttachment/{TableName}/{FieldName}/{RecordId}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class CustomerAttachmentRequest
    {
        public ArrayList<Attachment> Attachment = new ArrayList<Attachment>();
        public UUID AttachmentId = null;
        public String TableName = null;
        public String FieldName = null;
        public UUID RecordId = null;
        public Boolean NeedsOCR = null;
        
        public ArrayList<Attachment> getAttachment() { return Attachment; }
        public CustomerAttachmentRequest setAttachment(ArrayList<Attachment> value) { this.Attachment = value; return this; }
        public UUID getAttachmentId() { return AttachmentId; }
        public CustomerAttachmentRequest setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public String getTableName() { return TableName; }
        public CustomerAttachmentRequest setTableName(String value) { this.TableName = value; return this; }
        public String getFieldName() { return FieldName; }
        public CustomerAttachmentRequest setFieldName(String value) { this.FieldName = value; return this; }
        public UUID getRecordId() { return RecordId; }
        public CustomerAttachmentRequest setRecordId(UUID value) { this.RecordId = value; return this; }
        public Boolean isNeedsOCR() { return NeedsOCR; }
        public CustomerAttachmentRequest setNeedsOCR(Boolean value) { this.NeedsOCR = value; return this; }
    }

    public static class Attachment
    {
        public UUID AttachmentId = null;
        public String TableName = null;
        public String FieldName = null;
        public Integer RecordId = null;
        public String AttachmentName = null;
        public String MimeType = null;
        public byte[] AttachmentData = new byte[]{};
        public Double FileSizeInKB = null;
        public Date CreatedDate = null;
        public String CreatedBy = null;
        public Boolean NeedsOCR = null;
        public Date OCRDate = null;
        public Boolean IsSecurities = null;
        public String AWSKey = null;
        public String PresignedUrl = null;
        
        public UUID getAttachmentId() { return AttachmentId; }
        public Attachment setAttachmentId(UUID value) { this.AttachmentId = value; return this; }
        public String getTableName() { return TableName; }
        public Attachment setTableName(String value) { this.TableName = value; return this; }
        public String getFieldName() { return FieldName; }
        public Attachment setFieldName(String value) { this.FieldName = value; return this; }
        public Integer getRecordId() { return RecordId; }
        public Attachment setRecordId(Integer value) { this.RecordId = value; return this; }
        public String getAttachmentName() { return AttachmentName; }
        public Attachment setAttachmentName(String value) { this.AttachmentName = value; return this; }
        public String getMimeType() { return MimeType; }
        public Attachment setMimeType(String value) { this.MimeType = value; return this; }
        public byte[] getAttachmentData() { return AttachmentData; }
        public Attachment setAttachmentData(byte[] value) { this.AttachmentData = value; return this; }
        public Double getFileSizeInKB() { return FileSizeInKB; }
        public Attachment setFileSizeInKB(Double value) { this.FileSizeInKB = value; return this; }
        public Date getCreatedDate() { return CreatedDate; }
        public Attachment setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public String getCreatedBy() { return CreatedBy; }
        public Attachment setCreatedBy(String value) { this.CreatedBy = value; return this; }
        public Boolean isNeedsOCR() { return NeedsOCR; }
        public Attachment setNeedsOCR(Boolean value) { this.NeedsOCR = value; return this; }
        public Date getOcrDate() { return OCRDate; }
        public Attachment setOcrDate(Date value) { this.OCRDate = value; return this; }
        public Boolean getIsSecurities() { return IsSecurities; }
        public Attachment setIsSecurities(Boolean value) { this.IsSecurities = value; return this; }
        public String getAwsKey() { return AWSKey; }
        public Attachment setAwsKey(String value) { this.AWSKey = value; return this; }
        public String getPresignedUrl() { return PresignedUrl; }
        public Attachment setPresignedUrl(String value) { this.PresignedUrl = value; return this; }
    }

    public static class AttachmentResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<Attachment> Attachment = new ArrayList<Attachment>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public AttachmentResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<Attachment> getAttachment() { return Attachment; }
        public AttachmentResponse setAttachment(ArrayList<Attachment> value) { this.Attachment = value; return this; }
    }

}

Java CustomerAttachmentRequest DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/CustomerAttachment/{TableName}/{FieldName}/{RecordId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CustomerAttachmentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Attachment>
    <Attachment>
      <AWSKey>String</AWSKey>
      <AttachmentData>AA==</AttachmentData>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <AttachmentName>String</AttachmentName>
      <CreatedBy>String</CreatedBy>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <FieldName>String</FieldName>
      <FileSizeInKB>0</FileSizeInKB>
      <IsSecurities>false</IsSecurities>
      <MimeType>String</MimeType>
      <NeedsOCR>false</NeedsOCR>
      <OCRDate>0001-01-01T00:00:00</OCRDate>
      <PresignedUrl>String</PresignedUrl>
      <RecordId>0</RecordId>
      <TableName>String</TableName>
    </Attachment>
  </Attachment>
  <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
  <FieldName>String</FieldName>
  <NeedsOCR>false</NeedsOCR>
  <RecordId>00000000-0000-0000-0000-000000000000</RecordId>
  <TableName>String</TableName>
</CustomerAttachmentRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AttachmentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Attachment>
    <Attachment>
      <AWSKey>String</AWSKey>
      <AttachmentData>AA==</AttachmentData>
      <AttachmentId>00000000-0000-0000-0000-000000000000</AttachmentId>
      <AttachmentName>String</AttachmentName>
      <CreatedBy>String</CreatedBy>
      <CreatedDate>0001-01-01T00:00:00</CreatedDate>
      <FieldName>String</FieldName>
      <FileSizeInKB>0</FileSizeInKB>
      <IsSecurities>false</IsSecurities>
      <MimeType>String</MimeType>
      <NeedsOCR>false</NeedsOCR>
      <OCRDate>0001-01-01T00:00:00</OCRDate>
      <PresignedUrl>String</PresignedUrl>
      <RecordId>0</RecordId>
      <TableName>String</TableName>
    </Attachment>
  </Attachment>
  <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>
</AttachmentResponse>