Connect e-PlanREVIEW® (EPR)'s API is a REST-based RESTful API that allows agencies, partners, and developers to integrate back office products to e-Plansoft REVIEW ( EPR) and e-Plansoft goPost applications.. Using the Connect API, developers can pass project data, documents, tasks/assignments, etc. to EPR and retrieve marked up plans and reviewer comments.
The Connect 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.
...
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:
- Download the EPR Getting Started Postman collection: Started.postman_collection.json
Helpful Starter APIs
| Anchor | ||||
|---|---|---|---|---|
|
| Partner API routes | |
| Login | |
| https://[domainName].eplansoftreview.com/partner/login |
| Assignment Related APIs | |
| https://[domainName].eplansoftreview.com/partner/assignments |
| https://[domainName].eplansoftreview.com/partner/contacts |
| Document Related APIs | |
| https://[domainName].eplansoftreview.com/partner/document/{document_id} |
| ListItem Related APIs | |
| https://[domainName].eplansoftreview.com/partner/groups |
| https://[domainName].eplansoftreview.com/partner/listItem/{listitem_id} |
| https://[domainName].eplansoftreview.com/partner/listType?key=ProjectContactRole |
| https://[domainName].eplansoftreview.com/partner/listTypes/{listtype_id}/listItems |
| Project Related APIs | |
| https://[domainName].eplansoftreview.com/partner/project |
| https://[domainName].eplansoftreview.com/partner/project/{project_id} |
| https://[domainName].eplansoftreview.com/partner/project/{project_id}/addresses |
| https://[domainName].eplansoftreview.com/partner/project/{project_id}/contacts |
| https://[domainName].eplansoftreview.com/partner/project/{project_id}/documents |
| https://[domainName].eplansoftreview.com/partner/project/{project_id}/documentVersions |
| https://<epr-url>/partner/projectPersons |
| https://[domainName].eplansoftreview.com/partner/projects/{project_id}/teamMembers |
| Resource API routes | |
| https://[domainName].eplansoftreview.com/resources/documents/upload/create |
| https://[domainName].eplansoftreview.com/resources/documents/upload/intake |
| https://[domainName].eplansoftreview.com/resources/persons |
| https://[domainName].eplansoftreview.com/resources/projectAttachments |
| https://[domainName].eplansoftreview.com/resources/s3/uploadUrl?contentType=text%2Fxml&directory=attachments&filename={filename} |
| Scount API routes | |
| https://scout-api.eplansoftreview.com/api/auth |
| https://scout-api.eplansoftreview.com/api/scout |
| https://scout-api.eplansoftreview.com/api/uploadUrl |
| Info |
|---|
Related articles
| Filter by label (Content by label) | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...