Get All Records

Gets record information, based on the specified request parameters.

Resource Information

Scoperecords

Deprecated scope name:   get_records

App TypeAll
Authorization TypeNo authorization required
URI /v4/records?completedByUser={completedByUser}&closedDateFrom={closedDateFrom}&openedDateTo={openedDateTo}&customId={customId}&statusDateFrom={statusDateFrom}&assignedUser={assignedUser}&fields={fields}&recordClass={recordClass}&statusDateTo={statusDateTo}&assignedDateFrom={assignedDateFrom}&limit={limit}&assignedDateTo={assignedDateTo}&module={module}&completedDateTo={completedDateTo}&updateDateFrom={updateDateFrom}&assignedToDepartment={assignedToDepartment}&offset={offset}&type={type}&completedDateFrom={completedDateFrom}&completedByDepartment={completedByDepartment}&openedDateFrom={openedDateFrom}&updateDateTo={updateDateTo}&closedDateTo={closedDateTo}&closedByDepartment={closedByDepartment}&closedByUser={closedByUser}&status={status}&lang={lang}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
assignedDateFromstringNo The start of a date range for the assigned action.7.3.2
assignedDateTostringNo The end of a date range for the assigned action.7.3.2
assignedToDepartmentstringNo Get All Departments The department responsible for the action.7.3.2
assignedUserstringNo The staff member responsible for the action.7.3.2
closedByDepartmentstringNo Get All Departments The department responsible for closure. 7.3.2
closedByUserstringNo The staff member responsible for closure. 7.3.2
closedDateFromstringNo The start of the closure date range.7.3.2
closedDateTostringNo The end of the closure date range.7.3.2
completedByDepartmentstringNo Get All Departments The department responsible for completion.7.3.2
completedByUserstringNo The staff member responsible for completion. 7.3.2
completedDateFromstringNo The start of the completion date range.7.3.2
completedDateTostringNo The end of the completion date range.7.3.2
customIdstringNo 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
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
limitlongNo Indicates the number of items that are returned in each page.7.3.2
modulestringNo Get All Modules Use to filter by the module.7.3.2
offsetlongNo Indicates the offset start of each page by the number specified.7.3.2
openedDateFromstringNo The start of date range when application is opened.7.3.2
openedDateTostringNo The end of date range when application is opened.7.3.2
recordClassstringNo General information about the record. 7.3.2
statusstringNo The record status.7.3.2
statusDateFromstringNo The start of a status date range.7.3.3.7
statusDateTostringNo The end of a status date range.7.3.3.7
typestringNo The type of entity to be queried.7.3.2
updateDateFromstringNo The start date of a date range filter.8.0.0
updateDateTostringNo The ending date of a date range filter.8.0.0

Example

Sample Request Head

