Update Inspection Condition

Updates the specified conditions for the inspections.

Resource Information

Scope	inspections Deprecated scope name: update_inspection_condition
App Type	Agency
Authorization Type	Access token
URI	/v4/inspections/{inspectionId}/conditions/{id}?lang={lang}
HTTP Method	PUT
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
id	string	Yes	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
actionbyDepartment	actionbyDepartment{}	No	Get All Departments	The department responsible for the action.	7.3.2
actionbyDepartment.text	string	No	�	The localized display text.	7.3.2
actionbyDepartment.value	string	No	�	The value for the specified parameter.	7.3.2
actionbyUser	actionbyUser{}	No	�	The individual responsible for the action.	7.3.2
actionbyUser.text	string	No	�	The localized display text.	7.3.2
actionbyUser.value	string	No	�	The value for the specified parameter.	7.3.2
activeStatus	activeStatus{}	No	A \| I	Indicates whether or not the condition is active.	7.3.2
activeStatus.text	string	No	�	The localized display text.	7.3.2
activeStatus.value	string	No	�	The value for the specified parameter.	7.3.2
additionalInformation	string	No	�	An unlimited text field to use if other fields are filled.	7.3.2
additionalInformationPlainText	string	No	�	An unlimited text field to use if other fields are filled.	7.3.2
appliedbyDepartment	appliedbyDepartment{}	No	Get All Departments	The department responsible for applying a condition.	7.3.2
appliedbyDepartment.text	string	No	�	The localized display text.	7.3.2
appliedbyDepartment.value	string	No	�	The value for the specified parameter.	7.3.2
appliedbyUser	appliedbyUser{}	No	�	The staff member responsible for applying a condition.	7.3.2
appliedbyUser.text	string	No	�	The localized display text.	7.3.2
appliedbyUser.value	string	No	�	The value for the specified parameter.	7.3.2
appliedDate	dateTime	No	�	The date to apply a condition.	7.3.2
dispAdditionalInformationPlainText	string	No	�	An unlimited text field to use if other fields are filled.	7.3.2
displayNoticeInAgency	Boolean	No	true \| false	Indicates whether or not to display the condition notice in Accela Automation when a condition to a record or parcel is applied.	7.3.2
displayNoticeInCitizens	Boolean	No	true \| false	Indicates whether or not to display the condition notice in Accela Citizen Access when a condition to a record or parcel is applied.	7.3.2
displayNoticeInCitizensFee	Boolean	No	true \| false	Indicates whether or not to display the condition notice in Accela Citizen Access Fee Estimate page when a condition to a record or parcel is applied.	7.3.2
displayOrder	long	No	�	The order of the item in comparison to the other items.	7.3.2
effectiveDate	dateTime	No	�	The date when you want the condition to become effective.	7.3.2
expirationDate	dateTime	No	�	The date when the condition expires.	7.3.2
group	group{}	No	�	This is the condition group. The condition group is an attribute of a condition that organizes condition types. Your agency defines these groups.	7.3.2
group.text	string	No	�	The localized display text.	7.3.2
group.value	string	No	�	The value for the specified parameter.	7.3.2
id	long	No	�	The unique identifier for the object, assigned by the Civic Platform server and provided in a response.	7.3.2
inheritable	inheritable{}	No	�	This defines whether or not Accela Automation checks for inheritable conditions when a user associates a child record with a parent record.	7.3.2
inheritable.text	string	No	�	The localized display text.	7.3.2
inheritable.value	string	No	�	The value for the specified parameter.	7.3.2
inspectionId	long	No	Get All Inspections Search Inspections	The unique ID associated with the inspection.	7.3.2
isIncludeNameInNotice	Boolean	No	true \| false	Indicates whether or not to display the condition name in the notice.	7.3.2
isIncludeShortCommentsInNotice	Boolean	No	true \| false	Indicates whether or not to display the condition comments in the notice.	7.3.2
longComments	string	No	�	Narrative comments to help identify the purpose or uses of the standard condition.	7.3.2
name	string	No	�	The full name for the application contact.	7.3.2
priority	priority{}	No	Get All Standard Conditon Priorities	The priority level assigned to the condition.	7.3.2
priority.text	string	No	�	The localized display text.	7.3.2
priority.value	string	No	�	The value for the specified parameter.	7.3.2
publicDisplayMessage	string	No	�	Text entered into this field displays in the condition notice or condition status bar for the Condition Name for the public user in Accela IVR (AIVR) and Accela Citizen Access (ACA).	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
resAdditionalInformationPlainText	string	No	�	An unlimited text field to use if other fields are filled.	7.3.2
resolutionAction	string	No	�	The action performed in response to a condition.	7.3.2
serviceProviderCode	string	No	�	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
severity	severity{}	No	�	Indicates the severity of the condition.	7.3.2
severity.text	string	No	�	The localized display text.	7.3.2
severity.value	string	No	�	The value for the specified parameter.	7.3.2
shortComments	string	No	�	A brief description of the condition name. For example, the text may describe the situation that requires the system to apply the condition. You can set these short comments to display when a user accesses an application with this condition applied to it	7.3.2
status	status{}	No	Get All Standard Condition Statuses Get All Approval Condition Statuses	The inspection condition 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
statusDate	dateTime	No	�	The date when the current status changed.	7.3.2
statusType	string	No	Get All Standard Condition Types	The status type for a standard condition or an approval condition, applied or not applied for example.	7.3.2
type	type{}	No	Get All Standard Condition Types	The condition type.	7.3.2
type.text	string	No	�	The localized display text.	7.3.2
type.value	string	No	�	The value for the specified parameter.	7.3.2
inspectionId	long	Yes	Get All Inspections Search Inspections	The unique ID associated with the inspection.	7.3.2
lang	String	No	�	Indicates the language applied.	7.3.2

