3 Easy Steps for a Light Integration to EPR

Owned by Stacy Reno (Unlicensed)
Last updated: Sept 01, 2023 by Jorge Raya-NavarroVersion comment
2 min read

This article describes the e-PlanREVIEW® (EPR) API methods needed to:

  1. create a project

  2. send documents requiring plan review

  3. return deliverables

These 3 steps are the only requirements needed to start an integration with EPR to get files into EPR and have it ready for plan review. We are more than happy to help with integration, so please feel free to contact us at engineers@eplansoft.com.

For more information, see Overview, Managing List Types and List Items, Overview and  Add a Project record.

Prerequisites

Obtain a login token (see Accessing EPR's API and Documentation)

Step-by-step guide

Call these methods in sequence to create a new project data record, project contact(s), address and project team member record(s):

Method

Notes

Method

Notes

[POST]/partner/login

Start by getting a token for all subsequent API calls.

partner_name: string
username: string
password: string

*Obtain the 3 parameters from our integration support team

[POST]/projects

Project number must be unique. 
Once the project has been created, the selected Purpose (For Permitting or For Design Review) may not be changed.

Pass your project's ID (PK/GUID) to the 'vendor_id' field. (Required)

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

[POST]/contacts

Contact's email address must be unique.
Use the ID returned to call POST/projectPersons

[POST]/projectPersons

Set isPrimary = true if this individual should receive emails regarding project 'deliverables'. At least one 'primary' contact is recommended. Set isActive = true.

[POST]/project/{project_id}/addresses

Either a street address or APN is required. 

[POST]/project/{project_id}/teamMembers

Post a list of EPR users who will actively work on this project. Failure to include an EPR user in the project will prevent that individual from performing their tasks. 

Option: EPR can be configured to automatically create project team members if your application does not provide this functionality.

[POST]/resources/document/upload/create

Uploads file, creates document data record, documentPages records, documentVersions records, documentPageVersions records, sets needsIntake flag to ‘True.’

[POST]/resources/documents/upload/intake

Removes record from Intake page, updates needsIntake flag to ‘False’, displays document record on Project > Documents page.

[POST]/resources/documentAssignments

Creates assignment records, displays records in Review page.



Best Practices

Field names ending in '_LIID' map to a listItem ID record. Provide either the ID value OR the KEY value. The KEY values will make your code more readable.
See GET/listTypes and GET/listItems

Related articles