...
INTAKE
- Customer portal and/or 3rd permitting application send plan review documents in PDF format to Partner applications for validation.
- Partner application calls the e-PlanSoft PlanSoft™ Scout API to validate each plan review document.
- Plan Review documents that do not pass Scout will not be accepted by e-PlanREVIEW® (EPR).
PROJECTS
- Partner application creates the new project in EPR. This includes the project info, project address and project team members.
- If the contact record does not exist, Partner application creates the contact record.
- Partner application associate the contact record to the project record as the primary contact.
- Partner application updates the project information/address/contact when it is modified in the permitting application.
DOCUMENTS
- Partner application calls the EPR API to upload plan review documents in PDF format. Partner is responsible for document versioning (1st submittal, 2nd resubmittal, etc.).: step-by-step guide
- To upload project attachments instead of plan documents, you will need to send files to our AWS S3 bucket. There are 3 calls you have to make:
- Get s3 presigned URL link to our AWS S3 bucket via the API:
- Method: GET
- URL: https://<epr_url>/resources/s3/uploadUrl?contentType=text%2Fxml&directory=attachments&filename=sample.xml
- PUT the file to this URL
- Method: PUT
- AWS S3 URL from step 1
- Finally, call project attachment api to finalized upload
- Method: POST
- URL: https://<epr_url>resources/projectAttachments
- Get s3 presigned URL link to our AWS S3 bucket via the API:
- Supporting attachments are also uploaded to EPR but are not inspected by Scout.
ASSIGNMENTS
- Partner application calls the EPR API to create plan review assignments for the newly uploaded plan review documents.
- Partner application calls the EPR API to update an existing EPR assignment record (due date, status, user reassignment etc.) as necessary.
PLAN REVIEWEPR PUSHES TO EXTERNAL APPLICATION
- EPR calls the Partner application API to report a change in the plan review assignment status.
- EPR calls the Partner application API to when all plan review assignments are complete.
...
DOCUMENT CHECK IN
- EPR users will create a compressed ZIP file of from all the selected documents to return to Partner application (reviewed plans, attachments/correction reports, etc.)
- EPR will call the Partner Partner application ‘check in’ API to provide a URL to retrieve the ZIP file from the EPR server.
...
DOCUMENT RE-SUBMITTAL
If any of plan review documents need corrections, repeat the process starting at INTAKE.
...