Checkin Document Review

Checks in a file containing document review comments for the specified record. A third party document review application can use the Checkin Document Review API to check-in a reviewed document file to Automation. To specify the document to be checked in, use the HTTP headers "Content-Type:multipart/form-data" and "Content-Disposition:form-data". For the form-data, use the name="uploadedFile" parameter to specify the "filename=", and name="fileInfo" to specify the file attributes. "fileInfo" is a string containing an array of "serviceProviderCode", "fileName", "type", "resubmit", and "description" properties properties. Set the "resubmit" property to "true" if the third-party application requires a document resubmittal. See the example for details.

Resource Information

Scope	documents Deprecated scope name: create_documentreview_records_documents_checkin
App Type	Agency
Authorization Type	Access token
URI	/v4/documentReview/records/{recordId}/documents/{documentId}/checkin?lang={lang}
HTTP Method	POST
Automation Version(s)	7.3.3.5

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
documentId	string	Yes	�	The document ID.	7.3.2
lang	String	No	�	Indicates the language applied.	7.3.2
recordId	string	Yes	Get All Records Search Records Get My Records	The unique ID associated with a record.	7.3.2

Example

Sample Request Head

POST https://apis.accela.com/v4/documentReview/records/14CAP-00000-009AZ/documents/500062/checkin

Sample Request Body

Header:
Content-Type: multipart/form-data; boundary=---------------------------7de1a0c22082

Body:
-----------------------------7de1a0c22082  (file content)
Content-Disposition: form-data; name="uploadedFile"; filename="test.pdf"
Content-Type: text/plain
Kay test content here
-----------------------------7de1a0c22082  (file attribute)
Content-Disposition: form-data; name="fileInfo"
[
    {
        "serviceProviderCode": "BPTDEV",
        "fileName": "test.pdf",
        "resubmit": "true",
        "type": "text/plain",
        "description": "Upload file with file info unit testing"
    }
]
-----------------------------7de1a0c22082--

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.code	string	A code identifying an associated item	7.3.2
result.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.isSuccess	boolean	Indicates whether or not the operation on the item is successful.	7.3.2
result.message	string	A text message related to the operation.	7.3.2
status	integer	The record status.	7.3.3

Example

Sample Response Body

{
  "status": 200,
  "result": [
    {
      "id": 500063
    }
  ]
}