Getting Started with EPR REST API

Owned by Stacy Reno (Unlicensed)
Last updated: Oct 27, 2021 by Colin Warren

e-PlanREVIEW® (EPR)'s API is a RESTful API that allows developers to integrate to EPR. Using the API, developers can pass project data, documents, tasks/assignments, etc. to EPR and retrieve marked up plans and reviewer comments. 

The API follows standard W3C guidelines for REST APIs that use the standard HTTP methods GET, PUT, POST, and DELETE to operate on a rich set of object resources and which supports synchronous and asynchronous operation.

GET and DELETE methods embed request parameters in the URI and do not use JSON request bodies. POST and PUT methods use the JSON bodies to handle requests. All methods return data in JSON response bodies.

The system processes content files (such as document or image attachments) outside of JSON request/response bodies as byte streams.

Step-by-step guide

There are a few ways to access EPR APIs:

  1. After logging into EPR application go to https://[domainName].eplansoftreview.com/docs
  2. After logging into EPR click on the "Online Help" in upper right corner (see below)
  3. After logging into EPR application directly go to:
    1.  https://[domainName].eplansoftreview.com/api/partners
    2.  https://[domainName].eplansoftreview.com/api/core
  4. Download the EPR Getting Started Postman collection: Started.postman_collection.json

Helpful Starter APIs

Partner API routes
Login
  • Partner Login
https://[domainName].eplansoftreview.com/partner/login
Assignment Related APIs
  • Get, Update, or Create Assignment
https://[domainName].eplansoftreview.com/partner/assignments
  • Get, Update, or Create a Contact
https://[domainName].eplansoftreview.com/partner/contacts
Document Related APIs
  • Get Document by Document ID
https://[domainName].eplansoftreview.com/partner/document/{document_id}
ListItem Related APIs
  • Get All User Groups
https://[domainName].eplansoftreview.com/partner/groups
  • Get ListItem by listitem ID
https://[domainName].eplansoftreview.com/partner/listItem/{listitem_id}
  • Get Project Contact Roles
https://[domainName].eplansoftreview.com/partner/listType?key=ProjectContactRole
  • Get ListItem by listtype ID
https://[domainName].eplansoftreview.com/partner/listTypes/{listtype_id}/listItems
Project Related APIs
  • Get, Update, or Create a Projects
https://[domainName].eplansoftreview.com/partner/project
  • Get Project by Project ID
https://[domainName].eplansoftreview.com/partner/project/{project_id}
  • Get Project Addresses by Project ID
https://[domainName].eplansoftreview.com/partner/project/{project_id}/addresses
  • Get Project Contacts by Project ID
https://[domainName].eplansoftreview.com/partner/project/{project_id}/contacts
  • Get Project Documents by Project ID
https://[domainName].eplansoftreview.com/partner/project/{project_id}/documents
  • Get Project Document Versions by Project ID
https://[domainName].eplansoftreview.com/partner/project/{project_id}/documentVersions
  • Get Project Members
https://<epr-url>/partner/projectPersons
  • Get Project Team Members by Project ID
https://[domainName].eplansoftreview.com/partner/projects/{project_id}/teamMembers
Resource API routes
  • Upload Document
https://[domainName].eplansoftreview.com/resources/documents/upload/create
  • Document InTake API
https://[domainName].eplansoftreview.com/resources/documents/upload/intake
  • Get All Users
https://[domainName].eplansoftreview.com/resources/persons
  • Get All Attachments
https://[domainName].eplansoftreview.com/resources/projectAttachments
  • Upload Document
https://[domainName].eplansoftreview.com/resources/s3/uploadUrl?contentType=text%2Fxml&directory=attachments&filename={filename}
Scount API routes
  • Scount Login
https://scout-api.eplansoftreview.com/api/auth
  • Validate a Document
https://scout-api.eplansoftreview.com/api/scout
  • Upload Document to Scout for Processing
https://scout-api.eplansoftreview.com/api/uploadUrl