Versions Compared

Old Version 10

changes.mady.by.user Colin Warren

Saved on

compared with

New Version Current

changes.mady.by.user Jorge Raya-Navarro

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Version published after converting to the new editor

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

  1. create a project
  2. upload files
  3. create assignmentssend documents requiring plan review
  4. 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.

...

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

MethodNotes
[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]/contactsContact's email address must be unique.
Use the ID returned to call POST/projectPersons
[POST]/projectPersonsSet 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}/addressesEither 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/intakeRemoves record from Intake page, updates needsIntake flag to ‘False’, displays document record on Project > Documents page.
[POST]/resources/documentAssignmentsCreates assignment records, displays records in Review page.

...