Get All Approval Conditions

Gets the conditions of approval available in the system.

Resource Information

Scope conditions

Deprecated scope name:   get_condition_approvals_standard
App Type Agency
Authorization Type Access token
URI /v4/conditionApprovals/standard?lang={lang}&type={type}&group={group}&name={name}&severity={severity}&publicDisplayMessage={publicDisplayMessage}&inheritable={inheritable}&priority={priority}&shortComments={shortComments}&longComments={longComments}&resolutionAction={resolutionAction}&includeNameInNotice={includeNameInNotice}&includeShortCommentsInNotice={includeShortCommentsInNotice}&displayNoticeInAgency={displayNoticeInAgency}&displayNoticeInCitizens={displayNoticeInCitizens}&displayNoticeInCitizensFee={displayNoticeInCitizensFee}&offset={offset}&limit={limit}&sort={sort}&direction={direction}&fields={fields}
HTTP Method GET
Automation Version(s) 7.3.2

Request Information

Field or Parameter Type Required Values Description Automation Version
direction string No ASC | DESC Specifies whether to sort in ascending or descending order. Default is ASC. 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
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
group string No   The group query parameter. 7.3.2
includeNameInNotice boolean No true | false Indicates whether or not to display the condition name in the notice. 7.3.2
includeShortCommentsInNotice boolean No true | false Indicates whether or not to display the condition comments in the notice. 7.3.2
inheritable string No Y | N 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
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
longComments string No   Narrative comments to help identify the purpose or uses of the standard condition. 7.3.2
name string No   The name of the object to be queried. 7.3.2
offset long No   Indicates the offset start of each page by the number specified. 7.3.2
priority long No Get All Standard Conditon Priorities The priority level assigned to the condition. 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
resolutionAction string No   The action performed in response to a condition. 7.3.2
severity string No   Indicates the severity of the condition. 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
sort string No   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. 7.3.2
type string No   The type of entity to be queried. 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.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.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.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 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