Get Related Inspections

Gets the related (child) inspections for the specified parent inspection.

Resource Information

Scopeinspections

Deprecated scope name:   get_inspection_related

App TypeAll
Authorization TypeAccess token
URI /v4/inspections/{id}/related?relationship={relationship}&fields={fields}&lang={lang}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
fieldsstringNo Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.2
idstringYes The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
langStringNo Indicates the language applied.7.3.2
relationshipstringNoparent | child | renewalThe type of relationship of a related record.7.3.2

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.addressresult.address{}The address of the subject.7.3.2
result.address.addressLine1stringThe first line of the address. 7.3.2
result.address.addressLine2stringThe second line of the address.7.3.2
result.address.addressTypeFlagresult.address.addressTypeFlag{}The current status of the address record.7.3.2
result.address.addressTypeFlag.textstringThe localized display text.7.3.2
result.address.addressTypeFlag.valuestringThe value for the specified parameter.7.3.2
result.address.citystringThe name of the city.7.3.2
result.address.countryresult.address.country{}The name of the country.7.3.2
result.address.country.textstringThe localized display text.7.3.2
result.address.country.valuestringThe value for the specified parameter.7.3.2
result.address.countystringThe name of the county.7.3.2
result.address.descriptionstringThe description of the record or item.7.3.2
result.address.directionresult.address.direction{}The street direction of the primary address associated with the application.7.3.2
result.address.direction.textstringThe localized display text.7.3.2
result.address.direction.valuestringThe value for the specified parameter.7.3.2
result.address.distancedoubleThe distance from another landmark used to locate the address. 7.3.2
result.address.houseAlphaEndstringThe ending street number that makes up the address.7.3.2
result.address.houseAlphaStartstringThe beginning street number that makes up the address.7.3.2
result.address.houseFractionEndresult.address.houseFractionEnd{}Used in combination with the Street # fields.7.3.2
result.address.houseFractionEnd.textstringThe localized display text.7.3.2
result.address.houseFractionEnd.valuestringThe value for the specified parameter.7.3.2
result.address.houseFractionStartresult.address.houseFractionStart{}Used In combination with the Street # fields.7.3.2
result.address.houseFractionStart.textstringThe localized display text.7.3.2
result.address.houseFractionStart.valuestringThe value for the specified parameter.7.3.2
result.address.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.address.inspectionDistrictstringThe inspection district where the address is located.7.3.2
result.address.inspectionDistrictPrefixstringThe prefix for the inspection district where the address is located.7.3.2
result.address.isPrimarystringIndicates 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.levelEndstringThe ending level number (floor number) that makes up the address within a complex.7.3.2
result.address.levelPrefixstringThe prefix for the level numbers (floor numbers) that make up the address.7.3.2
result.address.levelStartstringThe beginning level number (floor number) that makes up the address within a complex.7.3.2
result.address.neighborhoodstringThe neighborhood where the address is located.7.3.2
result.address.neighborhoodPrefixstringThe prefix for the neighborhood where the address is located.7.3.2
result.address.postalCodestringThe postal ZIP code for the address.7.3.2
result.address.recordIdresult.address.recordId{}The unique ID associated with a record.7.3.2
result.address.recordId.customIdstringAn ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.7.3.2
result.address.recordId.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.address.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.address.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.address.recordId.valuestringThe value for the specified parameter.7.3.2
result.address.refAddressIdlongThe unique Id generated for an address stored in the system.7.3.2
result.address.secondaryStreetstringThis 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.secondaryStreetNumberlongThis 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.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.address.stateresult.address.state{}The state corresponding to the address on record.7.3.2
result.address.state.textstringThe localized display text.7.3.2
result.address.state.valuestringThe value for the specified parameter.7.3.2
result.address.statusresult.address.status{}The address status indicating whether the address is active or inactive.7.3.2
result.address.status.textstringThe localized display text.7.3.2
result.address.status.valuestringThe value for the specified parameter.7.3.2
result.address.streetAddressstringThe street address. 7.3.2
result.address.streetEndlongThe end of a range of street numbers.7.3.2
result.address.streetEndFromlongThe start of the street End range.7.3.2
result.address.streetEndTolongThe last of the street End range.7.3.2
result.address.streetNamestringThe street name for the address.7.3.2
result.address.streetPrefixstringAny 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.streetStartlongThe start of a range of street numbers.7.3.2
result.address.streetStartFromlongThe first of the street start range.7.3.2
result.address.streetStartTolongThe last of the street start range.7.3.2
result.address.streetSuffixresult.address.streetSuffix{}The type of street such as "Lane" or "Boulevard".7.3.2
result.address.streetSuffix.textstringThe localized display text.7.3.2
result.address.streetSuffix.valuestringThe value for the specified parameter.7.3.2
result.address.streetSuffixDirectionresult.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.textstringThe localized display text.7.3.2
result.address.streetSuffixDirection.valuestringThe value for the specified parameter.7.3.2
result.address.typeresult.address.type{}The address type.7.3.2
result.address.type.textstringThe localized display text.7.3.2
result.address.type.valuestringThe value for the specified parameter.7.3.2
result.address.unitEndstringThe end parameter of a range of unit numbers.7.3.2
result.address.unitStartstringThe starting parameter of a range of unit numbers.7.3.2
result.address.unitTyperesult.address.unitType{}The unit type designation of the address.7.3.2
result.address.unitType.textstringThe localized display text.7.3.2
result.address.unitType.valuestringThe value for the specified parameter.7.3.2
result.address.xCoordinatedoubleThe longitudinal coordinate for this address. 7.3.2
result.address.yCoordinatedoubleThe latitudinal coordinate for this address. 7.3.2
result.billablestringThis defines whether or not the item is billable.7.3.2
result.categorystringThe inspection category, which is used to organize inspection types. An inspection type is assigned to one or more inspection categories.7.3.2
result.commentDisplaystringIndicates whether or not Accela Citizen Access users can view the inspection results comments.7.3.2
result.commentPublicVisible[]stringSpecifies 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.completedAMPMstringIndicates whether completed time is "AM" or "PM".7.3.2
result.completedDatedateTimeThe date of completion.7.3.2
result.completedTimestringThe time of completion.7.3.2
result.contactresult.contact{}The contact information.7.3.2
result.contact.addressresult.contact.address{}The citizen user's address.7.3.2
result.contact.address.addressLine1stringThe first line of the address. 7.3.2
result.contact.address.addressLine2stringThe second line of the address.7.3.2
result.contact.address.addressLine3stringThe third line of the address.7.3.2
result.contact.address.citystringThe name of the city.7.3.2
result.contact.address.countryresult.contact.address.country{}The name of the country.7.3.2
result.contact.address.country.textstringThe localized display text.7.3.2
result.contact.address.country.valuestringThe value for the specified parameter.7.3.2
result.contact.address.postalCodestringThe postal ZIP code for the address.7.3.2
result.contact.address.stateresult.contact.address.state{}The state corresponding to the address on record.7.3.2
result.contact.address.state.textstringThe localized display text.7.3.2
result.contact.address.state.valuestringThe value for the specified parameter.7.3.2
result.contact.birthCityresult.contact.birthCity{}The city of birth for an individual.7.3.2
result.contact.birthCity.textstringThe localized display text.7.3.2
result.contact.birthCity.valuestringThe value for the specified parameter.7.3.2
result.contact.birthDatedateTimeThe birth date of an individual.7.3.2
result.contact.birthRegionresult.contact.birthRegion{}The country of birth or region of birth for an individual.7.3.2
result.contact.birthRegion.textstringThe localized display text.7.3.2
result.contact.birthRegion.valuestringThe value for the specified parameter.7.3.2
result.contact.birthStateresult.contact.birthState{}The state of birth for an individual.7.3.2
result.contact.birthState.textstringThe localized display text.7.3.2
result.contact.birthState.valuestringThe value for the specified parameter.7.3.2
result.contact.businessNamestringA secondary business name for the applicable individual.7.3.2
result.contact.commentstringComments or notes about the current context.7.3.2
result.contact.deceasedDatedateTimeThe date of death. This field is active only when the Contact Type selected is Individual.7.3.2
result.contact.driverLicenseNumberstringThe driver's license number of the contact. This field is active only when the Contact Type selected is Individual.7.3.2
result.contact.driverLicenseStateresult.contact.driverLicenseState{}The state that issued the driver's license.7.3.2
result.contact.driverLicenseState.textstringThe localized display text.7.3.2
result.contact.driverLicenseState.valuestringThe value for the specified parameter.7.3.2
result.contact.emailstringThe contact's email address.7.3.2
result.contact.faxstringThe fax number for the contact.7.3.2
result.contact.faxCountryCodestringFax Number Country Code7.3.2
result.contact.federalEmployerIdstringThe Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
result.contact.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
result.contact.fullNamestringThe contact's full name. This field is only active when the Contact Type selected is Individual.7.3.2
result.contact.genderresult.contact.gender{}The gender (male or female) of the individual.7.3.2
result.contact.gender.textstringThe localized display text.7.3.2
result.contact.gender.valuestringThe value for the specified parameter.7.3.2
result.contact.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.contact.individualOrOrganizationstringThe organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.2
result.contact.lastNamestringThe last name (surname). 7.3.2
result.contact.middleNamestringThe middle name. 7.3.2
result.contact.organizationNamestringThe organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.2
result.contact.passportNumberstringThe contact's passport number. This field is only active when the Contact Type selected is Individual.7.3.2
result.contact.phone1stringThe primary telephone number of the contact. 7.3.2
result.contact.phone1CountryCodestringPhone Number 1 Country Code7.3.2
result.contact.phone2stringThe secondary telephone number of the contact.7.3.2
result.contact.phone2CountryCodestringPhone Number 2 Country Code7.3.2
result.contact.phone3stringThe tertiary telephone number for the contact.7.3.2
result.contact.phone3CountryCodestringPhone Number 3 Country Code7.3.2
result.contact.postOfficeBoxstringThe post office box number.7.3.2
result.contact.preferredChannelresult.contact.preferredChannel{}The method by which the contact prefers to be notified, by phone for example.7.3.2
result.contact.preferredChannel.textstringThe localized display text.7.3.2
result.contact.preferredChannel.valuestringThe value for the specified parameter.7.3.2
result.contact.raceresult.contact.race{}The contact's race/ethnicity.7.3.2
result.contact.race.textstringThe localized display text.7.3.2
result.contact.race.valuestringThe value for the specified parameter.7.3.2
result.contact.relationresult.contact.relation{}The contact's relationship to the application or service request.7.3.2
result.contact.relation.textstringThe localized display text.7.3.2
result.contact.relation.valuestringThe value for the specified parameter.7.3.2
result.contact.salutationresult.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.textstringThe localized display text.7.3.2
result.contact.salutation.valuestringThe value for the specified parameter.7.3.2
result.contact.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.contact.socialSecurityNumberstringThe individual's social security number. This field is only active when the Contact Type selected is Individual.7.3.2
result.contact.stateIdNumberstringThe contact's state ID number. This field is only active when the Contact Type selected is Individual.7.3.2
result.contact.statusresult.contact.status{}The contact status.7.3.2
result.contact.status.textstringThe localized display text.7.3.2
result.contact.status.valuestringThe value for the specified parameter.7.3.2
result.contact.suffixstringThe contact name suffix.7.3.2
result.contact.titlestringThe individual's business title. 7.3.2
result.contact.tradeNamestringThe contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization.7.3.2
result.contact.typeresult.contact.type{}The type of people to contact. 7.3.2
result.contact.type.textstringThe localized display text.7.3.2
result.contact.type.valuestringThe value for the specified parameter.7.3.2
result.contactFirstNamestringThe first name of the contact.7.3.2
result.contactLastNamestringThe last name of the contact.7.3.2
result.contactMiddleNamestringThe middle name of the contact.7.3.2
result.desiredAMPMstringIndicates whether the desired inspection time is AM or PM.7.3.2
result.desiredDatedateTimeThe desired inspection date.7.3.2
result.desiredTimestringThe desired inspection time.7.3.2
result.endMileagefloatThe ending mileage for the inspection.7.3.2
result.endTimedateTimeThe time the inspection was completed.7.3.2
result.estimatedEndTimestringinspection estimated end time.7.3.2
result.estimatedStartTimestringThe scheduled start time for the inspection.7.3.2
result.gisAreaNamestringThe 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.gradestringThe name of the inspection grade. 7.3.2
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.inspectorFullNamestringThe name of the inspector performing the assessment.7.3.2
result.inspectorIdstringThe ID number of the inspector.7.3.2
result.isAutoAssignstringThis defines whether or not you want to automatically reschedule the inspection when the previous inspection status attains Approved status.7.3.2
result.latitudefloatThe angular distance of a place north or south of the earth's equator, usually expressed in degrees and minutes.7.3.2
result.longitudefloatThe angular distance of a place east or west of the meridian at Greenwich, England, usually expressed in degrees and minutes.7.3.2
result.majorViolationlongThe number of major violations.7.3.2
result.overtimestringA labor cost factor that indicates time worked beyond a worker's regular working hours.7.3.2
result.prioritydoubleThe priority level assigned to the inspection.7.3.2
result.publicVisiblestringIndicates whether or not Accela Citizen Access users can view comment about the inspection results.7.3.2
result.recordIdresult.recordId{}The unique ID associated with a record.7.3.2
result.recordId.customIdstringAn ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application.7.3.2
result.recordId.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.recordId.valuestringThe value for the specified parameter.7.3.2
result.recordTyperesult.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.aliasstringThe record type alias.7.3.2
result.recordType.categorystringThe 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.recordType.filterNamestringThe name of the record type filter which defines the record types to be displayed for the citizen user.7.3.2
result.recordType.groupstringThe 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.recordType.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.recordType.modulestringUse to filter by the module.7.3.2
result.recordType.subTypestringThe 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.recordType.textstringThe localized display text.7.3.2
result.recordType.typestringThe 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).7.3.2
result.recordType.valuestringThe value for the specified parameter.7.3.2
result.relationshipstringThe type of relationship of a related record.7.3.2
result.requestAMPMstringThe time segment, AM or PM, for the time specified in the requestTime field.7.3.2
result.requestCommentstringComments about the new inspection. For example, you may identify who requested the inspection.7.3.2
result.requestDatedateTimeThe date when an inspection request is submitted. 7.3.2
result.requestorFirstNamestringThe first name of the person requesting an inspection-related operation.7.3.2
result.requestorLastNamestringThe last name of the person requesting an inspection-related operation.7.3.2
result.requestorMiddleNamestringThe middle name of the person requesting an inspection-related operation.7.3.2
result.requestorPhonestringThe telephone number for the person who processes the inspection request or schedules the inspection.7.3.2
result.requestorPhoneIDDstringThe telephone number for the person who processes the inspection request or schedules the inspection.7.3.2
result.requestorUserIdstringThe user Id of the person requesting an inspection-related operation.7.3.2
result.requestTimestringThis time is automatically generated when a new inspection is scheduled and submitted.7.3.2
result.requiredInspectionstringThis defines whether the inspection is optional or required.7.3.2
result.resultCommentstringThe inspection result comments.7.3.2
result.resultTypestringThe 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 app7.3.2
result.scheduleDatedateTimeThe date when the inspection gets scheduled.7.3.2
result.scheduleEndAMPMstringIndicates whether the scheduleEndTime is in the AM or PM. 7.3.2
result.scheduleEndTimestringThe scheduled end time for the inspection.7.3.2
result.scheduleStartAMPMstringAM indicates the 12 hour period from midnight to noon. PM indicates the 12 hour period from noon to midnight.7.3.2
result.scheduleStartTimestringThe scheduled start time for the inspection.7.3.2
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.startMileagefloatThe starting mileage for the inspection.7.3.2
result.startTimedateTimeThe time when you started the inspection.7.3.2
result.statusresult.status{}The status of inspection-related information.7.3.2
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.submitAMPMstringThe time block for the scheduled inspection.7.3.2
result.submitDatedateTimeThe date that the inspection was submitted. 7.3.2
result.submitTimestringThe time that a new inspection is submitted. Accela Automation generates this value.7.3.2
result.totalMileagefloatThe total mileage for the inspection.7.3.2
result.totalScorelongThe overall score of the inspection that includes the inspection result, inspection grade, checklist total score and checklist major violation option.7.3.2
result.totalTimedoubleThe total amount of time used to do an inspection.7.3.2
result.typeresult.type{}The inspection type.7.3.2
result.type.groupstringThe name of a group of inspection types.7.3.2
result.type.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.type.textstringThe localized display text.7.3.2
result.type.valuestringThe value for the specified parameter.7.3.2
result.unitNumberstringThe number of time units (see timeUnitDuration) comprising an inspection.7.3.2
result.unitsdoubleThe amount of time comprising the smallest time unit for conducting an inspection.7.3.2
result.vehicleIdstringA number, such as the license plate number or VIN, that identifies the vehicle used to complete an inspection.7.3.2
statusintegerThe record status.7.3.3