Adds condition information to the specified contact.
| Scope | contacts Deprecated scope name: add_contact_conditions |
| App Type | Agency |
| Authorization Type | Access token |
| URI | /v4/contacts/{contactId}/conditions?lang={lang} |
| HTTP Method | POST |
| Automation Version(s) | 7.3.3.4 |
| Field or Parameter | Type | Required | Values | Description | Automation Version |
|---|---|---|---|---|---|
| actionbyDepartment | actionbyDepartment{} | No | � | � | 7.3.3.4 |
| actionbyDepartment.text | string | No | � | The localized display text. | 7.3.3.4 |
| actionbyDepartment.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| actionbyUser | actionbyUser{} | No | � | The individual responsible for the action. | 7.3.3.4 |
| actionbyUser.text | string | No | � | The localized display text. | 7.3.3.4 |
| actionbyUser.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| activeStatus | activeStatus{} | No | A | I | Indicates whether or not the condition is active. | 7.3.3.4 |
| activeStatus.text | string | No | � | The localized display text. | 7.3.3.4 |
| activeStatus.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| additionalInformation | string | No | � | An unlimited text field to use if other fields are filled. | 7.3.3.4 |
| additionalInformationPlainText | string | No | � | An unlimited text field to use if other fields are filled. | 7.3.3.4 |
| appliedbyDepartment | appliedbyDepartment{} | No | � | � | 7.3.3.4 |
| appliedbyDepartment.text | string | No | � | The localized display text. | 7.3.3.4 |
| appliedbyDepartment.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| appliedbyUser | appliedbyUser{} | No | � | The staff member responsible for applying a condition. | 7.3.3.4 |
| appliedbyUser.text | string | No | � | The localized display text. | 7.3.3.4 |
| appliedbyUser.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| appliedDate | dateTime | No | � | The date to apply a condition. | 7.3.3.4 |
| contactID | string | No | Get All Contacts | The contact ID associated with the condition. | 7.3.3.4 |
| dispAdditionalInformationPlainText | string | No | � | An unlimited text field to use if other fields are filled. | 7.3.3.4 |
| 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.3.4 |
| 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.3.4 |
| 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.3.4 |
| effectiveDate | dateTime | No | � | The date when you want the condition to become effective. | 7.3.3.4 |
| expirationDate | dateTime | No | � | The date when the condition expires. | 7.3.3.4 |
| 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.3.4 |
| group.text | string | No | � | The localized display text. | 7.3.3.4 |
| group.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| id | long | No | � | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.3.4 |
| 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.3.4 |
| inheritable.text | string | No | � | The localized display text. | 7.3.3.4 |
| inheritable.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| isIncludeNameInNotice | Boolean | No | true | false | Indicates whether or not to display the condition name in the notice. | 7.3.3.4 |
| isIncludeShortCommentsInNotice | Boolean | No | true | false | Indicates whether or not to display the condition comments in the notice. | 7.3.3.4 |
| longComments | string | No | � | Narrative comments to help identify the purpose or uses of the standard condition. | 7.3.3.4 |
| name | string | No | � | The full name for the application contact. | 7.3.3.4 |
| priority | priority{} | No | Get All Standard Conditon Priorities | The priority level assigned to the condition. | 7.3.3.4 |
| priority.text | string | No | � | The localized display text. | 7.3.3.4 |
| priority.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| 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.3.4 |
| resAdditionalInformationPlainText | string | No | � | An unlimited text field to use if other fields are filled. | 7.3.3.4 |
| resolutionAction | string | No | � | The action performed in response to a condition. | 7.3.3.4 |
| serviceProviderCode | string | No | � | The unique agency identifier, the system assigns, on the Accela Civic Platform. | 7.3.3.4 |
| severity | severity{} | No | � | Indicates the severity of the condition. | 7.3.3.4 |
| severity.text | string | No | � | The localized display text. | 7.3.3.4 |
| severity.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| 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.3.4 |
| status | status{} | No | Get All Standard Condition Statuses Get All Approval Condition Statuses | The record condition status. | 7.3.3.4 |
| status.text | string | No | � | The localized display text. | 7.3.3.4 |
| status.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| statusDate | dateTime | No | � | The date when the current status changed. | 7.3.3.4 |
| statusType | string | No | � | The status type for a standard condition or an approval condition, applied or not applied for example. | 7.3.3.4 |
| type | type{} | No | Get All Standard Condition Types | The condition type. | 7.3.3.4 |
| type.text | string | No | � | The localized display text. | 7.3.3.4 |
| type.value | string | No | � | The value for the specified parameter. | 7.3.3.4 |
| contactId | long | Yes | Get All Contacts | The unique ID associated with the contact. | 7.3.3.4 |
| lang | String | No | � | Indicates the language applied. | 7.3.3.4 |
| Field | Type | Description | Automation Version |
|---|---|---|---|
| result | result{} | � | 7.3.3.4 |
| result.actionbyDepartment | result.actionbyDepartment{} | � | 7.3.3.4 |
| result.actionbyDepartment.text | string | The localized display text. | 7.3.3.4 |
| result.actionbyDepartment.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.actionbyUser | result.actionbyUser{} | The individual responsible for the action. | 7.3.3.4 |
| result.actionbyUser.text | string | The localized display text. | 7.3.3.4 |
| result.actionbyUser.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.activeStatus | result.activeStatus{} | Indicates whether or not the condition is active. | 7.3.3.4 |
| result.activeStatus.text | string | The localized display text. | 7.3.3.4 |
| result.activeStatus.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.additionalInformation | string | An unlimited text field to use if other fields are filled. | 7.3.3.4 |
| result.appliedbyDepartment | result.appliedbyDepartment{} | � | 7.3.3.4 |
| result.appliedbyDepartment.text | string | The localized display text. | 7.3.3.4 |
| result.appliedbyDepartment.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.appliedbyUser | result.appliedbyUser{} | The staff member responsible for applying a condition. | 7.3.3.4 |
| result.appliedbyUser.text | string | The localized display text. | 7.3.3.4 |
| result.appliedbyUser.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.appliedDate | dateTime | The date to apply a condition. | 7.3.3.4 |
| result.contactID | string | The contact ID associated with the condition. | 7.3.3.4 |
| 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.3.4 |
| 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.3.4 |
| 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.3.4 |
| result.effectiveDate | dateTime | The date when you want the condition to become effective. | 7.3.3.4 |
| result.expirationDate | dateTime | The date when the condition expires. | 7.3.3.4 |
| 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.3.4 |
| result.group.text | string | The localized display text. | 7.3.3.4 |
| result.group.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.id | long | The unique identifier for the object, assigned by the Civic Platform server and provided in a response. | 7.3.3.4 |
| 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.3.4 |
| result.inheritable.text | string | The localized display text. | 7.3.3.4 |
| result.inheritable.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.isIncludeNameInNotice | Boolean | Indicates whether or not to display the condition name in the notice. | 7.3.3.4 |
| result.isIncludeShortCommentsInNotice | Boolean | Indicates whether or not to display the condition comments in the notice. | 7.3.3.4 |
| result.longComments | string | Narrative comments to help identify the purpose or uses of the standard condition. | 7.3.3.4 |
| result.name | string | The full name for the application contact. | 7.3.3.4 |
| result.priority | result.priority{} | The priority level assigned to the condition. | 7.3.3.4 |
| result.priority.text | string | The localized display text. | 7.3.3.4 |
| result.priority.value | string | The value for the specified parameter. | 7.3.3.4 |
| 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.3.4 |
| result.resolutionAction | string | An unlimited text field to use if other fields are filled. | 7.3.3.4 |
| result.serviceProviderCode | string | The unique agency identifier, the system assigns, on the Accela Civic Platform. | 7.3.3.4 |
| result.severity | result.severity{} | Indicates the severity of the condition. | 7.3.3.4 |
| result.severity.text | string | The localized display text. | 7.3.3.4 |
| result.severity.value | string | The value for the specified parameter. | 7.3.3.4 |
| 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.3.4 |
| result.status | result.status{} | The record condition status. | 7.3.3.4 |
| result.status.text | string | The localized display text. | 7.3.3.4 |
| result.status.value | string | The value for the specified parameter. | 7.3.3.4 |
| result.statusDate | dateTime | The date when the current status changed. | 7.3.3.4 |
| result.statusType | string | The status type for a standard condition or an approval condition, applied or not applied for example. | 7.3.3.4 |
| result.type | result.type{} | The condition type. | 7.3.3.4 |
| result.type.text | string | The localized display text. | 7.3.3.4 |
| result.type.value | string | The value for the specified parameter. | 7.3.3.4 |
| status | integer | The record status. | 7.3.3.4 |