Create Inspection Documents

Creates one or more document attachments for the specified inspection. To specify the documents to be attached, use the HTTP header "Content-Type:multipart/form-data" and form-data for "uploadedFile" and "fileInfo". Note that the "fileInfo" is a string containing an array of file attributes. Use "fileInfo" to specify one or more documents to be attached. See the example for details.

Resource Information

Scopeinspections

Deprecated scope name:   create_inspection_documents
App Type All
Authorization Type Access token
URI /v4/inspections/{inspectionId}/documents?lang={lang}&userId={userId}&password={password}
HTTP Method POST
Automation Version(s) 7.3.2

Request Information

Field or Parameter Type Required Values Description Automation Version
category string No   The document category. The list of category options varies depending on the document group. 7.3.2
group string No   The group query parameter. 7.3.2
inspectionId long Yes Get All Inspections Search Inspections The unique ID associated with the inspection. 7.3.2
lang String No   Indicates the language applied. 7.3.2
password string No   The password related to the operation. 7.3.2
userId string No   The users login ID for the Accela Civic Platform, created by agency administrators. 7.3.2

Example

Sample Request Head

                    POST https://apis.accela.com/v4/inspections/6159036/documents
Content-Type : multipart/form-data

Sample Request Body

Form-data:
Content-Disposition: form-data; name="uploadedFile"; filename="Accela_Logo.gif"
 Content-Type: image/gif
Content-Disposition: form-data; name="fileInfo"
[
   {
      "serviceProviderCode": "ISLANDTON",
      "fileName": "Accela_logo.gif",
      "type": "image/gif",
      "description": "Sample logo file"
   }
]

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": 2556263
    }
  ]
}