Get All Address Conditions

Returns all the address conditions for a given address. The results can be filtered by type and status.

Resource Information

Scope addresses
App Type All
Authorization Type Access token
URI /v4/addresses/{id}/conditions?type={type}&name={name}&status={status}&offset={offset}&limit={limit}&fields={fields}&lang={lang}
HTTP Method GET
Automation Version(s) 9.0.0

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. 9.0.0
id string Yes   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 9.0.0
lang String No   Indicates the language applied. 9.0.0
limit long No   Indicates the number of items that are returned in each page. 9.0.0
name string No   The name of the object to be queried. 9.0.0
offset long No   Indicates the offset start of each page by the number specified. 9.0.0
status string No   The record status. 9.0.0
type string No   The type of entity to be queried. 9.0.0

Response Information

Field Type Description Automation Version
result[] result{} Contains address condition information. 9.0.0
result.actionbyDepartment result.actionbyDepartment{} The department responsible for the action. 9.0.0
result.actionbyDepartment.text string The localized display text. 9.0.0
result.actionbyDepartment.value string The value for the specified parameter. 9.0.0
result.actionbyUser result.actionbyUser{} The individual responsible for the action. 9.0.0
result.actionbyUser.text string The localized display text. 9.0.0
result.actionbyUser.value string The value for the specified parameter. 9.0.0
result.activeStatus result.activeStatus{} Indicates whether or not the condition is active. 9.0.0
result.activeStatus.text string The localized display text. 9.0.0
result.activeStatus.value string The value for the specified parameter. 9.0.0
result.additionalInformation string An unlimited text field to use if other fields are filled. 9.0.0
result.appliedbyDepartment result.appliedbyDepartment{} The department responsible for applying the condition. 9.0.0
result.appliedbyDepartment.text string The localized display text. 9.0.0
result.appliedbyDepartment.value string The value for the specified parameter. 9.0.0
result.appliedbyUser result.appliedbyUser{} The staff member responsible for applying the condition. 9.0.0
result.appliedbyUser.text string The localized display text. 9.0.0
result.appliedbyUser.value string The value for the specified parameter. 9.0.0
result.appliedDate dateTime The date when condition is applied. The Applied Date defaults to the current date in any of the following scenarios: 1) you are adding a standard condition, 2) you are creating a new condition, or 3) The condition is auto-assigned to a record. 9.0.0
result.displayNoticeInAgency Boolean Indicates whether or not to display the condition notice in Civic Platform when a condition is applied. 9.0.0
result.displayNoticeInCitizens Boolean Indicates whether or not to display the condition notice in Citizen Access when a condition to a record or parcel is applied. 9.0.0
result.displayNoticeInCitizensFee Boolean Indicates whether or not to display the condition notice in Citizen Access Fee Estimate page when a condition to a record or parcel is applied. 9.0.0
result.effectiveDate dateTime The date when the condition becomes effective. 9.0.0
result.expirationDate dateTime The date when the condition expires. 9.0.0
result.group result.group{} The condition group, which is a set of condition types. 9.0.0
result.group.text string The localized display text. 9.0.0
result.group.value string The value for the specified parameter. 9.0.0
result.id long The unique identifier of the condition, assigned by the Civic Platform server. 9.0.0
result.inheritable result.inheritable{} Indicates whether or not Civic Platform checks for inheritable conditions when a user associates a child record with a parent record. 9.0.0
result.inheritable.text string The localized display text. 9.0.0
result.inheritable.value string The value for the specified parameter. 9.0.0
result.isIncludeNameInNotice Boolean Indicates whether or not to display the condition name in the notice. 9.0.0
result.isIncludeShortCommentsInNotice Boolean Indicates whether or not to display the condition comments in the notice. 9.0.0
result.longComments string Narrative comments to help identify the purpose or uses of the standard condition. 9.0.0
result.name string The full name for the application contact. 9.0.0
result.priority result.priority{} The priority level assigned to the condition. 9.0.0
result.priority.text string The localized display text. 9.0.0
result.priority.value string The value for the specified parameter. 9.0.0
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). 9.0.0
result.resolutionAction string The action performed in response to a condition. 9.0.0
result.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 9.0.0
result.severity result.severity{} Indicates the severity of the condition. 9.0.0
result.severity.text string The localized display text. 9.0.0
result.severity.value string The value for the specified parameter. 9.0.0
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 9.0.0
result.status result.status{} The record condition status. 9.0.0
result.status.text string The localized display text. 9.0.0
result.status.value string The value for the specified parameter. 9.0.0
result.statusDate dateTime The date when the current status changed. 9.0.0
result.statusType string The status type for a standard condition or an approval condition, applied or not applied for example. 9.0.0
result.type result.type{} The condition type. 9.0.0
result.type.text string The localized display text. 9.0.0
result.type.value string The value for the specified parameter. 9.0.0
status integer The request status. 9.0.0