Get Assets

Returns asset information for one or more given assets, identified in comma-separated {ids}. Associated records can be requested via the expand parameter.

Resource Information

Scope assets
App Type Agency
Authorization Type Access token
URI /v4/assets/{ids}?fields={fields}&expand={expand}&lang={lang}
HTTP Method GET
Automation Version(s) 9.0.0

Request Information

Field or Parameter Type Required Values Description Automation Version
expand string No records Specify expand=records to return the associated records per asset. 9.0.0
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. 9.0.0
ids string No Get All Assets One or multiple identifiers separated by a comma like id1,id2,id3. 9.0.0
lang String No   Indicates the language applied. 9.0.0

Response Information

Field Type Description Automation Version
result[] result{}   9.0.0
result.classType string A Class Type is how Civic Platform groups objects that an agency owns or maintains. The five class types are component, linear, node-link linear, point, and polygon. Asset class types provide the ability to assign or group multiple asset types together. 9.0.0
result.comments result.comments{} General comments about the asset. 9.0.0
result.comments.text string The localized display text. 9.0.0
result.comments.value string The value for the specified parameter. 9.0.0
result.currentValue double The current value of the asset. 9.0.0
result.dateOfService dateTime The date the asset was initially placed into service. 9.0.0
result.dependentFlag string Indicates whether or not the parent asset is dependent on this asset. 9.0.0
result.depreciationAmount double The decline in the asset value by the asset depreciation calculation. 9.0.0
result.depreciationEndDate dateTime The end date for the asset depreciation calculation. This field is used in the asset depreciation calculation. 9.0.0
result.depreciationStartDate dateTime The start date for the asset depreciation calculation. This field is used in the asset depreciation calculation. 9.0.0
result.depreciationValue double The asset value after the asset depreciation calculation, which is based on the start value, depreciation start and end dates, useful life, and salvage value. 9.0.0
result.description result.description{} The description of the asset. 9.0.0
result.description.text string The localized display text. 9.0.0
result.description.value string The value for the specified parameter. 9.0.0
result.endID string The ending point asset ID. 9.0.0
result.gisObjects[] result.gisObjects{} Contains GIS information about the location of the asset. 9.0.0
result.gisObjects.gisId string The id of the GIS object. 9.0.0
result.gisObjects.layerId string The Id of the GIS layer that contains the record location. 9.0.0
result.gisObjects.serviceId string The id of the GIS service. 9.0.0
result.id long The unique, sequence id assigned by the Civic Platform server. Use the id to identify the object on the URI in subsequent object-specific API requests. 9.0.0
result.name result.name{} The descriptive name of the asset. 9.0.0
result.name.text string The localized display text. 9.0.0
result.name.value string The value for the specified parameter. 9.0.0
result.number string The unique, alpha-numeric asset ID. 9.0.0
result.records[] result.records{} Contains the records associated to the asset 9.0.0
result.records.actualProductionUnit double Estimated cost per production unit. 9.0.0
result.records.appearanceDate dateTime The date for a hearing appearance. 9.0.0
result.records.appearanceDayOfWeek string The day for a hearing appearance. 9.0.0
result.records.assignedDate dateTime The date of the assigned action. 9.0.0
result.records.assignedToDepartment string The department responsible for the action. 9.0.0
result.records.balance Double The balance of the account. 9.0.0
result.records.booking Boolean Indicates whether or not there was a booking in addition to a citation. 9.0.0
result.records.closedByDepartment string The department responsible for closure. 9.0.0
result.records.closedDate dateTime The closure date. 9.0.0
result.records.completedByDepartment string The department responsible for completion. 9.0.0
result.records.completedDate dateTime The date of completion. 9.0.0
result.records.defendantSignature Boolean Indicates whether or not a defendant's signature has been obtained. 9.0.0
result.records.description string The description of the record or item. 9.0.0
result.records.enforceDepartment string The name of the department responsible for enforcement. 9.0.0
result.records.estimatedProductionUnit double The estimated number of production units. 9.0.0
result.records.firstIssuedDate dateTime The first issued date for license. 9.0.0
result.records.infraction Boolean This defines whether or not an infraction occurred. 9.0.0
result.records.inspectorDepartment string The name of the department where the inspector works. 9.0.0
result.records.inspectorId string The ID number of the inspector. 9.0.0
result.records.inspectorName string The name of the inspector. 9.0.0
result.records.misdemeanor Boolean Indicates whether or not a misdemeanor occurred. 9.0.0
result.records.name string The full name for the application contact. 9.0.0
result.records.offenseWitnessed Boolean Indicates whether or not there was a witness to the alleged offense. 9.0.0
result.records.priority result.records.priority{} The priority level assigned to the record. 9.0.0
result.records.priority.text string The localized display text. 9.0.0
result.records.priority.value string The value for the specified parameter. 9.0.0
result.records.publicOwned Boolean A flag that indicates whether or not the public owns the item. 9.0.0
result.records.renewalInfo result.records.renewalInfo{} Defines the parameters related to renewal of a record. 9.0.0
result.records.renewalInfo.expirationDate dateTime The date when the condition expires. 9.0.0
result.records.renewalInfo.expirationStatus result.records.renewalInfo.expirationStatus{} Indicates whether the expiration is enabled or disabled. 9.0.0
result.records.renewalInfo.expirationStatus.text string The localized display text. 9.0.0
result.records.renewalInfo.expirationStatus.value string The value for the specified parameter. 9.0.0
result.records.reportedChannel result.records.reportedChannel{} The incoming channel through which the applicant submitted the application. 9.0.0
result.records.reportedChannel.text string The localized display text. 9.0.0
result.records.reportedChannel.value string The value for the specified parameter. 9.0.0
result.records.reportedDate dateTime The date when a complaint or incident is reported. 9.0.0
result.records.reportedType result.records.reportedType{} The type of complaint or incident being reported. 9.0.0
result.records.reportedType.text string The localized display text. 9.0.0
result.records.reportedType.value string The value for the specified parameter. 9.0.0
result.records.scheduledDate dateTime The date when the inspection gets scheduled. 9.0.0
result.records.severity result.records.severity{} Indicates the severity of the condition. 9.0.0
result.records.severity.text string The localized display text. 9.0.0
result.records.severity.value string The value for the specified parameter. 9.0.0
result.records.shortNotes string A brief note about the record subject. 9.0.0
result.records.status result.records.status{} The record status. 9.0.0
result.records.status.text string The localized display text. 9.0.0
result.records.status.value string The value for the specified parameter. 9.0.0
result.records.statusReason result.records.statusReason{} The reason for the status setting on the record. 9.0.0
result.records.statusReason.text string The localized display text. 9.0.0
result.records.statusReason.value string The value for the specified parameter. 9.0.0
result.records.statusType string The record status type. 9.0.0
result.records.totalFee Double The total amount of the fees invoiced to the record. 9.0.0
result.records.totalPay Double The total amount of pay. 9.0.0
result.records.updateDate dateTime The date when the record was last updated. 9.0.0
result.salvageValue double The residual value of the asset at the end of it’s useful life. 9.0.0
result.serviceProviderCode string The unique agency identifier. 9.0.0
result.size double A positive numeric value for the asset size. 9.0.0
result.sizeUnit string The unit of measure corresponding to the asset size. 9.0.0
result.startID string The starting point asset ID. 9.0.0
result.startValue double The beginning value or purchase price of the asset. 9.0.0
result.status result.status{} The status of the asset. 9.0.0
result.status.text string The localized display text. 9.0.0
result.status.value string The value for the specified parameter. 9.0.0
result.statusDate dateTime The date the asset status changed. 9.0.0
result.type result.type{} The type of asset. 9.0.0
result.type.text string The localized display text. 9.0.0
result.type.value string The value for the specified parameter. 9.0.0
status integer The request status. 9.0.0