Document Review

DocumentReview

Name App Type Scope Auth Type Resource URI Civic Platform version
Attach Document Report Agency documents Access token POST /v4/documentReview/records/{recordId}/documents 7.3.3.5
Checkin Document Review Agency documents Access token POST /v4/documentReview/records/{recordId}/documents/{documentId}/checkin 7.3.3.5
Create Document Review Comments Agency documents Access token POST /v4/documentReview/documents/{documentId}/comments 7.3.3.5
Delete Document Review Comments Agency documents Access token DELETE /v4/documentReview/documents/{documentId}/comments/{commentIds} 7.3.3.5
Get Document Review Comments Agency documents Access token GET /v4/documentReview/documents/{documentId}/comments/{commentIds} 7.3.3.5
Update Document Review Comment Agency documents Access token PUT /v4/documentReview/documents/{documentId}/comments/{commentId} 7.3.3.5
Update Document Review Task Status Agency documents Access token PUT /v4/documentReview/documents/{documentId}/tasks/{id} 7.3.3.5

Overview:

The Document Review API supports integration of the Civic Platform's Electronic Document Review ("EDR") feature with third-party document review tools. The EDR feature in Automation enables agencies to manage and store documents from applicants as well as assign and manage document reviews.

Agencies can configure a connection to a third party document review tool so that when a user clicks Review on a record detail page, the user can use the third party tool to review and annotate the document.

Documents that have been reviewed in a third party tool can then be uploaded to the Civic Platform, where agencies can take advantage of the Civic Platform’s document management, security, workflow and task assignment functionality to manage the documents.

The Document Review API requires Automation version 7.3.3.5 and higher. For configuration information about integration and data mapping between Civic Platform and a third-party document review application, see "Integration with Third Party Document Review Applications" and "Configuring Third Party Document Review Tool Integration" in Accela Automation Version 7.3.3 Service Pack Release Notes > 7.3.3 Service Pack 5 > Automation > New Features.

Accela recommends that an agency create an Automation user account dedicated to third-party access.

 

Using the Document Review API

An application can call the Document Review API to integrate a third party document review tool with Automation. The Document Review API provides the following capabilities::

  • Sending a report from third party tool to Automation - When a correction notice report is generated on a third party document review tool, call Attach Document Report to send the document to Automation as an attachment to a record.

    Specify the document attachment in a multipart form-data request body, using the following form-data parameters:

    Name Parameters
    uploadedFile filename="sample.pdf"
    fileInfo 
    [ 
  { "serviceProviderCode": "BPTDEV", 
    "fileName": "sample.pdf", 
    "type": "text/plain", 
    "description": "Example" 
  } 
]

    See Attach Document Report for an example.

  • Checking in a reviewed document - When all reviews on a given document have been completed in the third party document review tool, call Checkin Document Review to send the document with all the open comments to Automation as a check-in file. It becomes an updated version of the original version which was submitted for review.

    Specify the document to be checked-in in a multipart form-data request body, using the following form-data parameters:

    Name Parameters
    uploadedFile filename="sample.pdf"
    fileInfo 
    [ 
  { "serviceProviderCode": "BPTDEV", 
    "fileName": "sample.pdf", 
    "resubmit": "false",
    "type": "text/plain", 
    "description": "Example" 
  } 
]

    If the document needs to be resubmitted for another review in the third party document tool, set resubmit to true. See Checkin Document Review for an example.

  • Updating document review task status - When the document review task status is updated in a third party document review tool, call Update Document Review Task Status to synchronize and update the corresponding document status in Automation.

  • Adding a comment to a document - To add a review comment to a document, call Create Document Review Comment.

  • Updating a comment - To update an existing review comment on a document, call Update Document Review Comment.

  • Deleting comments - To delete existing review comments from a document, call Delete Document Review Comments.