Get Additional Details for Record

Gets additional information for the specified record.

Resource Information

Scoperecords

Deprecated scope name:   get_record_additional

App TypeAll
Authorization TypeAccess token
URI /v4/records/{recordId}/additional?lang={lang}&fields={fields}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNo Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.2
langStringNo Indicates the language applied.7.3.2
recordIdstringYes Get All Records Search Records Get My Records The unique ID associated with a record.7.3.2

Example

Sample Request Head

GET https://apis.accela.com/v4/records/ISLANDTON-14CAP-00000-000GV/additional

Notes

The following sample request uses the ISLANDTON agency in the TEST environment on the Accela Developer Sandbox. Click the "Send to Hurl.It" link below to submit the sample request. Replace YOUR-ACCESS-TOKEN before submitting the request.

curl
   -H 'Content-type: application/json'
   -H 'Accept: application/json'
   -H 'Authorization: YOUR-ACCESS-TOKEN'
   -X GET https://apis.accela.com/v4/records/ISLANDTON-14CAP-00000-000GV/additional

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.buildingCountlongThe number of buildings.7.3.2
result.constructionTyperesult.constructionType{}The US Census Bureau construction type code.7.3.2
result.constructionType.textstringThe localized display text.7.3.2
result.constructionType.valuestringThe value for the specified parameter.7.3.2
result.estimatedValuedoubleThe application's estimated value.7.3.2
result.houseUnitlongThe unit number, for example, apartment number7.3.2
result.publicOwnedstringA flag that indicates whether or not the public owns the item.7.3.2
result.recordIdresult.recordId{}The unique ID associated with a record.7.3.2
result.recordId.customIdstringAn ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.7.3.2
result.recordId.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "status": 200,
  "result": {
    "recordId": {
      "serviceProviderCode": "ISLANDTON",
      "id": "ISLANDTON-14CAP-00000-000GV",
      "customId": "SR-2014-00262",
      "trackingId": 229161406
    },
    "constructionType": {},
    "publicOwned": "N"
  }
}