Gets additional information for the specified record.
Scope | records Deprecated scope name: get_record_additional |
App Type | All |
Authorization Type | Access token |
URI | /v4/records/{recordId}/additional?lang={lang}&fields={fields} |
HTTP Method | GET |
Automation Version(s) | 7.3.2 |
Field or Parameter | Type | Required | Values | Description | Automation Version |
---|---|---|---|---|---|
fields | string | No | � | 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 |
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 |
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
Field | Type | Description | Automation Version |
---|---|---|---|
result[] | result{} | � | 7.3.2 |
result.buildingCount | long | The number of buildings. | 7.3.2 |
result.constructionType | result.constructionType{} | The US Census Bureau construction type code. | 7.3.2 |
result.constructionType.text | string | The localized display text. | 7.3.2 |
result.constructionType.value | string | The value for the specified parameter. | 7.3.2 |
result.estimatedValue | double | The application's estimated value. | 7.3.2 |
result.houseUnit | long | The unit number, for example, apartment number | 7.3.2 |
result.publicOwned | string | A flag that indicates whether or not the public owns the item. | 7.3.2 |
result.recordId | result.recordId{} | The unique ID associated with a record. | 7.3.2 |
result.recordId.customId | string | An 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.id | string | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.2 |
result.recordId.serviceProviderCode | string | The unique agency identifier, the system assigns, on the Accela Civic Platform. | 7.3.2 |
result.recordId.trackingId | long | The application tracking number (IVR tracking number). | 7.3.2 |
status | integer | The record status. | 7.3.3 |