Get All Contact Conditions

Gets condition information for the specified contact.

Resource Information


Deprecated scope name:   get_contact_conditions

App TypeAll
Authorization TypeAccess token
URI /v4/contacts/{contactId}/conditions?type={type}&name={name}&status={status}&fields={fields}&offset={offset}&limit={limit}&lang={lang}
Automation Version(s)

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
contactIdlongYes Get All Contacts The unique ID associated with the contact.
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.
langStringNo Indicates the language applied.
limitlongNo Indicates the number of items that are returned in each page.
namestringNo The name of the object to be queried.
offsetlongNo Indicates the offset start of each page by the number specified.
statusstringNo The record status.
typestringNo The type of entity to be queried.

Response Information

FieldTypeDescriptionAutomation Version
result.actionbyDepartmentresult.actionbyDepartment{}The department responsible for the action.
result.actionbyDepartment.textstringThe localized display text.
result.actionbyDepartment.valuestringThe value for the specified parameter.
result.actionbyUserresult.actionbyUser{}The individual responsible for the action.
result.actionbyUser.textstringThe localized display text.
result.actionbyUser.valuestringThe value for the specified parameter.
result.activeStatusresult.activeStatus{}Indicates whether or not the condition is active.
result.activeStatus.textstringThe localized display text.
result.activeStatus.valuestringThe value for the specified parameter.
result.additionalInformationstringAn unlimited text field to use if other fields are filled.
result.appliedbyDepartmentresult.appliedbyDepartment{}The department responsible for applying a condition.
result.appliedbyDepartment.textstringThe localized display text.
result.appliedbyDepartment.valuestringThe value for the specified parameter.
result.appliedbyUserresult.appliedbyUser{}The staff member responsible for applying a condition.
result.appliedbyUser.textstringThe localized display text.
result.appliedbyUser.valuestringThe value for the specified parameter.
result.appliedDatedateTimeThe date to apply a condition.
result.contactIDstringThe contact ID.
result.displayNoticeInAgencyBooleanIndicates whether or not to display the condition notice in Accela Automation when a condition to a record or parcel is applied.
result.displayNoticeInCitizensBooleanIndicates whether or not to display the condition notice in Accela Citizen Access when a condition to a record or parcel is applied.
result.displayNoticeInCitizensFeeBooleanIndicates 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.
result.effectiveDatedateTimeThe date when you want the condition to become effective.
result.expirationDatedateTimeThe date when the condition expires.{}This is the condition group. The condition group is an attribute of a condition that organizes condition types. Your agency defines these groups. localized display text. value for the specified parameter.
result.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.
result.inheritableresult.inheritable{}This defines whether or not Accela Automation checks for inheritable conditions when a user associates a child record with a parent record.
result.inheritable.textstringThe localized display text.
result.inheritable.valuestringThe value for the specified parameter.
result.isIncludeNameInNoticeBooleanIndicates whether or not to display the condition name in the notice.
result.isIncludeShortCommentsInNoticeBooleanIndicates whether or not to display the condition comments in the notice.
result.longCommentsstringNarrative comments to help identify the purpose or uses of the standard condition.
result.namestringThe full name for the application contact.
result.priorityresult.priority{}The priority level assigned to the condition.
result.priority.textstringThe localized display text.
result.priority.valuestringThe value for the specified parameter.
result.publicDisplayMessagestringText 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).
result.resolutionActionstringThe action performed in response to a condition.
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.
result.severityresult.severity{}Indicates the severity of the condition.
result.severity.textstringThe localized display text.
result.severity.valuestringThe value for the specified parameter.
result.shortCommentsstringA 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 it7.3.3.4
result.statusresult.status{}The record condition status.
result.status.textstringThe localized display text.
result.status.valuestringThe value for the specified parameter.
result.statusDatedateTimeThe date when the current status changed.
result.statusTypestringThe status type for a standard condition or an approval condition, applied or not applied for example.
result.typeresult.type{}The condition type.
result.type.textstringThe localized display text.
result.type.valuestringThe value for the specified parameter.
statusintegerThe record status.