Get All Professional Records

Gets the records with which the specified professional is associated.

Resource Information

Scopeprofessionals

Deprecated scope name:   get_professional_records

App TypeAll
Authorization TypeAccess token
URI /v4/professionals/{id}/records?lang={lang}&offset={offset}&limit={limit}&fields={fields}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
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
idstringYes The unique identifier for the object, assigned by the Civic Platform server and provided in a response.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
offsetlongNo Indicates the offset start of each page by the number specified.7.3.2

Example

Sample Request Head

GET https://apis.accela.com//v4/professionals/20001397062/records

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/professionals/20001397062/records

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.assignedToStaffstringThe 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.closedByStaffstringThe staff member responsible for closure. 7.3.2
result.closedDatedateTimeThe closure date.7.3.2
result.completeDatedateTimeThe date of completion.7.3.2
result.completedByDepartmentstringThe department responsible for completion.7.3.2
result.completedByStaffstringThe staff member who completed the record.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.enforceOfficerIdstringThe ID of the enforcing officer.7.3.2
result.enforceOfficerNamestringThe name of the enforcing 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.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.displaystringThe text to be displayed.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
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "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"
    }
  ]
}