Page Comparison

This article describes how to utilize the PDF Scout inspector to analyze incoming plan review documents to eplansoft REVIEW (EPR). 

All public facing portals/customer portals should implement calls to Scout to evaluate whether plan review documents are acceptable. .  

How it works

Incoming plan review documents are uploaded to a temporary location on the eplansoft AWS server. Scout performs a 'read analysis' to identify known issues that will prevent EPR from accepting the document for plan review.

Once the Scout inspection finishes, a json response is returned and the documents are deleted from AWS.

Prerequisites

• See: Scout PDF Inspector

Step-by-step guide

To inspect a ,pdf .PDF file using Scout APIs, follow these steps:

1. Get a login token for an administratortoken.

   1. Obtain the credentials from the EPR Environment/Partners page. See Accessing the Connect API for partner integration via Swagger

2. Get an upload url
3. Upload file using the url from step 2
4. Call Scout to get the json result.

Step 1. Get a token

POST https://scout-api.eplansoftreview.com/api/auth

...

{
    "success": true,
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6ImVwbGFuYWRtaW4iLCJpYXQiOjE1MjU0NDk2MDcsImV4cCI6MTUyNTQ1MzIwN30.5uRl1WIjpGwJaA-qVbnYI_wenzKl0bRy6RPuvp2WUzo"
}

Step 2. Get an Upload Url

GET https://scout-api.eplansoftreview.com/api/uploadUrl?filename=your_filename

...

Check "isPassed" value in the response body to see if the file passes Scout. EPR will not accept plan review documents