GET https://apis.accela.com/v4/records?module=ServiceRequest&status=Submitted

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
   -d module=ServiceRequest
   -d status=Submitted
   -d limit=5
      

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.actualProductionUnitdoubleEstimated cost per production unit.7.3.2
result.appearanceDatedateTimeThe date for a hearing appearance. 7.3.2
result.appearanceDayOfWeekstringThe day for a hearing appearance.7.3.2
result.assignedDatedateTimeThe date of the assigned action.7.3.2
result.assignedToDepartmentstringThe department responsible for the action.7.3.2
result.assignedUserstringThe staff member responsible for the action.7.3.2
result.balanceDoubleThe balance of the account.7.3.2
result.bookingBooleanIndicates whether or not there was a booking in addition to a citation.7.3.2
result.closedByDepartmentstringThe department responsible for closure. 7.3.2
result.closedByUserstringThe staff member responsible for closure. 7.3.2
result.closedDatedateTimeThe closure date.7.3.2
result.completedByDepartmentstringThe department responsible for completion.7.3.2
result.completedByUserstringThe staff member responsible for completion. 7.3.2
result.completedDatedateTimeThe date of completion.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.costPerUnitdoubleThe cost for one unit.7.3.2
result.createdBystringThe unique user id of the individual that created the entry.7.3.2
result.createdByCloningstringIndictes whether or not the record was cloned.7.3.2
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.7.3.2
result.defendantSignatureBooleanIndicates whether or not a defendant's signature has been obtained.7.3.2
result.descriptionstringThe description of the record or item.7.3.2
result.enforceDepartmentstringThe name of the department responsible for enforcement.7.3.2
result.enforceUserstringName of the enforcement officer. 7.3.2
result.enforceUserIdstringID number of the enforcement officer.7.3.2
result.estimatedCostPerUnitdoubleThe estimated cost per unit. 7.3.2
result.estimatedDueDatedateTimeThe estimated date of completion.7.3.2
result.estimatedProductionUnitdoubleThe estimated number of production units.7.3.2
result.estimatedTotalJobCostdoubleThe estimated cost of the job.7.3.2
result.firstIssuedDatedateTimeThe first issued date for license.7.3.2
result.housingUnitslongThe number of housing units.7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.infractionBooleanThis defines whether or not an infraction occurred.7.3.2
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. 7.3.2
result.inPossessionTimedoubleThe application level in possession time of the time tracking feature.7.3.2
result.inspectorDepartmentstringThe name of the department where the inspector works. 7.3.2
result.inspectorIdstringThe ID number of the inspector.7.3.2
result.inspectorNamestringThe name of the inspector.7.3.2
result.jobValuedoubleThe value of the job.7.3.2
result.misdemeanorBooleanIndicates whether or not a misdemeanor occurred.7.3.2
result.modulestringUse to filter by the module.7.3.2
result.namestringThe full name for the application contact.7.3.2
result.numberOfBuildingslongThe number of buildings.7.3.2
result.offenseWitnessedBooleanIndicates whether or not there was a witness to the alleged offense.7.3.2
result.openedDatedateTimeThe date when the system created the record.7.3.2
result.overallApplicationTimedoubleThe amount of elapsed time from the time tracking start date to the completion of the application.7.3.2
result.priorityresult.priority{}The priority level assigned to the record.7.3.2
result.priority.textstringThe localized display text.7.3.2
result.priority.valuestringThe value for the specified parameter.7.3.2
result.publicOwnedBooleanA flag that indicates whether or not the public owns the item.7.3.2
result.recordClassstringGeneral information about the record. 7.3.2
result.renewalInforesult.renewalInfo{}Defines the parameters related to renewal of a record. 7.3.2
result.renewalInfo.expirationCodestringA short descriptive name used to identify the expiration of a renewal process7.3.2
result.renewalInfo.expirationDatedateTimeThe date when the condition expires.7.3.2
result.renewalInfo.expirationPeriodIntervallongThe number of days or months that a license remains active before expiring, then specify the date unit (days or months) in expirationUnit. For example, to enable an expiration interval of 2 months, enter "2" in the first field and choose "Months" in expirationUnit.7.3.2
result.renewalInfo.expirationStatusresult.renewalInfo.expirationStatus{}Indicates whether the expiration is enabled or disabled.7.3.2
result.renewalInfo.expirationStatus.textstringThe localized display text.7.3.2
result.renewalInfo.expirationStatus.valuestringThe value for the specified parameter.7.3.2
result.renewalInfo.expirationUnitstringThe unit of expiration period (days or months).7.3.2
result.renewalInfo.gracePeriodIntervalLongThe number of days or months between the expiration and the start of penalty.7.3.2
result.renewalInfo.payPeriodGroupstringThe name of the pay period group to use for a renewal. The pay period group defines the payment periods and fees that can be assessed for a renewal. For example, you can have a “2014” payment period within the Retail License pay period group.7.3.2
result.renewalInfo.penaltyFeeCodestringThe code for the fee item to use to calculate a penalty fee.7.3.2
result.renewalInfo.penaltyFeeFunctionstringThe function to use to generate a penalty fee. Run this function within the License batch process. “None” : no penalty fee.7.3.2
result.renewalInfo.penaltyPeriodIntervalLongThe number of days or months that each penalty period lasts. After the penalty interval, a subsequent penalty period can begin depending on the number of penalty periods specified in the penaltyPeriodNumber field.7.3.2
result.renewalInfo.penaltyPeriodNumberLongThe number of penalty periods that can pass before a license becomes inactive.7.3.2
result.renewalInfo.renewalFeeCodestringThe function code for calculating a renewal fee.7.3.2
result.renewalInfo.renewalFeeFunctionstringThe name of the function for calculating a renewal fee.7.3.2
result.reportedChannelresult.reportedChannel{}The incoming channel through which the applicant submitted the application.7.3.2
result.reportedChannel.textstringThe localized display text.7.3.2
result.reportedChannel.valuestringThe value for the specified parameter.7.3.2
result.reportedDatedateTimeThe date when a complaint or incident is reported.7.3.2
result.reportedTyperesult.reportedType{}The type of complaint or incident being reported.7.3.2
result.reportedType.textstringThe localized display text.7.3.2
result.reportedType.valuestringThe value for the specified parameter.7.3.2
result.scheduledDatedateTimeThe date when the inspection gets scheduled.7.3.2
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.severityresult.severity{}Indicates the severity of the condition.7.3.2
result.severity.textstringThe localized display text.7.3.2
result.severity.valuestringThe value for the specified parameter.7.3.2
result.shortNotesstringA brief note about the record subject.7.3.2
result.statusresult.status{}The record status.7.3.2
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.statusDatedateTimeThe date when the current status changed.7.3.2
result.statusReasonresult.statusReason{}The reason for the status setting on the record.7.3.2
result.statusReason.textstringThe localized display text.7.3.2
result.statusReason.valuestringThe value for the specified parameter.7.3.2
result.totalFeeDoubleThe total amount of the fees invoiced to the record. 7.3.2
result.totalJobCostdoubleThe combination of work order assignments (labor) and costs. 7.3.2
result.totalPayDoubleThe total amount of pay. 7.3.2
result.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
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). 7.3.2
result.type.categorystringThe 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.filterNamestringThe name of the record type filter which defines the record types to be displayed for the citizen user.7.3.2
result.type.groupstringThe 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.type.modulestringUse to filter by the module.7.3.2
result.type.subTypestringThe 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.textstringThe localized display text.7.3.2
result.type.typestringThe 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).7.3.2
result.type.valuestringThe value for the specified parameter.7.3.2
result.undistributedCostdoubleThe undistributed costs for this work order.7.3.2
result.updateDatedateTimeThe date when the record was last updated.8.0.0
result.valuestringThe value for the specified parameter.7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "result": [
    {
      "name": "CityScan Service Request",
      "id": "ISLANDTON-14CAP-00000-000BR",
      "type": {
        "module": "ServiceRequest",
        "type": "Buildings and Property",
        "value": "ServiceRequest/Buildings and Property/Working Without Permit/NA",
        "category": "NA",
        "text": "Working Without Permit",
        "group": "ServiceRequest",
        "subType": "Working Without Permit",
        "id": "ServiceRequest-Buildings.cand.cProperty-Working.cWithout.cPermit-NA"
      },
      "description": "6",
      "status": {
        "value": "Submitted",
        "text": "Submitted"
      },
      "undistributedCost": 0,
      "serviceProviderCode": "ISLANDTON",
      "statusDate": "2014-08-04 08:04:43",
      "totalJobCost": 0,
      "shortNotes": "CityScan Service Request",
      "initiatedProduct": "AV360",
      "createdBy": "DEVELOPER",
      "module": "ServiceRequest",
      "customId": "SR-2014-00151",
      "recordClass": "COMPLETE",
      "openedDateFrom": "2014-08-04 00:00:00",
      "trackingId": 287524530,
      "value": "14CAP-00000-000BR",
      "totalFee": 0,
      "totalPay": 0,
      "balance": 0,
      "booking": false,
      "infraction": false,
      "misdemeanor": false,
      "offenseWitnessed": false,
      "defendantSignature": false,
      "publicOwned": false
    },
    {
      "name": "CityScan Service Request",
      "id": "ISLANDTON-14CAP-00000-000BY",
      "type": {
        "module": "ServiceRequest",
        "type": "Buildings and Property",
        "value": "ServiceRequest/Buildings and Property/Fence Dispute/NA",
        "category": "NA",
        "text": "Fence Dispute",
        "group": "ServiceRequest",
        "subType": "Fence Dispute",
        "id": "ServiceRequest-Buildings.cand.cProperty-Fence.cDispute-NA"
      },
      "description": "7",
      "status": {
        "value": "Submitted",
        "text": "Submitted"
      },
      "undistributedCost": 0,
      "serviceProviderCode": "ISLANDTON",
      "statusDate": "2014-08-04 08:09:25",
      "totalJobCost": 0,
      "shortNotes": "CityScan Service Request",
      "initiatedProduct": "AV360",
      "createdBy": "DEVELOPER",
      "module": "ServiceRequest",
      "customId": "SR-2014-00158",
      "recordClass": "COMPLETE",
      "openedDateFrom": "2014-08-04 00:00:00",
      "trackingId": 214338233,
      "value": "14CAP-00000-000BY",
      "totalFee": 0,
      "totalPay": 0,
      "balance": 0,
      "booking": false,
      "infraction": false,
      "misdemeanor": false,
      "offenseWitnessed": false,
      "defendantSignature": false,
      "publicOwned": false
    },
    {
      "name": "CityScan Service Request",
      "id": "ISLANDTON-14CAP-00000-000BW",
      "type": {
        "module": "ServiceRequest",
        "type": "Signage",
        "value": "ServiceRequest/Signage/Illegal Sign/NA",
        "category": "NA",
        "text": "Illegal Sign",
        "group": "ServiceRequest",
        "subType": "Illegal Sign",
        "id": "ServiceRequest-Signage-Illegal.cSign-NA"
      },
      "description": "16",
      "status": {
        "value": "Submitted",
        "text": "Submitted"
      },
      "undistributedCost": 0,
      "serviceProviderCode": "ISLANDTON",
      "statusDate": "2014-08-04 08:09:18",
      "totalJobCost": 0,
      "shortNotes": "CityScan Service Request",
      "initiatedProduct": "AV360",
      "createdBy": "DEVELOPER",
      "module": "ServiceRequest",
      "customId": "SR-2014-00156",
      "recordClass": "COMPLETE",
      "openedDateFrom": "2014-08-04 00:00:00",
      "trackingId": 211450606,
      "value": "14CAP-00000-000BW",
      "totalFee": 0,
      "totalPay": 0,
      "balance": 0,
      "booking": false,
      "infraction": false,
      "misdemeanor": false,
      "offenseWitnessed": false,
      "defendantSignature": false,
      "publicOwned": false
    },
    {
      "name": "CityScan Service Request",
      "id": "ISLANDTON-14CAP-00000-000BT",
      "type": {
        "module": "ServiceRequest",
        "type": "Buildings and Property",
        "value": "ServiceRequest/Buildings and Property/Junk on Property/NA",
        "category": "NA",
        "text": "Junk on Property",
        "group": "ServiceRequest",
        "subType": "Junk on Property",
        "id": "ServiceRequest-Buildings.cand.cProperty-Junk.con.cProperty-NA"
      },
      "description": "23",
      "status": {
        "value": "Submitted",
        "text": "Submitted"
      },
      "undistributedCost": 0,
      "serviceProviderCode": "ISLANDTON",
      "statusDate": "2014-08-04 08:08:45",
      "totalJobCost": 0,
      "shortNotes": "CityScan Service Request",
      "initiatedProduct": "AV360",
      "createdBy": "DEVELOPER",
      "module": "ServiceRequest",
      "customId": "SR-2014-00153",
      "recordClass": "COMPLETE",
      "openedDateFrom": "2014-08-04 00:00:00",
      "trackingId": 247605157,
      "value": "14CAP-00000-000BT",
      "totalFee": 0,
      "totalPay": 0,
      "balance": 0,
      "booking": false,
      "infraction": false,
      "misdemeanor": false,
      "offenseWitnessed": false,
      "defendantSignature": false,
      "publicOwned": false
    },
    {
      "name": "CityScan Service Request",
      "id": "ISLANDTON-14CAP-00000-000BX",
      "type": {
        "module": "ServiceRequest",
        "type": "Signage",
        "value": "ServiceRequest/Signage/Illegal Sign/NA",
        "category": "NA",
        "text": "Illegal Sign",
        "group": "ServiceRequest",
        "subType": "Illegal Sign",
        "id": "ServiceRequest-Signage-Illegal.cSign-NA"
      },
      "description": "11",
      "status": {
        "value": "Submitted",
        "text": "Submitted"
      },
      "undistributedCost": 0,
      "serviceProviderCode": "ISLANDTON",
      "statusDate": "2014-08-04 08:09:22",
      "totalJobCost": 0,
      "shortNotes": "CityScan Service Request",
      "initiatedProduct": "AV360",
      "createdBy": "DEVELOPER",
      "module": "ServiceRequest",
      "customId": "SR-2014-00157",
      "recordClass": "COMPLETE",
      "openedDateFrom": "2014-08-04 00:00:00",
      "trackingId": 210759724,
      "value": "14CAP-00000-000BX",
      "totalFee": 0,
      "totalPay": 0,
      "balance": 0,
      "booking": false,
      "infraction": false,
      "misdemeanor": false,
      "offenseWitnessed": false,
      "defendantSignature": false,
      "publicOwned": false
    }
  ],
  "status": 200,
  "page": {
    "offset": 0,
    "limit": 5,
    "hasmore": true
  }
}