Get All Records for Contact

Gets the records for the specified contact {id}.

Resource Information


Deprecated scope name:   get_contact_records

App TypeAll
Authorization TypeAccess token
URI /v4/contacts/{id}/records?types={types}&statuses={statuses}&offset={offset}&limit={limit}&fields={fields}&lang={lang}
Automation Version(s)8.0.0

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNoComma-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.8.0.0
idstringYesThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.8.0.0
langStringNoIndicates the language applied.8.0.0
limitlongNoIndicates the number of items that are returned in each page.8.0.0
offsetlongNoIndicates the offset start of each page by the number specified.8.0.0
statusesstringNoA comma-delimited listed of record statuses8.0.0
typesstringNo Get All Inspection Types Get All Record Types Comma-delimited object type values such as a list of record type or inspection type values.8.0.0

Response Information

FieldTypeDescriptionAutomation Version
result.actualProductionUnitdoubleEstimated cost per production unit.8.0.0
result.appearanceDatedateTimeThe date for a hearing appearance. 8.0.0
result.appearanceDayOfWeekstringThe day for a hearing appearance.8.0.0
result.assignedDatedateTimeThe date of the assigned action.8.0.0
result.assignedToDepartmentstringThe department responsible for the action.8.0.0
result.assignedUserstringThe staff member responsible for the action.8.0.0
result.balanceDoubleThe balance of the account.8.0.0
result.bookingBooleanIndicates whether or not there was a booking in addition to a citation.8.0.0
result.closedByDepartmentstringThe department responsible for closure. 8.0.0
result.closedByUserstringThe staff member responsible for closure. 8.0.0
result.closedDatedateTimeThe closure date.8.0.0
result.completedByDepartmentstringThe department responsible for completion.8.0.0
result.completedByUserstringThe staff member responsible for completion. 8.0.0
result.completedDatedateTimeThe date of completion.8.0.0
result.constructionTyperesult.constructionType{}The US Census Bureau construction type code.8.0.0
result.constructionType.textstringThe localized display text.8.0.0
result.constructionType.valuestringThe value for the specified parameter.8.0.0
result.costPerUnitdoubleThe cost for one unit.8.0.0
result.createdBystringThe unique user id of the individual that created the entry.8.0.0
result.createdByCloningstringIndictes whether or not the record was cloned.8.0.0
result.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.8.0.0
result.defendantSignatureBooleanIndicates whether or not a defendant's signature has been obtained.8.0.0
result.descriptionstringThe description of the record or item.8.0.0
result.enforceDepartmentstringThe name of the department responsible for enforcement.8.0.0
result.enforceUserstringName of the enforcement officer. 8.0.0
result.enforceUserIdstringID number of the enforcement officer.8.0.0
result.estimatedCostPerUnitdoubleThe estimated cost per unit. 8.0.0
result.estimatedDueDatedateTimeThe estimated date of completion.8.0.0
result.estimatedProductionUnitdoubleThe estimated number of production units.8.0.0
result.estimatedTotalJobCostdoubleThe estimated cost of the job.8.0.0
result.firstIssuedDatedateTimeThe first issued date for license.8.0.0
result.housingUnitslongThe number of housing units.8.0.0
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.8.0.0
result.infractionBooleanThis defines whether or not an infraction occurred.8.0.0
result.initiatedProductstringThe Accela Automation product area where the application is submitted: "AA" : Classic Accela Automation. "ACA" : Accela Citizen Access. "AIVR" : Accela Integrated Voice Response. "AMO" : Accela Mobile Office. "AV360" : Accela Asset Management, Accela Land Man. 8.0.0
result.inPossessionTimedoubleThe application level in possession time of the time tracking feature.8.0.0
result.inspectorDepartmentstringThe name of the department where the inspector works. 8.0.0
result.inspectorIdstringThe ID number of the inspector.8.0.0
result.inspectorNamestringThe name of the inspector.8.0.0
result.jobValuedoubleThe value of the job.8.0.0
result.misdemeanorBooleanIndicates whether or not a misdemeanor occurred.8.0.0
result.modulestringUse to filter by the module.8.0.0
result.namestringThe full name for the application contact.8.0.0
result.numberOfBuildingslongThe number of buildings.8.0.0
result.offenseWitnessedBooleanIndicates whether or not there was a witness to the alleged offense.8.0.0
result.openedDatedateTimeThe date when the system created the record.8.0.0
result.overallApplicationTimedoubleThe amount of elapsed time from the time tracking start date to the completion of the application.8.0.0
result.priorityresult.priority{}The priority level assigned to the record.8.0.0
result.priority.textstringThe localized display text.8.0.0
result.priority.valuestringThe value for the specified parameter.8.0.0
result.publicOwnedBooleanA flag that indicates whether or not the public owns the item.8.0.0
result.recordClassstringGeneral information about the record. 8.0.0
result.renewalInforesult.renewalInfo{}Defines the parameters related to renewal of a record. 8.0.0
result.renewalInfo.expirationDatedateTimeThe date when the condition expires.8.0.0
result.renewalInfo.expirationStatusresult.renewalInfo.expirationStatus{}Indicates whether the expiration is enabled or disabled.8.0.0
result.renewalInfo.expirationStatus.textstringThe localized display text.8.0.0
result.renewalInfo.expirationStatus.valuestringThe value for the specified parameter.8.0.0
result.reportedChannelresult.reportedChannel{}The incoming channel through which the applicant submitted the application.8.0.0
result.reportedChannel.textstringThe localized display text.8.0.0
result.reportedChannel.valuestringThe value for the specified parameter.8.0.0
result.reportedDatedateTimeThe date when a complaint or incident is reported.8.0.0
result.reportedTyperesult.reportedType{}The type of complaint or incident being reported.8.0.0
result.reportedType.textstringThe localized display text.8.0.0
result.reportedType.valuestringThe value for the specified parameter.8.0.0
result.scheduledDatedateTimeThe date when the inspection gets scheduled.8.0.0
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.8.0.0
result.severityresult.severity{}Indicates the severity of the condition.8.0.0
result.severity.textstringThe localized display text.8.0.0
result.severity.valuestringThe value for the specified parameter.8.0.0
result.shortNotesstringA brief note about the record subject.8.0.0
result.statusresult.status{}The record status.8.0.0
result.status.textstringThe localized display text.8.0.0
result.status.valuestringThe value for the specified parameter.8.0.0
result.statusDatedateTimeThe date when the current status changed.8.0.0
result.statusReasonresult.statusReason{}The reason for the status setting on the record.8.0.0
result.statusReason.textstringThe localized display text.8.0.0
result.statusReason.valuestringThe value for the specified parameter.8.0.0
result.totalFeeDoubleThe total amount of the fees invoiced to the record. 8.0.0
result.totalJobCostdoubleThe combination of work order assignments (labor) and costs. 8.0.0
result.totalPayDoubleThe total amount of pay. 8.0.0
result.trackingIdlongThe application tracking number (IVR tracking number).8.0.0
result.typeresult.type{}The record type. If this type field is within the record type definition, it specifies the 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 8.0.0
result.type.aliasstringThe record type alias.8.0.0
result.type.categorystringThe 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 8.0.0
result.type.filterNamestringThe name of the record type filter which defines the record types to be displayed for the citizen user.8.0.0
result.type.groupstringThe 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 8.0.0
result.type.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.8.0.0
result.type.modulestringUse to filter by the module.8.0.0
result.type.subTypestringThe 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 8.0.0
result.type.textstringThe localized display text.8.0.0
result.type.typestringThe 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).8.0.0
result.type.valuestringThe value for the specified parameter.8.0.0
result.undistributedCostdoubleThe undistributed costs for this work order.8.0.0
result.valuestringThe value for the specified parameter.8.0.0
statusintegerThe record status.8.0.0