Get All Inspections for Record

Gets the scheduled inspections for the specified record.

Note: For a citizen token, the Display in ACA setting of the given {recordId} determines whether or not an inspection is returned. If Display in ACA is enabled for the given {recordId}, the inspection is included in the response; otherwise, the inspection will not be included. For an agency token, the Display in ACA setting of the given {recordId} is ignored.

Resource Information

Scope records

Deprecated scope name:   get_record_inspections
App Type All
Authorization Type Access token
URI /v4/records/{recordId}/inspections?lang={lang}&offset={offset}&limit={limit}
HTTP Method GET
Automation Version(s) 7.3.2

Request Information

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
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
recordId string Yes Get All Records Search Records Get My Records The unique ID associated with a record. 7.3.2

Example

Sample Request Head

GET https://apis.accela.com/v4/records/12CAP-00000-00003/inspections

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/12CAP-00000-00003/inspections

Response Information

Field Type Description Automation Version
result[] result{}   7.3.2
result.address result.address{} The address of the subject. 7.3.2
result.address.addressLine1 string The first line of the address. 7.3.2
result.address.addressLine2 string The second line of the address. 7.3.2
result.address.addressTypeFlag result.address.addressTypeFlag{} The current status of the address record. 7.3.2
result.address.addressTypeFlag.text string The localized display text. 7.3.2
result.address.addressTypeFlag.value string The value for the specified parameter. 7.3.2
result.address.city string The name of the city. 7.3.2
result.address.country result.address.country{} The name of the country. 7.3.2
result.address.country.text string The localized display text. 7.3.2
result.address.country.value string The value for the specified parameter. 7.3.2
result.address.county string The name of the county. 7.3.2
result.address.description string The description of the record or item. 7.3.2
result.address.direction result.address.direction{} The street direction of the primary address associated with the application. 7.3.2
result.address.direction.text string The localized display text. 7.3.2
result.address.direction.value string The value for the specified parameter. 7.3.2
result.address.distance double The distance from another landmark used to locate the address. 7.3.2
result.address.houseAlphaEnd string The ending street number that makes up the address. 7.3.2
result.address.houseAlphaStart string The beginning street number that makes up the address. 7.3.2
result.address.houseFractionEnd result.address.houseFractionEnd{} Used in combination with the Street # fields. 7.3.2
result.address.houseFractionEnd.text string The localized display text. 7.3.2
result.address.houseFractionEnd.value string The value for the specified parameter. 7.3.2
result.address.houseFractionStart result.address.houseFractionStart{} Used In combination with the Street # fields. 7.3.2
result.address.houseFractionStart.text string The localized display text. 7.3.2
result.address.houseFractionStart.value string The value for the specified parameter. 7.3.2
result.address.id long The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.address.inspectionDistrict string The inspection district where the address is located. 7.3.2
result.address.inspectionDistrictPrefix string The prefix for the inspection district where the address is located. 7.3.2
result.address.isPrimary string Indicates whether or not to designate the address as the primary address. Only one address can be primary at any given time. 7.3.2
result.address.levelEnd string The ending level number (floor number) that makes up the address within a complex. 7.3.2
result.address.levelPrefix string The prefix for the level numbers (floor numbers) that make up the address. 7.3.2
result.address.levelStart string The beginning level number (floor number) that makes up the address within a complex. 7.3.2
result.address.neighborhood string The neighborhood where the address is located. 7.3.2
result.address.neighborhoodPrefix string The prefix for the neighborhood where the address is located. 7.3.2
result.address.postalCode string The postal ZIP code for the address. 7.3.2
result.address.recordId result.address.recordId{} The unique ID associated with a record. 7.3.2
result.address.recordId.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.address.recordId.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.address.recordId.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
result.address.recordId.trackingId long The application tracking number (IVR tracking number). 7.3.2
result.address.recordId.value string The value for the specified parameter. 7.3.2
result.address.refAddressId long The unique Id generated for an address stored in the system. 7.3.2
result.address.secondaryStreet string This field (along with the Secondary Road Number field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location. 7.3.2
result.address.secondaryStreetNumber long This field (along with the Secondary Road field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location. 7.3.2
result.address.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
result.address.state result.address.state{} The state corresponding to the address on record. 7.3.2
result.address.state.text string The localized display text. 7.3.2
result.address.state.value string The value for the specified parameter. 7.3.2
result.address.status result.address.status{} The address status indicating whether the address is active or inactive. 7.3.2
result.address.status.text string The localized display text. 7.3.2
result.address.status.value string The value for the specified parameter. 7.3.2
result.address.streetAddress string The street address. 7.3.2
result.address.streetEnd long The end of a range of street numbers. 7.3.2
result.address.streetEndFrom long The start of the street End range. 7.3.2
result.address.streetEndTo long The last of the street End range. 7.3.2
result.address.streetName string The street name for the address. 7.3.2
result.address.streetPrefix string Any part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix. 7.3.2
result.address.streetStart long The start of a range of street numbers. 7.3.2
result.address.streetStartFrom long The first of the street start range. 7.3.2
result.address.streetStartTo long The last of the street start range. 7.3.2
result.address.streetSuffix result.address.streetSuffix{} The type of street such as "Lane" or "Boulevard". 7.3.2
result.address.streetSuffix.text string The localized display text. 7.3.2
result.address.streetSuffix.value string The value for the specified parameter. 7.3.2
result.address.streetSuffixDirection result.address.streetSuffixDirection{} The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction. 7.3.2
result.address.streetSuffixDirection.text string The localized display text. 7.3.2
result.address.streetSuffixDirection.value string The value for the specified parameter. 7.3.2
result.address.type result.address.type{} The address type. 7.3.2
result.address.type.text string The localized display text. 7.3.2
result.address.type.value string The value for the specified parameter. 7.3.2
result.address.unitEnd string The end parameter of a range of unit numbers. 7.3.2
result.address.unitStart string The starting parameter of a range of unit numbers. 7.3.2
result.address.unitType result.address.unitType{} The unit type designation of the address. 7.3.2
result.address.unitType.text string The localized display text. 7.3.2
result.address.unitType.value string The value for the specified parameter. 7.3.2
result.address.xCoordinate double The longitudinal coordinate for this address. 7.3.2
result.address.yCoordinate double The latitudinal coordinate for this address. 7.3.2
result.billable string This defines whether or not the item is billable. 7.3.2
result.category string The inspection category, which is used to organize inspection types. An inspection type is assigned to one or more inspection categories. 7.3.2
result.commentDisplay string Indicates whether or not Accela Citizen Access users can view the inspection results comments. 7.3.2
result.commentPublicVisible[] string Specifies the type of user who can view the inspection result comments. "All ACA Users" - Both registered and anonymous Accela Citizen Access users can view the comments for inspection results. "Record Creator Only" - the user who created the record can see the comments for the inspection results. "Record Creator and Licensed Professional" - The user who created the record and the licensed professional associated with the record can see the comments for the inspection results. 7.3.2
result.completedAMPM string Indicates whether completed time is "AM" or "PM". 7.3.2
result.completedDate dateTime The date of completion. 7.3.2
result.completedTime string The time of completion. 7.3.2
result.contact result.contact{} The contact information. 7.3.2
result.contact.address result.contact.address{} The citizen user's address. 7.3.2
result.contact.address.addressLine1 string The first line of the address. 7.3.2
result.contact.address.addressLine2 string The second line of the address. 7.3.2
result.contact.address.addressLine3 string The third line of the address. 7.3.2
result.contact.address.city string The name of the city. 7.3.2
result.contact.address.country result.contact.address.country{} The name of the country. 7.3.2
result.contact.address.country.text string The localized display text. 7.3.2
result.contact.address.country.value string The value for the specified parameter. 7.3.2
result.contact.address.postalCode string The postal ZIP code for the address. 7.3.2
result.contact.address.state result.contact.address.state{} The state corresponding to the address on record. 7.3.2
result.contact.address.state.text string The localized display text. 7.3.2
result.contact.address.state.value string The value for the specified parameter. 7.3.2
result.contact.birthCity result.contact.birthCity{} The city of birth for an individual. 7.3.2
result.contact.birthCity.text string The localized display text. 7.3.2
result.contact.birthCity.value string The value for the specified parameter. 7.3.2
result.contact.birthDate dateTime The birth date of an individual. 7.3.2
result.contact.birthRegion result.contact.birthRegion{} The country of birth or region of birth for an individual. 7.3.2
result.contact.birthRegion.text string The localized display text. 7.3.2
result.contact.birthRegion.value string The value for the specified parameter. 7.3.2
result.contact.birthState result.contact.birthState{} The state of birth for an individual. 7.3.2
result.contact.birthState.text string The localized display text. 7.3.2
result.contact.birthState.value string The value for the specified parameter. 7.3.2
result.contact.businessName string A secondary business name for the applicable individual. 7.3.2
result.contact.comment string Comments or notes about the current context. 7.3.2
result.contact.deceasedDate dateTime The date of death. This field is active only when the Contact Type selected is Individual. 7.3.2
result.contact.driverLicenseNumber string The driver's license number of the contact. This field is active only when the Contact Type selected is Individual. 7.3.2
result.contact.driverLicenseState result.contact.driverLicenseState{} The state that issued the driver's license. 7.3.2
result.contact.driverLicenseState.text string The localized display text. 7.3.2
result.contact.driverLicenseState.value string The value for the specified parameter. 7.3.2
result.contact.email string The contact's email address. 7.3.2
result.contact.fax string The fax number for the contact. 7.3.2
result.contact.faxCountryCode string Fax Number Country Code 7.3.2
result.contact.federalEmployerId string The Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
result.contact.firstName string The contact's first name. This field is only active when the Contact Type selected is Individual. 7.3.2
result.contact.fullName string The contact's full name. This field is only active when the Contact Type selected is Individual. 7.3.2
result.contact.gender result.contact.gender{} The gender (male or female) of the individual. 7.3.2
result.contact.gender.text string The localized display text. 7.3.2
result.contact.gender.value string The value for the specified parameter. 7.3.2
result.contact.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.contact.individualOrOrganization string The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization. 7.3.2
result.contact.lastName string The last name (surname). 7.3.2
result.contact.middleName string The middle name. 7.3.2
result.contact.organizationName string The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization. 7.3.2
result.contact.passportNumber string The contact's passport number. This field is only active when the Contact Type selected is Individual. 7.3.2
result.contact.phone1 string The primary telephone number of the contact. 7.3.2
result.contact.phone1CountryCode string Phone Number 1 Country Code 7.3.2
result.contact.phone2 string The secondary telephone number of the contact. 7.3.2
result.contact.phone2CountryCode string Phone Number 2 Country Code 7.3.2
result.contact.phone3 string The tertiary telephone number for the contact. 7.3.2
result.contact.phone3CountryCode string Phone Number 3 Country Code 7.3.2
result.contact.postOfficeBox string The post office box number. 7.3.2
result.contact.preferredChannel result.contact.preferredChannel{} The method by which the contact prefers to be notified, by phone for example. 7.3.2
result.contact.preferredChannel.text string The localized display text. 7.3.2
result.contact.preferredChannel.value string The value for the specified parameter. 7.3.2
result.contact.race result.contact.race{} The contact's race/ethnicity. 7.3.2
result.contact.race.text string The localized display text. 7.3.2
result.contact.race.value string The value for the specified parameter. 7.3.2
result.contact.relation result.contact.relation{} The contact's relationship to the application or service request. 7.3.2
result.contact.relation.text string The localized display text. 7.3.2
result.contact.relation.value string The value for the specified parameter. 7.3.2
result.contact.salutation result.contact.salutation{} The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual. 7.3.2
result.contact.salutation.text string The localized display text. 7.3.2
result.contact.salutation.value string The value for the specified parameter. 7.3.2
result.contact.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
result.contact.socialSecurityNumber string The individual's social security number. This field is only active when the Contact Type selected is Individual. 7.3.2
result.contact.stateIdNumber string The contact's state ID number. This field is only active when the Contact Type selected is Individual. 7.3.2
result.contact.status result.contact.status{} The contact status. 7.3.2
result.contact.status.text string The localized display text. 7.3.2
result.contact.status.value string The value for the specified parameter. 7.3.2
result.contact.suffix string The contact name suffix. 7.3.2
result.contact.title string The individual's business title. 7.3.2
result.contact.tradeName string The contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization. 7.3.2
result.contact.type result.contact.type{} The type of people to contact. 7.3.2
result.contact.type.text string The localized display text. 7.3.2
result.contact.type.value string The value for the specified parameter. 7.3.2
result.contactFirstName string The first name of the contact. 7.3.2
result.contactLastName string The last name of the contact. 7.3.2
result.contactMiddleName string The middle name of the contact. 7.3.2
result.desiredAMPM string Indicates whether the desired inspection time is AM or PM. 7.3.2
result.desiredDate dateTime The desired inspection date. 7.3.2
result.desiredTime string The desired inspection time. 7.3.2
result.endMileage float The ending mileage for the inspection. 7.3.2
result.endTime dateTime The time the inspection was completed. 7.3.2
result.estimatedEndTime string inspection estimated end time. 7.3.2
result.estimatedStartTime string The scheduled start time for the inspection. 7.3.2
result.gisAreaName string The GIS Object ID of the parent application if the application that the inspection is scheduled for has a parent application that is a project application. 7.3.2
result.grade string The name of the inspection grade. 7.3.2
result.id long The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.inspectorFullName string The name of the inspector performing the assessment. 7.3.2
result.inspectorId string The ID number of the inspector. 7.3.2
result.isAutoAssign string This defines whether or not you want to automatically reschedule the inspection when the previous inspection status attains Approved status. 7.3.2
result.latitude float The angular distance of a place north or south of the earth's equator, usually expressed in degrees and minutes. 7.3.2
result.longitude float The angular distance of a place east or west of the meridian at Greenwich, England, usually expressed in degrees and minutes. 7.3.2
result.majorViolation long The number of major violations. 7.3.2
result.overtime string A labor cost factor that indicates time worked beyond a worker's regular working hours. 7.3.2
result.priority double The priority level assigned to the inspection. 7.3.2
result.publicVisible string This defines whether or not Accela Citizen Access users can view comment about the inspection results. 7.3.2
result.record result.record{} Contains record information. 7.3.2
result.record.actualProductionUnit double Estimated cost per production unit. 7.3.2
result.record.appearanceDate dateTime The date for a hearing appearance. 7.3.2
result.record.appearanceDayOfWeek string The day for a hearing appearance. 7.3.2
result.record.assignedDate dateTime The date of the assigned action. 7.3.2
result.record.assignedToDepartment string The department responsible for the action. 7.3.2
result.record.assignedUser string The staff member responsible for the action. 7.3.2
result.record.balance Double The balance of the account. 7.3.2
result.record.booking Boolean Indicates whether or not there was a booking in addition to a citation. 7.3.2
result.record.closedByDepartment string The department responsible for closure. 7.3.2
result.record.closedByUser string The staff member responsible for closure. 7.3.2
result.record.closedDate dateTime The closure date. 7.3.2
result.record.completedByDepartment string The department responsible for completion. 7.3.2
result.record.completedByUser string The staff member responsible for completion. 7.3.2
result.record.completedDate dateTime The date of completion. 7.3.2
result.record.constructionType result.record.constructionType{} The US Census Bureau construction type code. 7.3.2
result.record.constructionType.text string The localized display text. 7.3.2
result.record.constructionType.value string The value for the specified parameter. 7.3.2
result.record.costPerUnit double The cost for one unit. 7.3.2
result.record.createdBy string The unique user id of the individual that created the entry. 7.3.2
result.record.createdByCloning string Indictes whether or not the record was cloned. 7.3.2
result.record.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.record.defendantSignature Boolean Indicates whether or not a defendant's signature has been obtained. 7.3.2
result.record.description string The description of the record or item. 7.3.2
result.record.enforceDepartment string The name of the department responsible for enforcement. 7.3.2
result.record.enforceUser string Name of the enforcement officer. 7.3.2
result.record.enforceUserId string ID number of the enforcement officer. 7.3.2
result.record.estimatedCostPerUnit double The estimated cost per unit. 7.3.2
result.record.estimatedDueDate dateTime The estimated date of completion. 7.3.2
result.record.estimatedProductionUnit double The estimated number of production units. 7.3.2
result.record.estimatedTotalJobCost double The estimated cost of the job. 7.3.2
result.record.firstIssuedDate dateTime The first issued date for license. 7.3.2
result.record.housingUnits long The number of housing units. 7.3.2
result.record.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.record.infraction Boolean This defines whether or not an infraction occurred. 7.3.2
result.record.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.record.inPossessionTime double The application level in possession time of the time tracking feature. 7.3.2
result.record.inspectorDepartment string The name of the department where the inspector works. 7.3.2
result.record.inspectorId string The ID number of the inspector. 7.3.2
result.record.inspectorName string The name of the inspector. 7.3.2
result.record.jobValue double The value of the job. 7.3.2
result.record.misdemeanor Boolean Indicates whether or not a misdemeanor occurred. 7.3.2
result.record.module string Use to filter by the module. 7.3.2
result.record.name string The full name for the application contact. 7.3.2
result.record.numberOfBuildings long The number of buildings. 7.3.2
result.record.offenseWitnessed Boolean Indicates whether or not there was a witness to the alleged offense. 7.3.2
result.record.openedDate dateTime The date when the system created the record. 7.3.2
result.record.overallApplicationTime double The amount of elapsed time from the time tracking start date to the completion of the application. 7.3.2
result.record.priority result.record.priority{} The priority level assigned to the record. 7.3.2
result.record.priority.text string The localized display text. 7.3.2
result.record.priority.value string The value for the specified parameter. 7.3.2
result.record.publicOwned Boolean A flag that indicates whether or not the public owns the item. 7.3.2
result.record.recordClass string General information about the record. 7.3.2
result.record.renewalInfo result.record.renewalInfo{} Defines the parameters related to renewal of a record. 7.3.2
result.record.renewalInfo.expirationCode string A short descriptive name used to identify the expiration of a renewal process 7.3.2
result.record.renewalInfo.expirationDate dateTime The date when the condition expires. 7.3.2
result.record.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.record.renewalInfo.expirationStatus result.record.renewalInfo.expirationStatus{} Indicates whether the expiration is enabled or disabled. 7.3.2
result.record.renewalInfo.expirationStatus.text string The localized display text. 7.3.2
result.record.renewalInfo.expirationStatus.value string The value for the specified parameter. 7.3.2
result.record.renewalInfo.expirationUnit string The unit of expiration period (days or months). 7.3.2
result.record.renewalInfo.gracePeriodInterval Long The number of days or months between the expiration and the start of penalty. 7.3.2
result.record.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.record.renewalInfo.penaltyFeeCode string The code for the fee item to use to calculate a penalty fee. 7.3.2
result.record.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.record.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.record.renewalInfo.penaltyPeriodNumber Long The number of penalty periods that can pass before a license becomes inactive. 7.3.2
result.record.renewalInfo.renewalFeeCode string The function code for calculating a renewal fee. 7.3.2
result.record.renewalInfo.renewalFeeFunction string The name of the function for calculating a renewal fee. 7.3.2
result.record.reportedChannel result.record.reportedChannel{} The incoming channel through which the applicant submitted the application. 7.3.2
result.record.reportedChannel.text string The localized display text. 7.3.2
result.record.reportedChannel.value string The value for the specified parameter. 7.3.2
result.record.reportedDate dateTime The date when a complaint or incident is reported. 7.3.2
result.record.reportedType result.record.reportedType{} The type of complaint or incident being reported. 7.3.2
result.record.reportedType.text string The localized display text. 7.3.2
result.record.reportedType.value string The value for the specified parameter. 7.3.2
result.record.scheduledDate dateTime The date when the inspection gets scheduled. 7.3.2
result.record.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
result.record.severity result.record.severity{} Indicates the severity of the condition. 7.3.2
result.record.severity.text string The localized display text. 7.3.2
result.record.severity.value string The value for the specified parameter. 7.3.2
result.record.shortNotes string A brief note about the record subject. 7.3.2
result.record.status result.record.status{} The record status. 7.3.2
result.record.status.text string The localized display text. 7.3.2
result.record.status.value string The value for the specified parameter. 7.3.2
result.record.statusDate dateTime The date when the current status changed. 7.3.2
result.record.statusReason result.record.statusReason{} The reason for the status setting on the record. 7.3.2
result.record.statusReason.text string The localized display text. 7.3.2
result.record.statusReason.value string The value for the specified parameter. 7.3.2
result.record.totalFee Double The total amount of the fees invoiced to the record. 7.3.2
result.record.totalJobCost double The combination of work order assignments (labor) and costs. 7.3.2
result.record.totalPay Double The total amount of pay. 7.3.2
result.record.trackingId long The application tracking number (IVR tracking number). 7.3.2
result.record.type result.record.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.record.type.category string The 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.record.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.record.type.group string The 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.record.type.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.record.type.module string Use to filter by the module. 7.3.2
result.record.type.subType string The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.record.type.text string The localized display text. 7.3.2
result.record.type.type string The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.record.type.value string The value for the specified parameter. 7.3.2
result.record.undistributedCost double The undistributed costs for this work order. 7.3.2
result.record.value string The value for the specified parameter. 7.3.2
result.recordId result.recordId{} The unique ID associated with a record. 7.3.2
result.recordId.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.recordId.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.recordId.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
result.recordId.trackingId long The application tracking number (IVR tracking number). 7.3.2
result.recordId.value string The value for the specified parameter. 7.3.2
result.recordType result.recordType{} The type of application. The available application type options include all the application types that your agency administrator sets as enabled. 7.3.2
result.recordType.category string The 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.recordType.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.recordType.group string The 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.recordType.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.recordType.module string Use to filter by the module. 7.3.2
result.recordType.subType string The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.recordType.text string The localized display text. 7.3.2
result.recordType.type string The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.recordType.value string The value for the specified parameter. 7.3.2
result.requestAMPM string The time segment, AM or PM, for the time specified in the requestTime field. 7.3.2
result.requestComment string Comments about the new inspection. For example, you may identify who requested the inspection. 7.3.2
result.requestDate dateTime The date when an inspection request is submitted. 7.3.2
result.requestorFirstName string The first name of the person requesting an inspection-related operation. 7.3.2
result.requestorLastName string The last name of the person requesting an inspection-related operation. 7.3.2
result.requestorMiddleName string The middle name of the person requesting an inspection-related operation. 7.3.2
result.requestorPhone string The telephone number for the person who processes the inspection request or schedules the inspection. 7.3.2
result.requestorPhoneIDD string The telephone number for the person who processes the inspection request or schedules the inspection. 7.3.2
result.requestorUserId string The user Id of the person requesting an inspection-related operation. 7.3.2
result.requestTime string This time is automatically generated when a new inspection is scheduled and submitted. 7.3.2
result.requiredInspection string This defines whether the inspection is optional or required. 7.3.2
result.resultComment string The inspection result comments. 7.3.2
result.resultType string The type of result that can be ascibed to an inspection. There are three result types: Approved: Approves (passes) the checklist item. Denied: Denies (fails) the checklist item. Informational: Indicates that the checklist items do not need a status of app 7.3.2
result.scheduleDate dateTime The date when the inspection gets scheduled. 7.3.2
result.scheduleEndAMPM string Indicates whether the scheduleEndTime is in the AM or PM. 7.3.2
result.scheduleEndTime string The scheduled end time for the inspection. 7.3.2
result.scheduleStartAMPM string AM indicates the 12 hour period from midnight to noon. PM indicates the 12 hour period from noon to midnight. 7.3.2
result.scheduleStartTime string The scheduled start time for the inspection. 7.3.2
result.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
result.startMileage float The starting mileage for the inspection. 7.3.2
result.startTime dateTime The time when you started the inspection. 7.3.2
result.status result.status{} The inspection 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.submitAMPM string The time block for the scheduled inspection. 7.3.2
result.submitDate dateTime The date that the inspection was submitted. 7.3.2
result.submitTime string The time that a new inspection is submitted. Accela Automation generates this value. 7.3.2
result.totalMileage float The total mileage for the inspection. 7.3.2
result.totalScore long The overall score of the inspection that includes the inspection result, inspection grade, checklist total score and checklist major violation option. 7.3.2
result.totalTime double The total amount of time used to do an inspection. 7.3.2
result.type result.type{} The inspection type. 7.3.2
result.type.group string The name of a group of inspection types. 7.3.2
result.type.id long The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.type.text string The localized display text. 7.3.2
result.type.value string The value for the specified parameter. 7.3.2
result.unitNumber string The number of time units (see timeUnitDuration) comprising an inspection. 7.3.2
result.units double The amount of time comprising the smallest time unit for conducting an inspection. 7.3.2
result.vehicleId string A number, such as the license plate number or VIN, that identifies the vehicle used to complete an inspection. 7.3.2
status integer The record status. 7.3.3

Example

Sample Response Body

{
  "result": [
    {
      "address": {
        "id": 1000183940,
        "streetStart": 2012,
        "refAddressId": 15400,
        "isPrimary": "Y",
        "serviceProviderCode": "ISLANDTON",
        "city": "PETALUMA",
        "postalCode": "94952",
        "streetName": "APPALOOSA",
        "country": {
          "value": "US",
          "text": "United States"
        },
        "status": {
          "value": "A",
          "text": "Active"
        },
        "state": {
          "value": "CA",
          "text": "CA"
        },
        "streetSuffix": {
          "value": "DR",
          "text": "DR"
        }
      },
      "id": 3897172,
      "priority": 0,
      "requiredInspection": "N",
      "inspectorFullName": "Accela Administrator",
      "category": "Insp Rescheduled",
      "requestAMPM": "AM",
      "requestTime": "12:27",
      "commentDisplay": "N",
      "requestorFirstName": "Accela",
      "requestorLastName": "Administrator",
      "publicVisible": "Y",
      "status": {
        "value": "Rescheduled",
        "text": "Rescheduled"
      },
      "serviceProviderCode": "ISLANDTON",
      "type": {
        "value": "Set Backs",
        "id": 97,
        "group": "BLD_COMM",
        "text": "Set Backs"
      },
      "inspectorId": "ADMIN",
      "recordId": {
        "id": "ISLANDTON-12CAP-00000-00003",
        "serviceProviderCode": "ISLANDTON",
        "trackingId": 226895672,
        "customId": "BLD12-00002",
        "value": "12CAP-00000-00003"
      },
      "isAutoAssign": "N",
      "requestDate": "2012-07-16",
      "submitDate": "2012-07-16",
      "scheduleDate": "2012-07-16"
    },
    {
      "address": {
        "id": 1000183940,
        "streetStart": 2012,
        "refAddressId": 15400,
        "isPrimary": "Y",
        "serviceProviderCode": "ISLANDTON",
        "city": "PETALUMA",
        "postalCode": "94952",
        "streetName": "APPALOOSA",
        "country": {
          "value": "US",
          "text": "United States"
        },
        "status": {
          "value": "A",
          "text": "Active"
        },
        "state": {
          "value": "CA",
          "text": "CA"
        },
        "streetSuffix": {
          "value": "DR",
          "text": "DR"
        }
      },
      "id": 3897270,
      "priority": 0,
      "requiredInspection": "N",
      "inspectorFullName": "Accela Administrator",
      "category": "Insp Completed",
      "completedAMPM": "AM",
      "completedTime": "01:21",
      "submitAMPM": "AM",
      "submitTime": "02:22",
      "requestAMPM": "PM",
      "requestTime": "10:44",
      "commentDisplay": "N",
      "resultType": "APPROVED",
      "requestorFirstName": "Accela",
      "requestorLastName": "Administrator",
      "publicVisible": "Y",
      "status": {
        "value": "Passed",
        "text": "Passed"
      },
      "serviceProviderCode": "ISLANDTON",
      "type": {
        "value": "Set Backs",
        "id": 97,
        "group": "BLD_COMM",
        "text": "Set Backs"
      },
      "inspectorId": "ADMIN",
      "recordId": {
        "id": "ISLANDTON-12CAP-00000-00003",
        "serviceProviderCode": "ISLANDTON",
        "trackingId": 226895672,
        "customId": "BLD12-00002",
        "value": "12CAP-00000-00003"
      },
      "isAutoAssign": "N",
      "requestDate": "2012-07-22",
      "completedDate": "2012-07-24",
      "submitDate": "2012-07-23",
      "scheduleDate": "2012-07-22"
    },
    {
      "address": {
        "id": 1000183940,
        "streetStart": 2012,
        "refAddressId": 15400,
        "isPrimary": "Y",
        "serviceProviderCode": "ISLANDTON",
        "city": "PETALUMA",
        "postalCode": "94952",
        "streetName": "APPALOOSA",
        "country": {
          "value": "US",
          "text": "United States"
        },
        "status": {
          "value": "A",
          "text": "Active"
        },
        "state": {
          "value": "CA",
          "text": "CA"
        },
        "streetSuffix": {
          "value": "DR",
          "text": "DR"
        }
      },
      "id": 3897271,
      "priority": 0,
      "requiredInspection": "N",
      "inspectorFullName": "Accela Administrator",
      "category": "Insp Completed",
      "completedAMPM": "AM",
      "completedTime": "01:29",
      "submitAMPM": "AM",
      "submitTime": "02:29",
      "requestAMPM": "AM",
      "requestTime": "2:28",
      "commentDisplay": "N",
      "resultType": "APPROVED",
      "requestorFirstName": "Accela",
      "requestorLastName": "Administrator",
      "publicVisible": "Y",
      "status": {
        "value": "Passed",
        "text": "Passed"
      },
      "serviceProviderCode": "ISLANDTON",
      "type": {
        "value": "Set Backs",
        "id": 97,
        "group": "BLD_COMM",
        "text": "Set Backs"
      },
      "inspectorId": "ADMIN",
      "recordId": {
        "id": "ISLANDTON-12CAP-00000-00003",
        "serviceProviderCode": "ISLANDTON",
        "trackingId": 226895672,
        "customId": "BLD12-00002",
        "value": "12CAP-00000-00003"
      },
      "isAutoAssign": "N",
      "requestDate": "2012-07-23",
      "completedDate": "2012-07-24",
      "submitDate": "2012-07-23",
      "scheduleDate": "2012-07-23"
    }
  ],
  "page": {
    "offset": 0,
    "total": 3,
    "limit": 25,
    "hasmore": false
  },
  "status": 200
}