Web Services - Class - PDocDetailNc

7/12/2018


PDocDetail provides key fields from the classes PDoc and PDocRuntime used by DocVacEnterprise.  Of note, the file prefix and file extension created when a file is uploaded may not match the exact details from the original file, certain characters are removed, a "tiff" file extension may become "tif" etc.  In addition, when a file is successfully uploaded, a list of PDocDetails is returned.  The PDocId will not change, if you store this value for each uploaded file, you are guaranteed to be able to retrieve the results, if any, for this file.  While the PDocRuntimeId will not technically change either, it is possible that a new PDocRuntimeId will be created in the case where embedded text cannot be extracted from a PDF file, and the file is processed as an image instead.  This second PDocRuntimeId will be associated with the usable data extraction results, if any.  For this reason, PDocId should be used as the key to retrieve data and the DocVacBasic web services are designed with this in mind.

public class PDocDetailNc
{
        [Required]
        public int PDocRuntimeId { get; set; }

        [Required]
        public int PDocId { get; set; }

        //optional field that can be used to store an additional id
        public string EntityId {get; set;}

        [Required]
        public int PDocExtractionModeId {get; set;}

        [Required]
        public int PDocStatusId { get; set; }

        [Required]
        [StringLength(300)]
        public string FilePrefix { get; set; }

        [Required]
        [StringLength(45)]
        public string FileExtension { get; set; }
}


Other articles:
Billing - DocVacBasic & DocVacGold
Web Services - Ws - GetPDocPageClassificationNc
Web Services - Usage Charges
Postman
Web Services - Class - PDocDetailNc
Web Services - Class - PDocPageNc
Web Services - Class - PDocRowClassificationNc
Web Services - Class - PDocRowXmlNc
Web Services - Class - PdrxDataTypeNc
Web Services - Class - PdrxstnMappingNc
more