Get All Records

Gets record information, based on the specified request parameters.

Resource Information

Scope	records Deprecated scope name: get_records
App Type	All
Authorization Type	No 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 Method	GET
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
assignedDateFrom	string	No	�	The start of a date range for the assigned action.	7.3.2
assignedDateTo	string	No	�	The end of a date range for the assigned action.	7.3.2
assignedToDepartment	string	No	Get All Departments	The department responsible for the action.	7.3.2
assignedUser	string	No	�	The staff member responsible for the action.	7.3.2
closedByDepartment	string	No	Get All Departments	The department responsible for closure.	7.3.2
closedByUser	string	No	�	The staff member responsible for closure.	7.3.2
closedDateFrom	string	No	�	The start of the closure date range.	7.3.2
closedDateTo	string	No	�	The end of the closure date range.	7.3.2
completedByDepartment	string	No	Get All Departments	The department responsible for completion.	7.3.2
completedByUser	string	No	�	The staff member responsible for completion.	7.3.2
completedDateFrom	string	No	�	The start of the completion date range.	7.3.2
completedDateTo	string	No	�	The end of the completion date range.	7.3.2
customId	string	No	�	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
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
limit	long	No	�	Indicates the number of items that are returned in each page.	7.3.2
module	string	No	Get All Modules	Use to filter by the module.	7.3.2
offset	long	No	�	Indicates the offset start of each page by the number specified.	7.3.2
openedDateFrom	string	No	�	The start of date range when application is opened.	7.3.2
openedDateTo	string	No	�	The end of date range when application is opened.	7.3.2
recordClass	string	No	�	General information about the record.	7.3.2
status	string	No	�	The record status.	7.3.2
statusDateFrom	string	No	�	The start of a status date range.	7.3.3.7
statusDateTo	string	No	�	The end of a status date range.	7.3.3.7
type	string	No	�	The type of entity to be queried.	7.3.2
updateDateFrom	string	No	�	The start date of a date range filter.	8.0.0
updateDateTo	string	No	�	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

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.actualProductionUnit	double	Estimated cost per production unit.	7.3.2
result.appearanceDate	dateTime	The date for a hearing appearance.	7.3.2
result.appearanceDayOfWeek	string	The day for a hearing appearance.	7.3.2
result.assignedDate	dateTime	The date of the assigned action.	7.3.2
result.assignedToDepartment	string	The department responsible for the action.	7.3.2
result.assignedUser	string	The staff member responsible for the action.	7.3.2
result.balance	Double	The balance of the account.	7.3.2
result.booking	Boolean	Indicates whether or not there was a booking in addition to a citation.	7.3.2
result.closedByDepartment	string	The department responsible for closure.	7.3.2
result.closedByUser	string	The staff member responsible for closure.	7.3.2
result.closedDate	dateTime	The closure date.	7.3.2
result.completedByDepartment	string	The department responsible for completion.	7.3.2
result.completedByUser	string	The staff member responsible for completion.	7.3.2
result.completedDate	dateTime	The date of completion.	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.costPerUnit	double	The cost for one unit.	7.3.2
result.createdBy	string	The unique user id of the individual that created the entry.	7.3.2
result.createdByCloning	string	Indictes whether or not the record was cloned.	7.3.2
result.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.defendantSignature	Boolean	Indicates whether or not a defendant's signature has been obtained.	7.3.2
result.description	string	The description of the record or item.	7.3.2
result.enforceDepartment	string	The name of the department responsible for enforcement.	7.3.2
result.enforceUser	string	Name of the enforcement officer.	7.3.2
result.enforceUserId	string	ID number of the enforcement officer.	7.3.2
result.estimatedCostPerUnit	double	The estimated cost per unit.	7.3.2
result.estimatedDueDate	dateTime	The estimated date of completion.	7.3.2
result.estimatedProductionUnit	double	The estimated number of production units.	7.3.2
result.estimatedTotalJobCost	double	The estimated cost of the job.	7.3.2
result.firstIssuedDate	dateTime	The first issued date for license.	7.3.2
result.housingUnits	long	The number of housing units.	7.3.2
result.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.infraction	Boolean	This defines whether or not an infraction occurred.	7.3.2
result.initiatedProduct	string	The 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.inPossessionTime	double	The application level in possession time of the time tracking feature.	7.3.2
result.inspectorDepartment	string	The name of the department where the inspector works.	7.3.2
result.inspectorId	string	The ID number of the inspector.	7.3.2
result.inspectorName	string	The name of the inspector.	7.3.2
result.jobValue	double	The value of the job.	7.3.2
result.misdemeanor	Boolean	Indicates whether or not a misdemeanor occurred.	7.3.2
result.module	string	Use to filter by the module.	7.3.2
result.name	string	The full name for the application contact.	7.3.2
result.numberOfBuildings	long	The number of buildings.	7.3.2
result.offenseWitnessed	Boolean	Indicates whether or not there was a witness to the alleged offense.	7.3.2
result.openedDate	dateTime	The date when the system created the record.	7.3.2
result.overallApplicationTime	double	The amount of elapsed time from the time tracking start date to the completion of the application.	7.3.2
result.priority	result.priority{}	The priority level assigned to the record.	7.3.2
result.priority.text	string	The localized display text.	7.3.2
result.priority.value	string	The value for the specified parameter.	7.3.2
result.publicOwned	Boolean	A flag that indicates whether or not the public owns the item.	7.3.2
result.recordClass	string	General information about the record.	7.3.2
result.renewalInfo	result.renewalInfo{}	Defines the parameters related to renewal of a record.	7.3.2
result.renewalInfo.expirationCode	string	A short descriptive name used to identify the expiration of a renewal process	7.3.2
result.renewalInfo.expirationDate	dateTime	The date when the condition expires.	7.3.2
result.renewalInfo.expirationPeriodInterval	long	The 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.expirationStatus	result.renewalInfo.expirationStatus{}	Indicates whether the expiration is enabled or disabled.	7.3.2
result.renewalInfo.expirationStatus.text	string	The localized display text.	7.3.2
result.renewalInfo.expirationStatus.value	string	The value for the specified parameter.	7.3.2
result.renewalInfo.expirationUnit	string	The unit of expiration period (days or months).	7.3.2
result.renewalInfo.gracePeriodInterval	Long	The number of days or months between the expiration and the start of penalty.	7.3.2
result.renewalInfo.payPeriodGroup	string	The 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.penaltyFeeCode	string	The code for the fee item to use to calculate a penalty fee.	7.3.2
result.renewalInfo.penaltyFeeFunction	string	The 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.penaltyPeriodInterval	Long	The 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.penaltyPeriodNumber	Long	The number of penalty periods that can pass before a license becomes inactive.	7.3.2
result.renewalInfo.renewalFeeCode	string	The function code for calculating a renewal fee.	7.3.2
result.renewalInfo.renewalFeeFunction	string	The name of the function for calculating a renewal fee.	7.3.2
result.reportedChannel	result.reportedChannel{}	The incoming channel through which the applicant submitted the application.	7.3.2
result.reportedChannel.text	string	The localized display text.	7.3.2
result.reportedChannel.value	string	The value for the specified parameter.	7.3.2
result.reportedDate	dateTime	The date when a complaint or incident is reported.	7.3.2
result.reportedType	result.reportedType{}	The type of complaint or incident being reported.	7.3.2
result.reportedType.text	string	The localized display text.	7.3.2
result.reportedType.value	string	The value for the specified parameter.	7.3.2
result.scheduledDate	dateTime	The date when the inspection gets scheduled.	7.3.2
result.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.severity	result.severity{}	Indicates the severity of the condition.	7.3.2
result.severity.text	string	The localized display text.	7.3.2
result.severity.value	string	The value for the specified parameter.	7.3.2
result.shortNotes	string	A brief note about the record subject.	7.3.2
result.status	result.status{}	The record status.	7.3.2
result.status.text	string	The localized display text.	7.3.2
result.status.value	string	The value for the specified parameter.	7.3.2
result.statusDate	dateTime	The date when the current status changed.	7.3.2
result.statusReason	result.statusReason{}	The reason for the status setting on the record.	7.3.2
result.statusReason.text	string	The localized display text.	7.3.2
result.statusReason.value	string	The value for the specified parameter.	7.3.2
result.totalFee	Double	The total amount of the fees invoiced to the record.	7.3.2
result.totalJobCost	double	The combination of work order assignments (labor) and costs.	7.3.2
result.totalPay	Double	The total amount of pay.	7.3.2
result.trackingId	long	The application tracking number (IVR tracking number).	7.3.2
result.type	result.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.category	string	The 4th level in a 4-level record type structure (Group-Type-Subtype-Category).	7.3.2
result.type.filterName	string	The name of the record type filter which defines the record types to be displayed for the citizen user.	7.3.2
result.type.group	string	The 1st level in a 4-level record type structure (Group-Type-Subtype-Category).	7.3.2
result.type.id	string	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
result.type.module	string	Use to filter by the module.	7.3.2
result.type.subType	string	The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category).	7.3.2
result.type.text	string	The localized display text.	7.3.2
result.type.type	string	The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).	7.3.2
result.type.value	string	The value for the specified parameter.	7.3.2
result.undistributedCost	double	The undistributed costs for this work order.	7.3.2
result.updateDate	dateTime	The date when the record was last updated.	8.0.0
result.value	string	The value for the specified parameter.	7.3.2
status	integer	The 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
  }
}