Response Information

Field	Type	Description	Automation Version
result	result{}	�	7.3.2
result.actionbyDepartment	result.actionbyDepartment{}	The department responsible for the action.	7.3.2
result.actionbyDepartment.text	string	The localized display text.	7.3.2
result.actionbyDepartment.value	string	The value for the specified parameter.	7.3.2
result.actionbyUser	result.actionbyUser{}	The individual responsible for the action.	7.3.2
result.actionbyUser.text	string	The localized display text.	7.3.2
result.actionbyUser.value	string	The value for the specified parameter.	7.3.2
result.activeStatus	result.activeStatus{}	Indicates whether or not the condition is active.	7.3.2
result.activeStatus.text	string	The localized display text.	7.3.2
result.activeStatus.value	string	The value for the specified parameter.	7.3.2
result.additionalInformation	string	An unlimited text field to use if other fields are filled.	7.3.2
result.additionalInformationPlainText	string	An unlimited text field to use if other fields are filled.	7.3.2
result.appliedbyDepartment	result.appliedbyDepartment{}	The department responsible for applying a condition.	7.3.2
result.appliedbyDepartment.text	string	The localized display text.	7.3.2
result.appliedbyDepartment.value	string	The value for the specified parameter.	7.3.2
result.appliedbyUser	result.appliedbyUser{}	The staff member responsible for applying a condition.	7.3.2
result.appliedbyUser.text	string	The localized display text.	7.3.2
result.appliedbyUser.value	string	The value for the specified parameter.	7.3.2
result.appliedDate	dateTime	The date to apply a condition.	7.3.2
result.dispAdditionalInformationPlainText	string	An unlimited text field to use if other fields are filled.	7.3.2
result.displayNoticeInAgency	Boolean	Indicates whether or not to display the condition notice in Accela Automation when a condition to a record or parcel is applied.	7.3.2
result.displayNoticeInCitizens	Boolean	Indicates whether or not to display the condition notice in Accela Citizen Access when a condition to a record or parcel is applied.	7.3.2
result.displayNoticeInCitizensFee	Boolean	Indicates whether or not to display the condition notice in Accela Citizen Access Fee Estimate page when a condition to a record or parcel is applied.	7.3.2
result.displayOrder	long	The order of the item in comparison to the other items.	7.3.2
result.effectiveDate	dateTime	The date when you want the condition to become effective.	7.3.2
result.expirationDate	dateTime	The date when the condition expires.	7.3.2
result.group	result.group{}	This is the condition group. The condition group is an attribute of a condition that organizes condition types. Your agency defines these groups.	7.3.2
result.group.text	string	The localized display text.	7.3.2
result.group.value	string	The value for the specified parameter.	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.inheritable	result.inheritable{}	This defines whether or not Accela Automation checks for inheritable conditions when a user associates a child record with a parent record.	7.3.2
result.inheritable.text	string	The localized display text.	7.3.2
result.inheritable.value	string	The value for the specified parameter.	7.3.2
result.inspectionId	long	The unique ID associated with the inspection.	7.3.2
result.isIncludeNameInNotice	Boolean	Indicates whether or not to display the condition name in the notice.	7.3.2
result.isIncludeShortCommentsInNotice	Boolean	Indicates whether or not to display the condition comments in the notice.	7.3.2
result.longComments	string	Narrative comments to help identify the purpose or uses of the standard condition.	7.3.2
result.name	string	The full name for the application contact.	7.3.2
result.priority	result.priority{}	The priority level assigned to the condition.	7.3.2
result.priority.text	string	The localized display text.	7.3.2
result.priority.value	string	The value for the specified parameter.	7.3.2
result.publicDisplayMessage	string	Text entered into this field displays in the condition notice or condition status bar for the Condition Name for the public user in Accela IVR (AIVR) and Accela Citizen Access (ACA).	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.resAdditionalInformationPlainText	string	An unlimited text field to use if other fields are filled.	7.3.2
result.resolutionAction	string	The action performed in response to a condition.	7.3.2
result.serviceProviderCode	string	The unique agency identifier, the system assigns, on the Accela Civic Platform.	7.3.2
result.severity	result.severity{}	Indicates the severity of the condition.	7.3.2
result.severity.text	string	The localized display text.	7.3.2
result.severity.value	string	The value for the specified parameter.	7.3.2
result.shortComments	string	A brief description of the condition name. For example, the text may describe the situation that requires the system to apply the condition. You can set these short comments to display when a user accesses an application with this condition applied to it	7.3.2
result.status	result.status{}	The inspection condition status.	7.3.2
result.status.text	string	The localized display text.	7.3.2
result.status.value	string	The value for the specified parameter.	7.3.2
result.statusDate	dateTime	The date when the current status changed.	7.3.2
result.statusType	string	The status type for a standard condition or an approval condition, applied or not applied for example.	7.3.2
result.type	result.type{}	The condition type.	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
status	integer	The record status.	7.3.3