Create Contact Conditions

Adds condition information to the specified contact.

Resource Information

Scopecontacts

Deprecated scope name:   add_contact_conditions

App TypeAgency
Authorization TypeAccess token
URI /v4/contacts/{contactId}/conditions?lang={lang}
HTTP MethodPOST
Automation Version(s)7.3.3.4

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
actionbyDepartmentactionbyDepartment{}No  7.3.3.4
actionbyDepartment.textstringNo The localized display text.7.3.3.4
actionbyDepartment.valuestringNo The value for the specified parameter.7.3.3.4
actionbyUseractionbyUser{}No The individual responsible for the action.7.3.3.4
actionbyUser.textstringNo The localized display text.7.3.3.4
actionbyUser.valuestringNo The value for the specified parameter.7.3.3.4
activeStatusactiveStatus{}NoA | IIndicates whether or not the condition is active.7.3.3.4
activeStatus.textstringNo The localized display text.7.3.3.4
activeStatus.valuestringNo The value for the specified parameter.7.3.3.4
additionalInformationstringNo An unlimited text field to use if other fields are filled.7.3.3.4
additionalInformationPlainTextstringNo An unlimited text field to use if other fields are filled.7.3.3.4
appliedbyDepartmentappliedbyDepartment{}No  7.3.3.4
appliedbyDepartment.textstringNo The localized display text.7.3.3.4
appliedbyDepartment.valuestringNo The value for the specified parameter.7.3.3.4
appliedbyUserappliedbyUser{}No The staff member responsible for applying a condition.7.3.3.4
appliedbyUser.textstringNo The localized display text.7.3.3.4
appliedbyUser.valuestringNo The value for the specified parameter.7.3.3.4
appliedDatedateTimeNo The date to apply a condition.7.3.3.4
contactIDstringNo Get All Contacts The contact ID associated with the condition.7.3.3.4
dispAdditionalInformationPlainTextstringNo An unlimited text field to use if other fields are filled.7.3.3.4
displayNoticeInAgencyBooleanNotrue | falseIndicates whether or not to display the condition notice in Accela Automation when a condition to a record or parcel is applied.7.3.3.4
displayNoticeInCitizensBooleanNotrue | falseIndicates whether or not to display the condition notice in Accela Citizen Access when a condition to a record or parcel is applied.7.3.3.4
displayNoticeInCitizensFeeBooleanNotrue | falseIndicates 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.3.4
effectiveDatedateTimeNo The date when you want the condition to become effective.7.3.3.4
expirationDatedateTimeNo The date when the condition expires.7.3.3.4
groupgroup{}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.3.4
group.textstringNo The localized display text.7.3.3.4
group.valuestringNo The value for the specified parameter.7.3.3.4
idlongNo The unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.3.4
inheritableinheritable{}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.3.4
inheritable.textstringNo The localized display text.7.3.3.4
inheritable.valuestringNo The value for the specified parameter.7.3.3.4
isIncludeNameInNoticeBooleanNotrue | falseIndicates whether or not to display the condition name in the notice.7.3.3.4
isIncludeShortCommentsInNoticeBooleanNotrue | falseIndicates whether or not to display the condition comments in the notice.7.3.3.4
longCommentsstringNo Narrative comments to help identify the purpose or uses of the standard condition.7.3.3.4
namestringNo The full name for the application contact.7.3.3.4
prioritypriority{}No Get All Standard Conditon Priorities The priority level assigned to the condition.7.3.3.4
priority.textstringNo The localized display text.7.3.3.4
priority.valuestringNo The value for the specified parameter.7.3.3.4
publicDisplayMessagestringNo 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.3.4
resAdditionalInformationPlainTextstringNo An unlimited text field to use if other fields are filled.7.3.3.4
resolutionActionstringNo The action performed in response to a condition.7.3.3.4
serviceProviderCodestringNo The unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.3.4
severityseverity{}No Indicates the severity of the condition.7.3.3.4
severity.textstringNo The localized display text.7.3.3.4
severity.valuestringNo The value for the specified parameter.7.3.3.4
shortCommentsstringNo 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 it7.3.3.4
statusstatus{}No Get All Standard Condition Statuses Get All Approval Condition Statuses The record condition status.7.3.3.4
status.textstringNo The localized display text.7.3.3.4
status.valuestringNo The value for the specified parameter.7.3.3.4
statusDatedateTimeNo The date when the current status changed.7.3.3.4
statusTypestringNo The status type for a standard condition or an approval condition, applied or not applied for example.7.3.3.4
typetype{}No Get All Standard Condition Types The condition type.7.3.3.4
type.textstringNo The localized display text.7.3.3.4
type.valuestringNo The value for the specified parameter.7.3.3.4
contactIdlongYes Get All Contacts The unique ID associated with the contact.7.3.3.4
langStringNo Indicates the language applied.7.3.3.4

Response Information

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