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
  1. POST /resources/document/upload/create
  • This method uploads the file to EPR and creates entries in the following ERP tables: documents, documentPages, documentVersions and the documentPageVersions.
  • The document is then prepped for plan review, we call this process 'redending'.
  • If the incoming document is a new version of a previously submitted document, you must set the documentPrior_id value equal to the vendor_id of the first submittal.

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
  • If your application will pass plan review assignments to EPR:
    • Set 'needsIntake' to False.
    • Pass the PK/GUID value for the document to the 'vendor_id' field (Required)

*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:

  • Call this method and set 'needsIntake' to True. This will make the Project Intake tab visible so that an EPR user can manually perform intake and create assignments.
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.

  1. Pass your GUID/PK value for the assignment to the 'vendor_id' field. (Required). This will allow EPR to return the assignment 'Status' to the appropriate task/assignment.

*Vendor_ID accepts a numeric or string (50 chars). Vendor_id's must be unique in the documentAssignments table.

  1. Include the 'documentVersion_vendor_id' value (PK/GUID) (Required). It should always point to the most recent document version. Do not pass the document version vendor ID for an earlier version.

*Vendor_ID accepts a numeric or string (50 chars). Vendor_id's must be unique in the documentVersion table.