API Documentation

Request parameters:

• long organisationId - organisation id
• long documentId - document id
• long documentAttachmentId - document attachment id

Request parameters:

• Int64 organisationId - organisation id
• Int64 documentId - document id
• Int64 documentAttachmentId - document attachment id

Request parameters:

• Long organisationId - organisation id
• Long documentId - document id
• Long documentAttachmentId - document attachment id

This method returns result of type 'SAOP.API.Models.Document.DocumentAttachment'.

    /// Document attachment details.
    public class DocumentAttachment
    {
        // Document attachment id.
        // Mandatory field. Ignored on create request.
        public long DocumentAttachmentId { get; set; }
        // Document.
        public mMApiFkField Document { get; set; }
        // Attachment description.
        // Mandatory field. Max length: 8000
        public string Description { get; set; }
        // Attachment data.
        public string AttachmentData { get; set; }
        // Attachment name for file.
        // Max length: 250
        public string FileName { get; set; }
        // Attachment mime type.
        // Max length: 250
        public string MimeType { get; set; }
        // Entry date.
        public DateTime EntryDate { get; set; }
        public DateTime RecordDtModified { get; set; }
        // Row version is used for concurrency check.
        // Mandatory field. Ignored on create request.
        public string RowVersion { get; set; }
    
    }

        /// Link with id, name and url to related data.
        public class mMApiFkField
        {
            // Record id.
            public long? ID { get; set; }
            // Record name.
            public string Name { get; private set; }
            // Url to full record details.
            public string ResourceUrl { get; private set; }
        
        }

This method returns result of type 'SAOP.API.Models.Document.DocumentAttachment'.

    /// Document attachment details.
    class DocumentAttachment
    {
        // Document attachment id.
        // Mandatory field. Ignored on create request.
        public $DocumentAttachmentId;
        // Document.
        public $Document;
        // Attachment description.
        // Mandatory field. Max length: 8000
        public $Description;
        // Attachment data.
        public $AttachmentData;
        // Attachment name for file.
        // Max length: 250
        public $FileName;
        // Attachment mime type.
        // Max length: 250
        public $MimeType;
        // Entry date.
        public $EntryDate;
        public $RecordDtModified;
        // Row version is used for concurrency check.
        // Mandatory field. Ignored on create request.
        public $RowVersion;
    
    }

        /// Link with id, name and url to related data.
        class mMApiFkField
        {
            // Record id.
            public $ID;
            // Record name.
            public $Name;
            // Url to full record details.
            public $ResourceUrl;
        
        }

This method returns result of type 'SAOP.API.Models.Document.DocumentAttachment'.

    /// Document attachment details.
    public class DocumentAttachment
    {
        // Document attachment id.
        // Mandatory field. Ignored on create request.
        public Long DocumentAttachmentId;
        // Document.
        public mMApiFkField Document;
        // Attachment description.
        // Mandatory field. Max length: 8000
        public String Description;
        // Attachment data.
        public String AttachmentData;
        // Attachment name for file.
        // Max length: 250
        public String FileName;
        // Attachment mime type.
        // Max length: 250
        public String MimeType;
        // Entry date.
        public Date EntryDate;
        public Date RecordDtModified;
        // Row version is used for concurrency check.
        // Mandatory field. Ignored on create request.
        public String RowVersion;
    
    }

        /// Link with id, name and url to related data.
        public class mMApiFkField
        {
            // Record id.
            public Long ID;
            // Record name.
            public String Name;
            // Url to full record details.
            public String ResourceUrl;
        
        }