Using Connect APIs to Upload Documents, Document Versions, and Create Assignments
This article describes how to use e-PlanREVIEW® (EPR)'s Connect API to upload documents for a particular project.
Prerequisites
A project record has been created. See 3 Easy Steps for a Light Integration to EPR. Basic understanding of EPR APIs see Getting Started with EPR REST API and Accessing EPR's API and Documentation.
Step-by-step guide
Call these EPR API methods in sequence.
Method | Notes |
---|---|
|
NOTE: PDF Scout™ Inspector Tool will be invoked automatically for each incoming plan review document. Files rejected by Scout cannot be uploaded to EPR. The customer must correct the issues noted before proceeding. |
2.POST /resources/document/upload/intake |
*Vendor_ID accepts a numeric or string (50 chars). Vendor_id's must be unique in the documents table. Otherwise, if your application will not pass plan review assignments to EPR:
|
3. POST/resources/documentAssignments | Creates assignment records and display them in the EPR Review page. Call this method after Intake if your application passes plan review assignments to EPR. Otherwise, do not call this method.
*Vendor_ID accepts a numeric or string (50 chars). Vendor_id's must be unique in the documentAssignments table.
*Vendor_ID accepts a numeric or string (50 chars). Vendor_id's must be unique in the documentVersion table. |
Related articles