Page Comparison

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

...

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:

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

Helpful Starter APIs

Anchor

	#starterapi
	#starterapi

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

Info

Versions Compared

Old Version 12

New Version Current

Key

Step-by-step guide

Helpful Starter APIs

Related articles