Gets the records with which the specified professional is associated.
| Scope | professionals Deprecated scope name: get_professional_records |
| App Type | All |
| Authorization Type | Access token |
| URI | /v4/professionals/{id}/records?lang={lang}&offset={offset}&limit={limit}&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 |
| id | string | Yes | � | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 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 |
| offset | long | No | � | Indicates the offset start of each page by the number specified. | 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/professionals/20001397062/records
| 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.assignedToStaff | 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.closedByStaff | string | The staff member responsible for closure. | 7.3.2 |
| result.closedDate | dateTime | The closure date. | 7.3.2 |
| result.completeDate | dateTime | The date of completion. | 7.3.2 |
| result.completedByDepartment | string | The department responsible for completion. | 7.3.2 |
| result.completedByStaff | string | The staff member who completed the record. | 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.enforceOfficerId | string | The ID of the enforcing officer. | 7.3.2 |
| result.enforceOfficerName | string | The name of the enforcing 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.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.display | string | The text to be displayed. | 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 |
| status | integer | The record status. | 7.3.3 |
{
"status": 200,
"page": {
"offset": 0,
"limit": 25,
"hasmore": false
},
"result": [
{
"serviceProviderCode": "ISLANDTON",
"id": "ISLANDTON-14CAP-00000-000B8",
"customId": "BLD14-00150",
"trackingId": 283199063,
"name": "BRAD-VuSpex Residential #2",
"module": "Building",
"type": {
"group": "Building",
"type": "Residential",
"subType": "Addition",
"category": "NA",
"value": "Building/Residential/Addition/NA",
"id": "Building-Residential-Addition-NA",
"text": "Residential Addition",
"module": "Building",
"display": "Residential Addition"
},
"openedDate": "2014-08-01T07:00:00Z",
"reportedDate": "2014-08-01T07:00:00Z",
"description": "Test permit assigned to Brad the Contractor for VuSpex testing and demo use.",
"isPublicOwned": false,
"assignedToDepartment": "ISLANDTON/BUILDING/NA/NA/NA/NA/NA",
"assignedToStaff": "BRADP",
"reportedChannel": {
"value": "Call Center",
"text": "Call Center"
},
"status": {
"value": "Submitted",
"text": "Submitted"
},
"statusDate": "2014-08-01T17:40:47Z",
"createdBy": "BRADP",
"recordClass": "COMPLETE",
"totalJobCost": 0,
"undistributedCost": 0,
"totalFee": 20,
"totalPay": 0,
"balance": 20,
"estimatedProductionUnit": 0,
"actualProductionUnit": 0,
"isBooking": false,
"isInfraction": false,
"isMisdemeanor": false,
"isOffenseWitnessed": false,
"isDefendantSignature": false,
"initiatedProduct": "AV360"
},
{
"serviceProviderCode": "ISLANDTON",
"id": "ISLANDTON-14CAP-00000-000B7",
"customId": "BLD14-00149",
"trackingId": 257669557,
"name": "BRAD-VuSpex Residential #1",
"module": "Building",
"type": {
"group": "Building",
"type": "Residential",
"subType": "New",
"category": "NA",
"value": "Building/Residential/New/NA",
"id": "Building-Residential-New-NA",
"text": "Residential New",
"module": "Building",
"display": "Residential New"
},
"openedDate": "2014-08-01T07:00:00Z",
"reportedDate": "2014-08-01T07:00:00Z",
"description": "Test permit assigned to Brad the Contractor for VuSpex testing and demo use.",
"isPublicOwned": false,
"assignedToDepartment": "ISLANDTON/BUILDING/NA/NA/NA/NA/NA",
"assignedToStaff": "BRADP",
"reportedChannel": {
"value": "Call Center",
"text": "Call Center"
},
"statusDate": "2014-08-26T20:06:10Z",
"createdBy": "BRADP",
"recordClass": "COMPLETE",
"totalJobCost": 0,
"undistributedCost": 0,
"totalFee": 20,
"totalPay": 0,
"balance": 20,
"estimatedProductionUnit": 0,
"actualProductionUnit": 0,
"isBooking": false,
"isInfraction": false,
"isMisdemeanor": false,
"isOffenseWitnessed": false,
"isDefendantSignature": false,
"initiatedProduct": "AV360"
}
]
}