Finds the inspections that match the search criteria.
Scope |
inspections Deprecated scope name: search_inspections |
App Type | All |
Authorization Type | Access token |
URI | /v4/search/inspections?limit={limit}&offset={offset}&fields={fields}&lang={lang}&hasTotal={hasTotal}&fields={fields}&expand={expand} |
HTTP Method | POST |
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 | |
hasTotal | boolean | No | true | false | Indicates whether or not the inspection has a total. | 7.3.2 |
address | address{} | No | The address of the subject. | 7.3.2 | |
address.city | string | No | The name of the city. | 7.3.2 | |
address.description | string | No | The address description. | 7.3.2 | |
address.direction | address.direction{} | No | The street direction. | 7.3.2 | |
address.direction.text | string | No | The localized display text. | 7.3.2 | |
address.direction.value | string | No | The value for the specified parameter. | 7.3.2 | |
address.houseAlphaEnd | string | No | The ending street number that makes up the address. | 7.3.2 | |
address.houseAlphaStart | string | No | The beginning street number that makes up the address. | 7.3.2 | |
address.houseFractionStart | address.houseFractionStart{} | No | Get All Address Street Fractions | Used in combination with the Street # fields. | 7.3.2 |
address.houseFractionStart.text | string | No | The localized display text. | 7.3.2 | |
address.houseFractionStart.value | string | No | The value for the specified parameter. | 7.3.2 | |
address.levelEnd | string | No | The ending level number (floor number) that makes up the address within a complex. | 7.3.2 | |
address.levelPrefix | string | No | The prefix for the level numbers (floor numbers) that make up the address. | 7.3.2 | |
address.levelStart | string | No | The beginning level number (floor number) that makes up the address within a complex. | 7.3.2 | |
address.postalCode | string | No | The postal ZIP code for the address. | 7.3.2 | |
address.secondaryStreet | string | No | 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 | |
address.secondaryStreetNumber | long | No | 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 | |
address.state | address.state{} | No | Get All Address States | The state corresponding to the address on record. | 7.3.2 |
address.state.text | string | No | The localized display text. | 7.3.2 | |
address.state.value | string | No | The value for the specified parameter. | 7.3.2 | |
address.streetEnd | long | No | The end of a range of street numbers. | 7.3.2 | |
address.streetEndFrom | long | No | The start of the street End range. | 7.3.2 | |
address.streetEndTo | long | No | The last of the street End range. | 7.3.2 | |
address.streetName | string | No | The street name for the address. | 7.3.2 | |
address.streetStart | long | No | The start of a range of street numbers. | 7.3.2 | |
address.streetStartFrom | long | No | The first of the street start range. | 7.3.2 | |
address.streetStartTo | long | No | The last of the street start range. | 7.3.2 | |
address.streetSuffix | address.streetSuffix{} | No | Get All Address Street Suffixes | The type of street such as "Lane" or "Boulevard". | 7.3.2 |
address.streetSuffix.text | string | No | The localized display text. | 7.3.2 | |
address.streetSuffix.value | string | No | The value for the specified parameter. | 7.3.2 | |
address.streetSuffixDirection | address.streetSuffixDirection{} | No | Get All Address Street Directions | 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 |
address.streetSuffixDirection.text | string | No | The localized display text. | 7.3.2 | |
address.streetSuffixDirection.value | string | No | The value for the specified parameter. | 7.3.2 | |
address.unitEnd | string | No | The end parameter of a range of unit numbers. | 7.3.2 | |
address.unitStart | string | No | The starting parameter of a range of unit numbers. | 7.3.2 | |
address.unitType | address.unitType{} | No | Get All Address Unit Types | The unit type designation of the address. | 7.3.2 |
address.unitType.text | string | No | The localized display text. | 7.3.2 | |
address.unitType.value | string | No | The value for the specified parameter. | 7.3.2 | |
address.validateFlag | string | No | 7.3.2 | ||
address.xCoordinate | double | No | The longitudinal coordinate for this address. | 7.3.2 | |
address.yCoordinate | double | No | The latitudinal coordinate for this address. | 7.3.2 | |
billable | string | No | Y | N | This defines whether or not the item is billable. | 7.3.2 |
category | string | No | The inspection category, which is used to organize inspection types. An inspection type is assigned to one or more inspection categories. | 7.3.2 | |
completedDateFrom | dateTime | No | The start of the completion date range. | 7.3.2 | |
completedDateTo | dateTime | No | The end of the completion date range. | 7.3.2 | |
contact | contact{} | No | The contact information. | 7.3.2 | |
contact.busName2 | string | No | The business name. | 7.3.2 | |
contact.firstName | string | No | The contact's first name. This field is only active when the Contact Type selected is Individual. | 7.3.2 | |
contact.fullName | string | No | The contact's full name. This field is only active when the Contact Type selected is Individual. | 7.3.2 | |
contact.id | string | No | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.2 | |
contact.lastName | string | No | The last name (surname). | 7.3.2 | |
contact.middleName | string | No | The middle name. | 7.3.2 | |
contact.organizationName | string | No | The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization. | 7.3.2 | |
contact.relation | contact.relation{} | No | The contact's relationship to the application or service request. | 7.3.2 | |
contact.relation.text | string | No | The localized display text. | 7.3.2 | |
contact.relation.value | string | No | The value for the specified parameter. | 7.3.2 | |
contact.suffix | string | No | The contact name suffix. | 7.3.2 | |
contact.tradeName | string | No | The contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization. | 7.3.2 | |
contact.type | contact.type{} | No | Get All Contact Types | The type of people to contact. | 7.3.2 |
contact.type.text | string | No | The localized display text. | 7.3.2 | |
contact.type.value | string | No | The value for the specified parameter. | 7.3.2 | |
direction | string | No | ASC | DESC | Specifies whether to sort in ascending or descending order. Default is ASC. | 7.3.2 |
endMileage | float | No | The ending mileage for the inspection. | 7.3.2 | |
endTime | dateTime | No | The time the inspection was completed. | 7.3.2 | |
gisAreaName | string | No | 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 | |
inspectorId | string | No | Get All Inspectors | The ID number of the inspector. | 7.3.2 |
latitude | float | No | The angular distance of a place north or south of the earth's equator, usually expressed in degrees and minutes. | 7.3.2 | |
longitude | float | No | The angular distance of a place east or west of the meridian at Greenwich, England, usually expressed in degrees and minutes. | 7.3.2 | |
overtime | string | No | A labor cost factor that indicates time worked beyond a worker's regular working hours. | 7.3.2 | |
parcel | parcel{} | No | The official parcel name or number, as determined by the county assessor or other responsible department. | 7.3.2 | |
parcel.block | string | No | The block number associated with the parcel. | 7.3.2 | |
parcel.lot | string | No | This is the lot name. | 7.3.2 | |
parcel.parcelNumber | string | No | The localized display text. | 7.3.2 | |
parcel.range | string | No | When land is surveyed using the rectangular-survey system, range represents the measure of units east and west of the base line. | 7.3.2 | |
parcel.section | long | No | A piece of a township measuring 640 acres, one square mile, numbered with reference to the base line and meridian line. | 7.3.2 | |
parcel.subdivision | parcel.subdivision{} | No | The name of the subdivision. | 7.3.2 | |
parcel.subdivision.text | string | No | The localized display text. | 7.3.2 | |
parcel.subdivision.value | string | No | The value for the specified parameter. | 7.3.2 | |
parcel.township | string | No | When land is surveyed using the rectangular-survey system, township represents the measure of units North or South of the base line. Townships typically measure 6 miles to a side, or 36 square miles. | 7.3.2 | |
parcel.tract | string | No | The name of the tract associated with this application. A tract may contain one or more related parcels. | 7.3.2 | |
publicVisible | string | No | Y | N | Indicates whether or not Accela Citizen Access users can view comment about the inspection results. | 7.3.2 |
recordId | recordId{} | No | Get All Records Search Records Get My Records | The unique ID associated with a record. | 7.3.2 |
recordId.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 | |
recordId.id | string | No | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.2 | |
recordId.serviceProviderCode | string | No | The unique agency identifier, the system assigns, on the Accela Civic Platform. | 7.3.2 | |
recordId.trackingId | long | No | The application tracking number (IVR tracking number). | 7.3.2 | |
recordId.value | string | No | The value for the specified parameter. | 7.3.2 | |
recordTypes[] | recordTypes{} | No | Get All Record Types | Contains record types and their type properties. | 7.3.2 |
recordTypes.category | string | No | The 4th level in a 4-level record type structure (Group-Type-Subtype-Category). | 7.3.2 | |
recordTypes.filterName | string | No | The name of the record type filter which defines the record types to be displayed for the citizen user. | 7.3.2 | |
recordTypes.group | string | No | The 1st level in a 4-level record type structure (Group-Type-Subtype-Category). | 7.3.2 | |
recordTypes.id | string | No | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.2 | |
recordTypes.module | string | No | Get All Modules | Use to filter by the module. | 7.3.2 |
recordTypes.subType | string | No | The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). | 7.3.2 | |
recordTypes.text | string | No | The localized display text. | 7.3.2 | |
recordTypes.type | string | No | The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). | 7.3.2 | |
recordTypes.value | string | No | The value for the specified parameter. | 7.3.2 | |
requestDateFrom | dateTime | No | The date from which to start search for requested inspections. | 7.3.2 | |
requestDateTo | dateTime | No | The date up to which to start search for requested inspections. | 7.3.2 | |
scheduleDateFrom | dateTime | No | The date from which to start search for scheduled inspections. | 7.3.2 | |
scheduleDateTo | dateTime | No | The date up to which to start search for scheduled inspections. | 7.3.2 | |
scheduleEndAMPM | string | No | AM | PM | Indicates whether the scheduleEndTime is in the AM or PM. | 7.3.2 |
scheduleEndTime | string | No | The scheduled end time for the inspection. | 7.3.2 | |
scheduleStartAMPM | string | No | AM | PM | AM indicates the 12 hour period from midnight to noon. PM indicates the 12 hour period from noon to midnight. | 7.3.2 |
scheduleStartTime | string | No | The scheduled start time for the inspection. | 7.3.2 | |
sort | string | No | scheduleDate | The result set is sorted by the specified field name. Specify the sort order in the "direction" parameter. The default sort order is the ascending order.
Note: Search Inspections currently only supports sorting by |
7.3.2 |
startMileage | float | No | The starting mileage for the inspection. | 7.3.2 | |
startTime | dateTime | No | The time when you started the inspection. | 7.3.2 | |
status | status{} | No | Get All Inspection Statuses | The inspection status. | 7.3.2 |
status.text | string | No | The localized display text. | 7.3.2 | |
status.value | string | No | The value for the specified parameter. | 7.3.2 | |
submitDateFrom | dateTime | No | The date from which to start search for submitted inspections. | 7.3.2 | |
submitDateTo | dateTime | No | The date up to which to start search for submitted inspections. | 7.3.2 | |
totalMileage | float | No | The total mileage for the inspection. | 7.3.2 | |
totalTime | double | No | The total amount of time used to do an inspection. | 7.3.2 | |
types[] | types{} | No | Get All Inspection Types Get Inspection Types | Contains inspection types and their type properties. | 7.3.2 |
types.group | string | No | The name of a group of inspection types. | 7.3.2 | |
types.id | long | No | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.2 | |
types.text | string | No | The localized display text. | 7.3.2 | |
types.value | string | No | The value for the specified parameter. | 7.3.2 | |
unitNumber | string | No | The number of time units (see timeUnitDuration) comprising an inspection. | 7.3.2 | |
vehicleId | string | No | A number, such as the license plate number or VIN, that identifies the vehicle used to complete an inspection. | 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 |
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 address of the subject. | 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 |