Search Records

Finds the records that match the search criteria.

Resource Information

Scope records

Deprecated: search_records

App Type All
Authorization Type No authorization required
URI /v4/search/records/?offset={offset}&limit={limit}&expand={expand}&fields={fields}&lang={lang}
HTTP Method POST
Automation Version(s) 7.3.2

Request Information

Field or Parameter Type Required Values Description Automation Version
expand string No addresses,parcels,professionals,
contacts,owners,customForms,
customTables,conditions,
conditionOfApprovals,assets
Comma-delimited list of related objects to be returned with the response. The related object(s) will be returned if data exists; if data does not exist, the requested object(s) will not be included in the response. 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
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
offset long No   Indicates the offset start of each page by the number specified. 7.3.2
actualProductionUnit double No   Estimated cost per production unit. 7.3.2
address address{} No   The address of the subject. 7.3.2
address.addressLine1 string No   The first line of the address. 7.3.2
address.addressLine2 string No   The second line of the address. 7.3.2
address.city string No   The name of the city. 7.3.2
address.country address.country{} No   The name of the country. 7.3.2
address.country.text string No   The localized display text. 7.3.2
address.country.value string No   The value for the specified parameter. 7.3.2
address.county string No   The name of the county. 7.3.2
address.description string No   The address description. 7.3.2
address.direction address.direction{} No   The street direction. 7.3.2
address.direction.text string No   The localized display text. 7.3.2
address.direction.value string No   The value for the specified parameter. 7.3.2
address.distance double No   The distance from another landmark used to locate the address. 7.3.2
address.houseAlphaEnd string No   The ending street number that makes up the address. 7.3.2
address.houseAlphaStart string No   The beginning street number that makes up the address. 7.3.2
address.houseFractionEnd address.houseFractionEnd{} No Get All Address Street Fractions Used in combination with the Street # fields. 7.3.2
address.houseFractionEnd.text string No   The localized display text. 7.3.2
address.houseFractionEnd.value string No   The value for the specified parameter. 7.3.2
address.houseFractionStart address.houseFractionStart{} No Get All Address Street Fractions Used in combination with the Street # fields. 7.3.2
address.houseFractionStart.text string No   The localized display text. 7.3.2
address.houseFractionStart.value string No   The value for the specified parameter. 7.3.2
address.inspectionDistrict string No   The inspection district where the address is located. 7.3.2
address.inspectionDistrictPrefix string No   The prefix for the inspection district where the address is located. 7.3.2
address.levelEnd string No   The ending level number (floor number) that makes up the address within a complex. 7.3.2
address.levelPrefix string No   The prefix for the level numbers (floor numbers) that make up the address. 7.3.2
address.levelStart string No   The beginning level number (floor number) that makes up the address within a complex. 7.3.2
address.neighborhood string No   The neighborhood where the address is located. 7.3.2
address.neighborhoodPrefix string No   The prefix for the neighborhood where the address is located. 7.3.2
address.postalCode string No   The postal ZIP code for the address. 7.3.2
address.secondaryStreet string No   This field (along with the Secondary Road Number field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location. 7.3.2
address.secondaryStreetNumber long No   This field (along with the Secondary Road field) displays an extra description for the location when two roads that cross or a street with two names makes up the address of the location. 7.3.2
address.state address.state{} No Get All Address States The state corresponding to the address on record. 7.3.2
address.state.text string No   The localized display text. 7.3.2
address.state.value string No   The value for the specified parameter. 7.3.2
address.streetAddress string No   The street address. 7.3.2
address.streetEnd long No   The end of a range of street numbers. 7.3.2
address.streetEndFrom long No   The start of the street End range. 7.3.2
address.streetEndTo long No   The last of the street End range. 7.3.2
address.streetName string No   The street name for the address. 7.3.2
address.streetPrefix string No   Any part of an address that appears before a street name or number. For example, if the address is 123 West Main, "West" is the street prefix. 7.3.2
address.streetStart long No   The start of a range of street numbers. 7.3.2
address.streetStartFrom long No   The first of the street start range. 7.3.2
address.streetStartTo long No   The last of the street start range. 7.3.2
address.streetSuffix address.streetSuffix{} No Get All Address Street Suffixes The type of street such as "Lane" or "Boulevard". 7.3.2
address.streetSuffix.text string No   The localized display text. 7.3.2
address.streetSuffix.value string No   The value for the specified parameter. 7.3.2
address.streetSuffixDirection address.streetSuffixDirection{} No Get All Address Street Directions The direction appended to the street suffix. For example, if the address is 500 56th Avenue NW, "NW" is the street suffix direction. 7.3.2
address.streetSuffixDirection.text string No   The localized display text. 7.3.2
address.streetSuffixDirection.value string No   The value for the specified parameter. 7.3.2
address.unitEnd string No   The end parameter of a range of unit numbers. 7.3.2
address.unitStart string No   The starting parameter of a range of unit numbers. 7.3.2
address.unitType address.unitType{} No Get All Address Unit Types The unit type designation of the address. 7.3.2
address.unitType.text string No   The localized display text. 7.3.2
address.unitType.value string No   The value for the specified parameter. 7.3.2
address.xCoordinate double No   The longitudinal coordinate for this address. 7.3.2
address.yCoordinate double No   The latitudinal coordinate for this address. 7.3.2
appearanceDate dateTime No   The date for a hearing appearance. 7.3.2
appearanceDayOfWeek string No   The day for a hearing appearance. 7.3.2
asInspector string No Y | N Indicates whether or not the currently logged in user is an inspector who is associated to the record. 7.3.2
asLP string No Y | N Indicates whether or not the currently logged in user is a licensed professional who is associated to the record. 7.3.2
asset asset{} No     9.0.0
asset asset{} No     9.0.0
asset.classType string No   A Class Type is how Civic Platform groups objects that an agency owns or maintains. The five class types are component, linear, node-link linear, point, and polygon. Asset class types provide the ability to assign or group multiple asset types together. 9.0.0
asset.classType string No   A Class Type is how Civic Platform groups objects that an agency owns or maintains. The five class types are component, linear, node-link linear, point, and polygon. Asset class types provide the ability to assign or group multiple asset types together. 9.0.0
asset.comments asset.comments{} No   General comments about the asset. 9.0.0
asset.comments asset.comments{} No   General comments about the asset. 9.0.0
asset.comments.text string No   The localized display text. 9.0.0
asset.comments.text string No   The localized display text. 9.0.0
asset.comments.value string No   The value for the specified parameter. 9.0.0
asset.comments.value string No   The value for the specified parameter. 9.0.0
asset.currentValue double No   The current value of the asset. 9.0.0
asset.currentValue double No   The current value of the asset. 9.0.0
asset.dateOfService dateTime No   The date the asset was initially placed into service. 9.0.0
asset.dateOfService dateTime No   The date the asset was initially placed into service. 9.0.0
asset.dependentFlag string No   Indicates whether or not the parent asset is dependent on this asset. 9.0.0
asset.dependentFlag string No   Indicates whether or not the parent asset is dependent on this asset. 9.0.0
asset.depreciationAmount double No   The decline in the asset value by the asset depreciation calculation. 9.0.0
asset.depreciationAmount double No   The decline in the asset value by the asset depreciation calculation. 9.0.0
asset.depreciationEndDate dateTime No   The end date for the asset depreciation calculation. This field is used in the asset depreciation calculation. 9.0.0
asset.depreciationEndDate dateTime No   The end date for the asset depreciation calculation. This field is used in the asset depreciation calculation. 9.0.0
asset.depreciationStartDate dateTime No   The start date for the asset depreciation calculation. This field is used in the asset depreciation calculation. 9.0.0
asset.depreciationStartDate dateTime No   The start date for the asset depreciation calculation. This field is used in the asset depreciation calculation. 9.0.0
asset.depreciationValue double No   The asset value after the asset depreciation calculation, which is based on the start value, depreciation start and end dates, useful life, and salvage value. 9.0.0
asset.depreciationValue double No   The asset value after the asset depreciation calculation, which is based on the start value, depreciation start and end dates, useful life, and salvage value. 9.0.0
asset.description asset.description{} No   The description of the asset. 9.0.0
asset.description asset.description{} No   The description of the asset. 9.0.0
asset.description.text string No   The localized display text. 9.0.0
asset.description.text string No   The localized display text. 9.0.0
asset.description.value string No   The value for the specified parameter. 9.0.0
asset.description.value string No   The value for the specified parameter. 9.0.0
asset.endID string No   The ending point asset ID. 9.0.0
asset.endID string No   The ending point asset ID. 9.0.0
asset.gisObjects[] asset.gisObjects{} No   Contains GIS information about the location of the asset. 9.0.0
asset.gisObjects[] asset.gisObjects{} No   Contains GIS information about the location of the asset. 9.0.0
asset.gisObjects.gisId string No   The id of the GIS object. 9.0.0
asset.gisObjects.gisId string No   The id of the GIS object. 9.0.0
asset.gisObjects.layerId string No   The Id of the GIS layer that contains the record location. 9.0.0
asset.gisObjects.layerId string No   The Id of the GIS layer that contains the record location. 9.0.0
asset.gisObjects.serviceId string No   The id of the GIS service. 9.0.0
asset.gisObjects.serviceId string No   The id of the GIS service. 9.0.0
asset.id long No   The unique, sequence id assigned by the Civic Platform server. Use the id to identify the object on the URI in subsequent object-specific API requests. 9.0.0
asset.id long No   The unique, sequence id assigned by the Civic Platform server. Use the id to identify the object on the URI in subsequent object-specific API requests. 9.0.0
asset.name asset.name{} No   The descriptive name of the asset. 9.0.0
asset.name asset.name{} No   The descriptive name of the asset. 9.0.0
asset.name.text string No   The localized display text. 9.0.0
asset.name.text string No   The localized display text. 9.0.0
asset.name.value string No   The value for the specified parameter. 9.0.0
asset.name.value string No   The value for the specified parameter. 9.0.0
asset.number string No   The unique, alpha-numeric asset ID. 9.0.0
asset.number string No   The unique, alpha-numeric asset ID. 9.0.0
asset.salvageValue double No   The residual value of the asset at the end of it’s useful life. 9.0.0
asset.salvageValue double No   The residual value of the asset at the end of it’s useful life. 9.0.0
asset.size double No   A positive numeric value for the asset size. 9.0.0
asset.size double No   A positive numeric value for the asset size. 9.0.0
asset.sizeUnit string No   The unit of measure corresponding to the asset size. 9.0.0
asset.sizeUnit string No   The unit of measure corresponding to the asset size. 9.0.0
asset.startID string No   The starting point asset ID. 9.0.0
asset.startID string No   The starting point asset ID. 9.0.0
asset.startValue double No   The beginning value or purchase price of the asset. 9.0.0
asset.startValue double No   The beginning value or purchase price of the asset. 9.0.0
asset.status string No   The status of the asset. 9.0.0
asset.status string No   The status of the asset. 9.0.0
asset.status.text string No   The localized display text. 9.0.0
asset.status.text string No   The localized display text. 9.0.0
asset.status.value string No   The value for the specified parameter. 9.0.0
asset.status.value string No   The value for the specified parameter. 9.0.0
asset.statusDate dateTime No   The date the asset status changed. 9.0.0
asset.statusDate dateTime No   The date the asset status changed. 9.0.0
asset.type string No   The type of asset. 9.0.0
asset.type string No   The type of asset. 9.0.0
asset.type.text string No   The localized display text. 9.0.0
asset.type.text string No   The localized display text. 9.0.0
asset.type.value string No   The value for the specified parameter. 9.0.0
asset.type.value string No   The value for the specified parameter. 9.0.0
assetAttribute assetAttribute{} No Get Metadata of Asset Custom Attributes Contains one or more asset custom attributes and values. 9.0.0
assetAttribute.label string No   An attribute field name. 9.0.0
assetAttribute.value string No   An attribute field value. 9.0.0
assignedDateFrom dateTime No   The start of a date range for the assigned action. 7.3.2
assignedDateTo dateTime No   The end of a date range for the assigned action. 7.3.2
assignedToDepartment string No Get All Departments The department responsible for the action. 7.3.2
assignedUser string No   The staff member responsible for the action. 7.3.2
closedByDepartment string No Get All Departments The department responsible for closure. 7.3.2
closedByUser string No   The staff member responsible for closure. 7.3.2
closedDateFrom dateTime No   The start of the closure date range. 7.3.2
closedDateTo dateTime No   The end of the closure date range. 7.3.2
completeDateFrom dateTime No   The start of the completion date range. 7.3.2
completeDateTo dateTime No   The end of the completion date range. 7.3.2
completedByDepartment string No Get All Departments The department responsible for completion. 7.3.2
completedByUser string No   The staff member responsible for completion. 7.3.2
completedDate dateTime No   The date of completion. 7.3.2
condition condition{} No   Information about a standard condition.  7.3.3.5
condition.activeStatus condition.activeStatus{} No A | I Indicates whether or not the condition is active. 7.3.3.5
condition.activeStatus.text string No   The localized display text. 7.3.3.5
condition.activeStatus.value string No   The value for the specified parameter. 7.3.3.5
condition.group condition.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.5
condition.group.text string No   The localized display text. 7.3.3.5
condition.group.value string No   The value for the specified parameter. 7.3.3.5
condition.name string No   The full name for the application contact. 7.3.3.5
condition.severity condition.severity{} No   Indicates the severity of the condition. 7.3.3.5
condition.status condition.status{} No Get All Standard Condition Statuses Get All Approval Condition Statuses The record condition status. 7.3.3.5
condition.status.text string No   The localized display text. 7.3.3.5
condition.status.value string No   The value for the specified parameter. 7.3.3.5
condition.type condition.type{} No Get All Standard Condition Types The condition type. 7.3.3.5
condition.type.text string No   The localized display text. 7.3.3.5
condition.type.value string No   The value for the specified parameter. 7.3.3.5
conditionOfApproval conditionOfApproval{} No   Information about a condition of approval.  7.3.3.5
conditionOfApproval.activeStatus conditionOfApproval.activeStatus{} No A | I Indicates whether or not the condition is active. 7.3.3.5
conditionOfApproval.activeStatus.text string No   The localized display text. 7.3.3.5
conditionOfApproval.activeStatus.value string No   The value for the specified parameter. 7.3.3.5
conditionOfApproval.group conditionOfApproval.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.5
conditionOfApproval.group.text string No   The localized display text. 7.3.3.5
conditionOfApproval.group.value string No   The value for the specified parameter. 7.3.3.5
conditionOfApproval.name string No   The full name for the application contact. 7.3.3.5
conditionOfApproval.severity conditionOfApproval.severity{} No   Indicates the severity of the condition. 7.3.3.5
conditionOfApproval.status conditionOfApproval.status{} No Get All Standard Condition Statuses Get All Approval Condition Statuses The record condition status. 7.3.3.5
conditionOfApproval.status.text string No   The localized display text. 7.3.3.5
conditionOfApproval.status.value string No   The value for the specified parameter. 7.3.3.5
conditionOfApproval.type conditionOfApproval.type{} No Get All Standard Condition Types The condition type. 7.3.3.5
conditionOfApproval.type.text string No   The localized display text. 7.3.3.5
conditionOfApproval.type.value string No   The value for the specified parameter. 7.3.3.5
constructionType constructionType{} No Get All Record Construction Types The US Census Bureau construction type code. 7.3.2
constructionType.text string No   The localized display text. 7.3.2
constructionType.value string No   The value for the specified parameter. 7.3.2
contact contact{} No   The contact information. 7.3.2
contact.address contact.address{} No   The address of the subject. 7.3.2
contact.address.addressLine1 string No   The first line of the address. 7.3.2
contact.address.addressLine2 string No   The second line of the address. 7.3.2
contact.address.addressLine3 string No   The third line of the address. 7.3.2
contact.address.city string No   The name of the city. 7.3.2
contact.address.country contact.address.country{} No Get All Address Countries The name of the country. 7.3.2
contact.address.country.text string No   The localized display text. 7.3.2
contact.address.country.value string No   The value for the specified parameter. 7.3.2
contact.address.postalCode string No   The postal ZIP code for the address. 7.3.2
contact.address.state contact.address.state{} No Get All Address States The state corresponding to the address on record. 7.3.2
contact.address.state.text string No   The localized display text. 7.3.2
contact.address.state.value string No   The value for the specified parameter. 7.3.2
contact.birthCity contact.birthCity{} No   The city of birth for an individual. 7.3.2
contact.birthCity.text string No   The localized display text. 7.3.2
contact.birthCity.value string No   The value for the specified parameter. 7.3.2
contact.birthDate dateTime No   The birth date of an individual. 7.3.2
contact.birthRegion contact.birthRegion{} No   The country of birth or region of birth for an individual. 7.3.2
contact.birthRegion.text string No   The localized display text. 7.3.2
contact.birthRegion.value string No   The value for the specified parameter. 7.3.2
contact.birthState contact.birthState{} No Get All Address States The state of birth for an individual. 7.3.2
contact.birthState.text string No   The localized display text. 7.3.2
contact.birthState.value string No   The value for the specified parameter. 7.3.2
contact.businessName string No   A secondary business name for the applicable individual. 7.3.2
contact.comment string No   Comments or notes about the current context. 7.3.2
contact.deceasedDate dateTime No   The date of death. This field is active only when the Contact Type selected is Individual. 7.3.2
contact.driverLicenseNumber string No   The driver's license number of the contact. This field is active only when the Contact Type selected is Individual. 7.3.2
contact.driverLicenseState contact.driverLicenseState{} No Get All Address States The state that issued the driver's license. 7.3.2
contact.driverLicenseState.text string No   The localized display text. 7.3.2
contact.driverLicenseState.value string No   The value for the specified parameter. 7.3.2
contact.email string No   The contact's email address. 7.3.2
contact.endDate dateTime No   The date when the contact address ceases to be active. 7.3.2
contact.fax string No   The fax number for the contact. 7.3.2
contact.faxCountryCode string No   Fax Number Country Code 7.3.2
contact.federalEmployerId string No   The Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
contact.firstName string No   The contact's first name. This field is only active when the Contact Type selected is Individual. 7.3.2
contact.fullName string No   The contact's full name. This field is only active when the Contact Type selected is Individual. 7.3.2
contact.gender contact.gender{} No   The gender (male or female) of the individual. 7.3.2
contact.gender.text string No   The localized display text. 7.3.2
contact.gender.value string No   The value for the specified parameter. 7.3.2
contact.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
contact.individualOrOrganization string No   The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization. 7.3.2
contact.isPrimary string No Y | N Indicates whether or not to designate the contact as the primary contact Only one address can be primary at any given time. 7.3.2
contact.lastName string No   The last name (surname). 7.3.2
contact.middleName string No   The middle name. 7.3.2
contact.organizationName string No   The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization. 7.3.2
contact.passportNumber string No   The contact's passport number. This field is only active when the Contact Type selected is Individual. 7.3.2
contact.phone1 string No   The primary telephone number of the contact. 7.3.2
contact.phone1CountryCode string No   Phone Number 1 Country Code 7.3.2
contact.phone2 string No   The secondary telephone number of the contact. 7.3.2
contact.phone2CountryCode string No   Phone Number 2 Country Code 7.3.2
contact.phone3 string No   The tertiary telephone number for the contact. 7.3.2
contact.phone3CountryCode string No   Phone Number 3 Country Code 7.3.2
contact.postOfficeBox string No   The post office box number. 7.3.2
contact.preferredChannel contact.preferredChannel{} No Get All Contact Preferred Channels The method by which the contact prefers to be notified, by phone for example. 7.3.2
contact.preferredChannel.text string No   The localized display text. 7.3.2
contact.preferredChannel.value string No   The value for the specified parameter. 7.3.2
contact.race contact.race{} No Get All Contact Races The contact's race/ethnicity. 7.3.2
contact.race.text string No   The localized display text. 7.3.2
contact.race.value string No   The value for the specified parameter. 7.3.2
contact.recordId contact.recordId{} No Get All Records Search Records Get My Records The unique ID associated with a record. 7.3.2
contact.recordId.customId string No   An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application. 7.3.2
contact.recordId.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
contact.recordId.serviceProviderCode string No   The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
contact.recordId.trackingId long No   The application tracking number (IVR tracking number). 7.3.2
contact.recordId.value string No   The value for the specified parameter. 7.3.2
contact.referenceContactId string No   The unique Id generated for a contact stored in the sytem. 7.3.2
contact.relation contact.relation{} No   The contact's relationship to the application or service request. 7.3.2
contact.relation.text string No   The localized display text. 7.3.2
contact.relation.value string No   The value for the specified parameter. 7.3.2
contact.salutation contact.salutation{} No Get All Contact Salutations The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual. 7.3.2
contact.salutation.text string No   The localized display text. 7.3.2
contact.salutation.value string No   The value for the specified parameter. 7.3.2
contact.socialSecurityNumber string No   The individual's social security number. This field is only active when the Contact Type selected is Individual. 7.3.2
contact.startDate dateTime No   The date the contact became active. 7.3.2
contact.stateIdNumber string No   The contact's state ID number. This field is only active when the Contact Type selected is Individual. 7.3.2
contact.status contact.status{} No   The contact status. 7.3.2
contact.status.text string No   The localized display text. 7.3.2
contact.status.value string No   The value for the specified parameter. 7.3.2
contact.suffix string No   The contact name suffix. 7.3.2
contact.title string No   The individual's business title. 7.3.2
contact.tradeName string No   The contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization. 7.3.2
contact.type contact.type{} No Get All Contact Types The contact type. 7.3.2
contact.type.text string No   The localized display text. 7.3.2
contact.type.value string No   The value for the specified parameter. 7.3.2
costPerUnit double No   The cost for one unit. 7.3.2
createdBy string No   The unique user id of the individual that created the entry. 7.3.2
createdByCloning string No Y | N Indictes whether or not the record was cloned. 7.3.2
currentWorkflowStatus string No Get All Statuses for Workflow Task The status of the current workflow. 7.3.2
currentWorkflowTask string No   The status of the current workflow. 7.3.2
customForm customForm{} No   The custom form associated with the record. 7.3.2
customForm.<customType> string No   A custom field name and value pair. For example in JSON, "My Custom Field": "My Custom Value". The custom field name and its data type are defined in Automation custom forms or custom tables. For a Text field, the maximum length is 256. For a Number field, any numeric form is allowed, including negative numbers. For a Date field, the format is MM/dd/yyyy. For a Time field, the format is hh:mm. For a TextArea field, the maximum length is 4000 characters, and allows line return characters. For a DropdownList field, the dropdown list values are in the options[] array. For a CheckBox field, the (case-sensitive) valid values are "UNCHECKED" and "CHECKED". For a Radio(Y/N) field, the(case-sensitive) valid values are "Yes" and "No". 7.3.2
customId string No   An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application. 7.3.2
customTable customTable{} No   The custom table associated with the record. 7.3.2
customTable.<customType> string No   A custom field name and value pair. For example in JSON, "My Custom Field": "My Custom Value". The custom field name and its data type are defined in Automation custom forms or custom tables. For a Text field, the maximum length is 256. For a Number field, any numeric form is allowed, including negative numbers. For a Date field, the format is MM/dd/yyyy. For a Time field, the format is hh:mm. For a TextArea field, the maximum length is 4000 characters, and allows line return characters. For a DropdownList field, the dropdown list values are in the options[] array. For a CheckBox field, the (case-sensitive) valid values are "UNCHECKED" and "CHECKED". For a Radio(Y/N) field, the(case-sensitive) valid values are "Yes" and "No". 7.3.2
description string No   The description of the record or item. 7.3.2
direction string No ASC | DESC Specifies whether to sort in ascending or descending order. Default is ASC. 7.3.2
enforceDepartment string No Get All Departments The name of the department responsible for enforcement. 7.3.2
enforceUser string No   Name of the enforcement officer. 7.3.2
enforceUserId string No   ID number of the enforcement officer. 7.3.2
estimatedCostPerUnit double No   The estimated cost per unit. 7.3.2
estimatedDueDate dateTime No   The estimated date of completion. 7.3.2
estimatedProductionUnit double No   The estimated number of production units. 7.3.2
estimatedTotalJobCost double No   The estimated cost of the job. 7.3.2
expirationDate dateTime No   The date when the condition expires. 7.3.2
expirationDateFrom dateTime No   The start of the expiration date range. 7.3.2
expirationDateTo dateTime No   The end of the expiration date range. 7.3.2
firstIssuedDate dateTime No   The first issued date for license. 7.3.2
geometry geometry{} No   Contains geometric information. 7.3.2
geometry.distance double No   The distance from another landmark used to locate the address. 7.3.2
geometry.geometries geometry.geometries{} No   Specifies geometric coordinates and types. 7.3.2
geometry.geometries.coordinate string No   A geometric coordinate associated with the record. 7.3.2
geometry.geometries.type string No   The geometries type. 7.3.2
geometry.scope string No   The scope of a record search. 7.3.2
geometry.serviceId string No   The identifier of the service that provides mapping functionality. 7.3.2
geometry.unit string No   The unit of measure used for the object. For fees, this might be square feet, for example. 7.3.2
gisObjects[] gisObjects{} No   Contains GIS Object information. 7.3.2
gisObjects.gisId string No   The id of the GIS object. 7.3.2
gisObjects.layerId string No   The Id of the GIS layer that contains the record location. 7.3.2
gisObjects.serviceId string No   The id of the GIS service. 7.3.2
housingUnits long No   The number of housing units. 7.3.2
id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
initiatedProduct string No   The Accela Automation product area where the application is submitted: "AA" : Classic Accela Automation. "ACA" : Accela Citizen Access. "AIVR" : Accela Integrated Voice Response. "AMO" : Accela Mobile Office. "AV360" : Accela Asset Management, Accela Land Man. 7.3.2
inPossessionTime double No   The application level in possession time of the time tracking feature. 7.3.2
inspectorDepartment string No Get All Departments The name of the department where the inspector works. 7.3.2
inspectorId string No Get All Inspectors The ID number of the inspector. 7.3.2
inspectorName string No Get All Inspectors The name of the inspector. 7.3.2
jobValue double No   The value of the job. 7.3.2
module string No Get All Modules Use to filter by the module. 7.3.2
modules[] string No Get All Modules The modules to which to confine a global search. 7.3.2
name string No   The full name for the application contact. 7.3.2
numberOfBuildings long No   The number of buildings. 7.3.2
openedDateFrom dateTime No   The start of date range when application is opened. 7.3.2
openedDateTo dateTime No   The end of date range when application is opened. 7.3.2
overallApplicationTime double No   The amount of elapsed time from the time tracking start date to the completion of the application. 7.3.2
owner owner{} No   Contains the fields that define an owner. 7.3.2
owner.email string No   The contact's email address. 7.3.2
owner.fax string No   The fax number for the contact. 7.3.2
owner.firstName string No   The contact's first name. This field is only active when the Contact Type selected is Individual. 7.3.2
owner.fullName string No   The contact's full name. This field is only active when the Contact Type selected is Individual. 7.3.2
owner.id long No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
owner.isPrimary string No Y | N Indicates whether or not to designate the owner as the primary owner. 7.3.2
owner.lastName string No   The last name (surname). 7.3.2
owner.mailAddress owner.mailAddress{} No   Contains the fields that define an owner's address. 7.3.2
owner.mailAddress.addressLine1 string No   The first line of the address. 7.3.2
owner.mailAddress.addressLine2 string No   The second line of the address. 7.3.2
owner.mailAddress.addressLine3 string No   The third line of the address. 7.3.2
owner.mailAddress.city string No   The name of the city. 7.3.2
owner.mailAddress.country owner.mailAddress.country{} No Get All Address Countries The name of the country. 7.3.2
owner.mailAddress.country.text string No   The localized display text. 7.3.2
owner.mailAddress.country.value string No   The value for the specified parameter. 7.3.2
owner.mailAddress.postalCode string No   The postal ZIP code for the address. 7.3.2
owner.mailAddress.state owner.mailAddress.state{} No Get All Address States The state corresponding to the address on record. 7.3.2
owner.mailAddress.state.text string No   The localized display text. 7.3.2
owner.mailAddress.state.value string No   The value for the specified parameter. 7.3.2
owner.middleName string No   The middle name. 7.3.2
owner.phone string No   The telephone number of the user. 7.3.2
owner.recordId owner.recordId{} No Get All Records Search Records Get My Records The unique ID associated with a record. 7.3.2
owner.recordId.customId string No   An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application. 7.3.2
owner.recordId.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
owner.recordId.serviceProviderCode string No   The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
owner.recordId.trackingId long No   The application tracking number (IVR tracking number). 7.3.2
owner.recordId.value string No   The value for the specified parameter. 7.3.2
owner.refOwnerId double No   The unique Id generated for an owner stored in the system. 7.3.2
owner.status owner.status{} No   The owner status. 7.3.2
owner.status.text string No   The localized display text. 7.3.2
owner.status.value string No   The value for the specified parameter. 7.3.2
owner.taxId string No   The owner's tax ID number. 7.3.2
owner.title string No   The individual's business title. 7.3.2
owner.type string No   The owner type. 7.3.2
parcel parcel{} No   The official parcel name or number, as determined by the county assessor or other responsible department. 7.3.2
parcel.block string No   The block number associated with the parcel. 7.3.2
parcel.legalDesc string No   The legal description of the parcel. 7.3.2
parcel.lot string No   This is the lot name. 7.3.2
parcel.parcelNumber string No   The localized display text. 7.3.2
parcel.subdivision parcel.subdivision{} No   The name of the subdivision. 7.3.2
parcel.subdivision.text string No   The localized display text. 7.3.2
parcel.subdivision.value string No   The value for the specified parameter. 7.3.2
priority priority{} No Get All Priorities The priority level assigned to the record. 7.3.2
priority.text string No   The localized display text. 7.3.2
priority.value string No   The value for the specified parameter. 7.3.2
professional professional{} No   Contains the fields that define a licensed professional. 7.3.2
professional.addressLine1 string No   The first line of the address. 7.3.2
professional.addressLine2 string No   The second line of the address. 7.3.2
professional.addressLine3 string No   The third line of the address. 7.3.2
professional.birthDate dateTime No   The birth date of an individual. 7.3.2
professional.businessLicense string No   The official business license number issued by an agency. A licensed professional can have the same license number assigned to multiple license types. 7.3.2
professional.businessName string No   A secondary business name for the applicable individual. 7.3.2
professional.businessName2 string No   A secondary business name for the applicable individual. 7.3.2
professional.city string No   The name of the city. 7.3.2
professional.comment string No   Comments or notes about the current context. 7.3.2
professional.country professional.country{} No Get All Address Countries The name of the country. 7.3.2
professional.country.text string No   The localized display text. 7.3.2
professional.country.value string No   The value for the specified parameter. 7.3.2
professional.email string No   The contact's email address. 7.3.2
professional.expirationDate dateTime No   The date when the condition expires. 7.3.2
professional.fax string No   The fax number for the contact. 7.3.2
professional.federalEmployerId string No   The Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
professional.firstName string No   The contact's first name. This field is only active when the Contact Type selected is Individual. 7.3.2
professional.fullName string No   The contact's full name. This field is only active when the Contact Type selected is Individual. 7.3.2
professional.gender professional.gender{} No   The gender (male or female) of the individual. 7.3.2
professional.gender.text string No   The localized display text. 7.3.2
professional.gender.value string No   The value for the specified parameter. 7.3.2
professional.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
professional.isPrimary string No Y | N Indicates whether or not to designate the professional as the primary professional. 7.3.2
professional.lastName string No   The last name (surname). 7.3.2
professional.lastRenewalDate dateTime No   The last date for a professionals renewal license. 7.3.2
professional.licenseNumber string No   This is the license number for the contact. 7.3.2
professional.licenseType professional.licenseType{} No Get All Professional License Types The type of license held by the professional. 7.3.2
professional.licenseType.text string No   The localized display text. 7.3.2
professional.licenseType.value string No   The value for the specified parameter. 7.3.2
professional.licensingBoard professional.licensingBoard{} No Get All Professional License Boards The name of the licensing board that issued the license. 7.3.2
professional.licensingBoard.text string No   The localized display text. 7.3.2
professional.licensingBoard.value string No   The value for the specified parameter. 7.3.2
professional.middleName string No   The middle name. 7.3.2
professional.originalIssueDate dateTime No   The original issuance date of license. 7.3.2
professional.phone1 string No   The primary telephone number of the contact. 7.3.2
professional.phone2 string No   The secondary telephone number of the contact. 7.3.2
professional.phone3 string No   The tertiary telephone number for the contact. 7.3.2
professional.postalCode string No   The postal ZIP code for the address. 7.3.2
professional.postOfficeBox string No   The post office box number. 7.3.2
professional.recordId professional.recordId{} No Get All Records Search Records Get My Records The unique ID associated with a record. 7.3.2
professional.recordId.customId string No   An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application. 7.3.2
professional.recordId.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
professional.recordId.serviceProviderCode string No   The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
professional.recordId.trackingId long No   The application tracking number (IVR tracking number). 7.3.2
professional.recordId.value string No   The value for the specified parameter. 7.3.2
professional.referenceLicenseId string No   The unique Id generated for a professional stored in the system. 7.3.2
professional.salutation professional.salutation{} No Get All Contact Salutations The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual. 7.3.2
professional.salutation.text string No   The localized display text. 7.3.2
professional.salutation.value string No   The value for the specified parameter. 7.3.2
professional.serviceProviderCode string No   The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
professional.state professional.state{} No Get All Address States The state corresponding to the address on record. 7.3.2
professional.state.text string No   The localized display text. 7.3.2
professional.state.value string No   The value for the specified parameter. 7.3.2
professional.suffix string No   The contact name suffix. 7.3.2
professional.title string No   The individual's business title. 7.3.2
recordClass string No   General information about the record. 7.3.2
renewalInfo renewalInfo{} No   Defines the parameters related to renewal of a record. 7.3.2
renewalInfo.expirationDate dateTime No   The date when the condition expires. 7.3.2
renewalInfo.expirationStatus renewalInfo.expirationStatus{} No Get All Record Expiration Statuses Indicates whether the expiration is enabled or disabled. 7.3.2
renewalInfo.expirationStatus.text string No   The localized display text. 7.3.2
renewalInfo.expirationStatus.value string No   The value for the specified parameter. 7.3.2
reportedChannel reportedChannel{} No   The incoming channel through which the applicant submitted the application. 7.3.2
reportedChannel.text string No   The localized display text. 7.3.2
reportedChannel.value string No   The value for the specified parameter. 7.3.2
reportedDateFrom dateTime No   The start date of a date range in a search for complaints. 7.3.2
reportedDateTo dateTime No   The end date of a date range in a search for complaints. 7.3.2
reportedType reportedType{} No   The type of complaint or incident being reported. 7.3.2
reportedType.text string No   The localized display text. 7.3.2
reportedType.value string No   The value for the specified parameter. 7.3.2
scheduledDate dateTime No   The date when the inspection gets scheduled. 7.3.2
serviceProviderCode string No   The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
severity severity{} No   Indicates the severity of the condition. 7.3.2
severity.text string No   The localized display text. 7.3.2
severity.value string No   The value for the specified parameter. 7.3.2
shortNotes string No   A brief note about the record subject. 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
status status{} No   The record status. 7.3.2
status.text string No   The localized display text. 7.3.2
status.value string No   The value for the specified parameter. 7.3.2
statusDate dateTime No   The date when the current status changed. 7.3.2
statusReason statusReason{} No   The reason for the status setting on the record. 7.3.2
statusReason.text string No   The localized display text. 7.3.2
statusReason.value string No   The value for the specified parameter. 7.3.2
statusDateFrom dateTime No   The start of a status date range. 7.3.3.7
statusDateTo dateTime No   The end of a status date range. 7.3.3.7
statusReason statusReason{} No   The reason for the status setting on the record. 7.3.2
statusReason.text string No   The localized display text. 7.3.2
statusReason.value string No   The value for the specified parameter. 7.3.2
statusTypes[] string No APPROVED | CLOSED | COMPLETE | DENIED | INCOMPLETE | OPEN | PENDING | UNASSIGNED | VOID An array of record status types as filter criteria. 7.3.3.7
totalJobCost double No   The combination of work order assignments (labor) and costs. 7.3.2
trackingId long No   The application tracking number (IVR tracking number). 7.3.2
type type{} No Get All Record Types The record type. If this type field is within the record type definition, it specifies the 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.alias string No   The record type alias. 7.3.2
type.category string No   The 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.filterName string No   The name of the record type filter which defines the record types to be displayed for the citizen user. 7.3.2
type.group string No   The 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
type.module string No Get All Modules Use to filter by the module. 7.3.2
type.subType string No   The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.text string No   The localized display text. 7.3.2
type.type string No   The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
type.value string No   The value for the specified parameter. 7.3.2
types[] types{} No   Contains record types and their type properties. 7.3.2
types.alias string No   The record type alias. 7.3.2
types.category string No   The 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
types.filterName string No   The name of the record type filter which defines the record types to be displayed for the citizen user. 7.3.2
types.group string No   The 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
types.id string No   The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
types.module string No Get All Modules Use to filter by the module. 7.3.2
types.subType string No   The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
types.text string No   The localized display text. 7.3.2
types.type string No   The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
types.value string No   The value for the specified parameter. 7.3.2
undistributedCost double No   The undistributed costs for this work order. 7.3.2
updateDate dateTime No   The last update date. 8.0.0
updateDateFrom dateTime No   The start date of a date range filter. 8.0.0
updateDateTo dateTime No   The ending date of a date range filter. 8.0.0
value string No   The value for the specified parameter. 7.3.2

Example

Sample Request Head

                    POST https://apis.accela.com/v4/search/records?expand=addresses,contacts

Sample Request Body

{
  "module": "Building",
  "openedDateFrom": "2013-01-01 00:00:00",
  "openedDateTo": "2013-06-30 00:00:00",
  "type": {
    "value": "Building/Commercial/Addition/NA"
  },
  "address": {
    "postalCode": "94108"
  }
}

Notes

The following sample request uses the ISLANDTON agency in the TEST environment on the Accela Developer Sandbox. Click the "Send to Hurl.It" link below to submit the sample request. Replace YOUR-ACCESS-TOKEN before submitting the request.

curl
   -H 'Content-type: application/json'
   -H 'Accept: application/json'
   -H 'Authorization: YOUR-ACCESS-TOKEN'
   -X POST https://apis.accela.com/v4/search/records?expand=addresses,contacts
-d {"module":"Building"}
-d {"openedDateFrom":"2013-01-01"}
-d {"openedDateTo":"2013-06-30"}
-d {"type":{"value":"Building/Commercial/Addition/NA"}}
-d {"address":{"postalCode":"94108"}}

Response Information

Field Type Description Automation Version
result[] result{}   7.3.2
result.actualProductionUnit double Actual cost per production unit. 7.3.2
result.addresses[] result.addresses{} Contains one or more address information 7.3.2
result.appearanceDate dateTime The date for a hearing appearance. 7.3.2
result.appearanceDayOfWeek string The day for a hearing appearance. 7.3.2
result.assets[] result.assets{}   9.0.0
result.assets[] result.assets{}   9.0.0
result.assets.classType string A Class Type is how Civic Platform groups objects that an agency owns or maintains. The five class types are component, linear, node-link linear, point, and polygon. Asset class types provide the ability to assign or group multiple asset types together. 9.0.0
result.assets.classType string A Class Type is how Civic Platform groups objects that an agency owns or maintains. The five class types are component, linear, node-link linear, point, and polygon. Asset class types provide the ability to assign or group multiple asset types together. 9.0.0
result.assets.comments result.assets.comments{} General comments about the asset. 9.0.0
result.assets.comments result.assets.comments{} General comments about the asset. 9.0.0
result.assets.comments.text string The localized display text. 9.0.0
result.assets.comments.text string The localized display text. 9.0.0
result.assets.comments.value string The value for the specified parameter. 9.0.0
result.assets.comments.value string The value for the specified parameter. 9.0.0
result.assets.currentValue double The current value of the asset. 9.0.0
result.assets.currentValue double The current value of the asset. 9.0.0
result.assets.dateOfService dateTime The date the asset was initially placed into service. 9.0.0
result.assets.dateOfService dateTime The date the asset was initially placed into service. 9.0.0
result.assets.dependentFlag string Indicates whether or not the parent asset is dependent on this asset. 9.0.0
result.assets.dependentFlag string Indicates whether or not the parent asset is dependent on this asset. 9.0.0
result.assets.depreciationAmount double The decline in the asset value by the asset depreciation calculation. 9.0.0
result.assets.depreciationAmount double The decline in the asset value by the asset depreciation calculation. 9.0.0
result.assets.depreciationEndDate dateTime The end date for the asset depreciation calculation. This field is used in the asset depreciation calculation. 9.0.0
result.assets.depreciationEndDate dateTime The end date for the asset depreciation calculation. This field is used in the asset depreciation calculation. 9.0.0
result.assets.depreciationStartDate dateTime The start date for the asset depreciation calculation. This field is used in the asset depreciation calculation. 9.0.0
result.assets.depreciationStartDate dateTime The start date for the asset depreciation calculation. This field is used in the asset depreciation calculation. 9.0.0
result.assets.depreciationValue double The asset value after the asset depreciation calculation, which is based on the start value, depreciation start and end dates, useful life, and salvage value. 9.0.0
result.assets.depreciationValue double The asset value after the asset depreciation calculation, which is based on the start value, depreciation start and end dates, useful life, and salvage value. 9.0.0
result.assets.description result.assets.description{} The description of the asset. 9.0.0
result.assets.description result.assets.description{} The description of the asset. 9.0.0
result.assets.description.text string The localized display text. 9.0.0
result.assets.description.text string The localized display text. 9.0.0
result.assets.description.value string The value for the specified parameter. 9.0.0
result.assets.description.value string The value for the specified parameter. 9.0.0
result.assets.endID string The ending point asset ID. 9.0.0
result.assets.endID string The ending point asset ID. 9.0.0
result.assets.gisObjects[] result.assets.gisObjects{} Contains GIS information about the location of the asset. 9.0.0
result.assets.gisObjects[] result.assets.gisObjects{} Contains GIS information about the location of the asset. 9.0.0
result.assets.gisObjects.gisId string The id of the GIS object. 9.0.0
result.assets.gisObjects.gisId string The id of the GIS object. 9.0.0
result.assets.gisObjects.layerId string The Id of the GIS layer that contains the record location. 9.0.0
result.assets.gisObjects.layerId string The Id of the GIS layer that contains the record location. 9.0.0
result.assets.gisObjects.serviceId string The id of the GIS service. 9.0.0
result.assets.gisObjects.serviceId string The id of the GIS service. 9.0.0
result.assets.id long The unique, sequence id assigned by the Civic Platform server. Use the id to identify the object on the URI in subsequent object-specific API requests. 9.0.0
result.assets.id long The unique, sequence id assigned by the Civic Platform server. Use the id to identify the object on the URI in subsequent object-specific API requests. 9.0.0
result.assets.name result.assets.name{} The descriptive name of the asset. 9.0.0
result.assets.name result.assets.name{} The descriptive name of the asset. 9.0.0
result.assets.name.text string The localized display text. 9.0.0
result.assets.name.text string The localized display text. 9.0.0
result.assets.name.value string The value for the specified parameter. 9.0.0
result.assets.name.value string The value for the specified parameter. 9.0.0
result.assets.number string The unique, alpha-numeric asset ID. 9.0.0
result.assets.number string The unique, alpha-numeric asset ID. 9.0.0
result.assets.salvageValue double The residual value of the asset at the end of it’s useful life. 9.0.0
result.assets.salvageValue double The residual value of the asset at the end of it’s useful life. 9.0.0
result.assets.size double A positive numeric value for the asset size. 9.0.0
result.assets.size double A positive numeric value for the asset size. 9.0.0
result.assets.sizeUnit string The unit of measure corresponding to the asset size. 9.0.0
result.assets.sizeUnit string The unit of measure corresponding to the asset size. 9.0.0
result.assets.startID string The starting point asset ID. 9.0.0
result.assets.startID string The starting point asset ID. 9.0.0
result.assets.startValue double The beginning value or purchase price of the asset. 9.0.0
result.assets.startValue double The beginning value or purchase price of the asset. 9.0.0
result.assets.status string The status of the asset. 9.0.0
result.assets.status string The status of the asset. 9.0.0
result.assets.status.text string The localized display text. 9.0.0
result.assets.status.text string The localized display text. 9.0.0
result.assets.status.value string The value for the specified parameter. 9.0.0
result.assets.status.value string The value for the specified parameter. 9.0.0
result.assets.statusDate dateTime The date the asset status changed. 9.0.0
result.assets.statusDate dateTime The date the asset status changed. 9.0.0
result.assets.type string The type of asset. 9.0.0
result.assets.type string The type of asset. 9.0.0
result.assets.type.text string The localized display text. 9.0.0
result.assets.type.text string The localized display text. 9.0.0
result.assets.type.value string The value for the specified parameter. 9.0.0
result.assets.type.value string The value for the specified parameter. 9.0.0
result.assignedDate dateTime The date of the assigned action. 7.3.2
result.assignedToDepartment string The department responsible for the action. 7.3.2
result.assignedUser string The staff member responsible for the action. 7.3.2
result.balance Double The amount due. 7.3.2
result.booking Boolean Indicates whether or not there was a booking in addition to a citation. 7.3.2
result.closedByDepartment string The department responsible for closure. 7.3.2
result.closedByUser string The staff member responsible for closure. 7.3.2
result.closedDate dateTime The closure date. 7.3.2
result.completedByDepartment string The department responsible for completion. 7.3.2
result.completedByUser string The staff member responsible for completion. 7.3.2
result.completedDate dateTime The date of completion. 7.3.2
result.conditionOfApprovals[] result.conditionOfApprovals{} Contains conditions of approval. 7.3.3.5
result.conditionOfApprovals.actionbyDepartment result.conditionOfApprovals.actionbyDepartment{} The department responsible for the action. 7.3.3.5
result.conditionOfApprovals.actionbyDepartment.text string The localized display text. 7.3.3.5
result.conditionOfApprovals.actionbyDepartment.value string The value for the specified parameter. 7.3.3.5
result.conditionOfApprovals.actionbyUser result.conditionOfApprovals.actionbyUser{} The individual responsible for the action. 7.3.3.5
result.conditionOfApprovals.actionbyUser.text string The localized display text. 7.3.3.5
result.conditionOfApprovals.actionbyUser.value string The value for the specified parameter. 7.3.3.5
result.conditionOfApprovals.activeStatus result.conditionOfApprovals.activeStatus{} Indicates whether or not the condition is active. 7.3.3.5
result.conditionOfApprovals.activeStatus.text string The localized display text. 7.3.3.5
result.conditionOfApprovals.activeStatus.value string The value for the specified parameter. 7.3.3.5
result.conditionOfApprovals.additionalInformation string An unlimited text field to use if other fields are filled. 7.3.3.5
result.conditionOfApprovals.additionalInformationPlainText string An unlimited text field to use if other fields are filled. 7.3.3.5
result.conditionOfApprovals.appliedbyDepartment result.conditionOfApprovals.appliedbyDepartment{} The department responsible for applying a condition. 7.3.3.5
result.conditionOfApprovals.appliedbyDepartment.text string The localized display text. 7.3.3.5
result.conditionOfApprovals.appliedbyDepartment.value string The value for the specified parameter. 7.3.3.5
result.conditionOfApprovals.appliedbyUser result.conditionOfApprovals.appliedbyUser{} The staff member responsible for applying a condition. 7.3.3.5
result.conditionOfApprovals.appliedbyUser.text string The localized display text. 7.3.3.5
result.conditionOfApprovals.appliedbyUser.value string The value for the specified parameter. 7.3.3.5
result.conditionOfApprovals.appliedDate dateTime The date to apply a condition. 7.3.3.5
result.conditionOfApprovals.dispAdditionalInformationPlainText string An unlimited text field to use if other fields are filled. 7.3.3.5
result.conditionOfApprovals.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.5
result.conditionOfApprovals.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.5
result.conditionOfApprovals.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.5
result.conditionOfApprovals.displayOrder long The order of the item in comparison to the other items. 7.3.3.5
result.conditionOfApprovals.effectiveDate dateTime The date when you want the condition to become effective. 7.3.3.5
result.conditionOfApprovals.expirationDate dateTime The date when the condition expires. 7.3.3.5
result.conditionOfApprovals.group result.conditionOfApprovals.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.5
result.conditionOfApprovals.group.text string The localized display text. 7.3.3.5
result.conditionOfApprovals.group.value string The value for the specified parameter. 7.3.3.5
result.conditionOfApprovals.id long The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.3.5
result.conditionOfApprovals.inheritable result.conditionOfApprovals.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.5
result.conditionOfApprovals.inheritable.text string The localized display text. 7.3.3.5
result.conditionOfApprovals.inheritable.value string The value for the specified parameter. 7.3.3.5
result.conditionOfApprovals.isIncludeNameInNotice Boolean Indicates whether or not to display the condition name in the notice. 7.3.3.5
result.conditionOfApprovals.isIncludeShortCommentsInNotice Boolean Indicates whether or not to display the condition comments in the notice. 7.3.3.5
result.conditionOfApprovals.longComments string Narrative comments to help identify the purpose or uses of the standard condition. 7.3.3.5
result.conditionOfApprovals.name string The full name for the application contact. 7.3.3.5
result.conditionOfApprovals.priority result.conditionOfApprovals.priority{} The priority level assigned to the condition. 7.3.3.5
result.conditionOfApprovals.priority.text string The localized display text. 7.3.3.5
result.conditionOfApprovals.priority.value string The value for the specified parameter. 7.3.3.5
result.conditionOfApprovals.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.5
result.conditionOfApprovals.recordId result.conditionOfApprovals.recordId{} The unique ID associated with a record. 7.3.3.5
result.conditionOfApprovals.recordId.customId string An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application. 7.3.3.5
result.conditionOfApprovals.recordId.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.3.5
result.conditionOfApprovals.recordId.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.3.5
result.conditionOfApprovals.recordId.trackingId long The application tracking number (IVR tracking number). 7.3.3.5
result.conditionOfApprovals.recordId.value string The value for the specified parameter. 7.3.3.5
result.conditionOfApprovals.resAdditionalInformationPlainText string An unlimited text field to use if other fields are filled. 7.3.3.5
result.conditionOfApprovals.resolutionAction string The action performed in response to a condition. 7.3.3.5
result.conditionOfApprovals.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.3.5
result.conditionOfApprovals.severity result.conditionOfApprovals.severity{} Indicates the severity of the condition. 7.3.3.5
result.conditionOfApprovals.severity.text string The localized display text. 7.3.3.5
result.conditionOfApprovals.severity.value string The value for the specified parameter. 7.3.3.5
result.conditionOfApprovals.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.5
result.conditionOfApprovals.status result.conditionOfApprovals.status{} The record condition status. 7.3.3.5
result.conditionOfApprovals.status.text string The localized display text. 7.3.3.5
result.conditionOfApprovals.status.value string The value for the specified parameter. 7.3.3.5
result.conditionOfApprovals.statusDate dateTime The date when the current status changed. 7.3.3.5
result.conditionOfApprovals.statusType string The status type for a standard condition or an approval condition, applied or not applied for example. 7.3.3.5
result.conditionOfApprovals.type result.conditionOfApprovals.type{} The condition type. 7.3.3.5
result.conditionOfApprovals.type.text string The localized display text. 7.3.3.5
result.conditionOfApprovals.type.value string The value for the specified parameter. 7.3.3.5
result.conditions[] result.conditions{} Contains standard conditions. 7.3.3.5
result.conditions.actionbyDepartment result.conditions.actionbyDepartment{} The department responsible for the action. 7.3.3.5
result.conditions.actionbyDepartment.text string The localized display text. 7.3.3.5
result.conditions.actionbyDepartment.value string The value for the specified parameter. 7.3.3.5
result.conditions.actionbyUser result.conditions.actionbyUser{} The individual responsible for the action. 7.3.3.5
result.conditions.actionbyUser.text string The localized display text. 7.3.3.5
result.conditions.actionbyUser.value string The value for the specified parameter. 7.3.3.5
result.conditions.activeStatus result.conditions.activeStatus{} Indicates whether or not the condition is active. 7.3.3.5
result.conditions.activeStatus.text string The localized display text. 7.3.3.5
result.conditions.activeStatus.value string The value for the specified parameter. 7.3.3.5
result.conditions.additionalInformation string An unlimited text field to use if other fields are filled. 7.3.3.5
result.conditions.additionalInformationPlainText string An unlimited text field to use if other fields are filled. 7.3.3.5
result.conditions.appliedbyDepartment result.conditions.appliedbyDepartment{} The department responsible for applying a condition. 7.3.3.5
result.conditions.appliedbyDepartment.text string The localized display text. 7.3.3.5
result.conditions.appliedbyDepartment.value string The value for the specified parameter. 7.3.3.5
result.conditions.appliedbyUser result.conditions.appliedbyUser{} The staff member responsible for applying a condition. 7.3.3.5
result.conditions.appliedbyUser.text string The localized display text. 7.3.3.5
result.conditions.appliedbyUser.value string The value for the specified parameter. 7.3.3.5
result.conditions.appliedDate dateTime The date to apply a condition. 7.3.3.5
result.conditions.dispAdditionalInformationPlainText string An unlimited text field to use if other fields are filled. 7.3.3.5
result.conditions.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.5
result.conditions.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.5
result.conditions.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.5
result.conditions.displayOrder long The order of the item in comparison to the other items. 7.3.3.5
result.conditions.effectiveDate dateTime The date when you want the condition to become effective. 7.3.3.5
result.conditions.expirationDate dateTime The date when the condition expires. 7.3.3.5
result.conditions.group result.conditions.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.5
result.conditions.group.text string The localized display text. 7.3.3.5
result.conditions.group.value string The value for the specified parameter. 7.3.3.5
result.conditions.id long The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.3.5
result.conditions.inheritable result.conditions.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.5
result.conditions.inheritable.text string The localized display text. 7.3.3.5
result.conditions.inheritable.value string The value for the specified parameter. 7.3.3.5
result.conditions.isIncludeNameInNotice Boolean Indicates whether or not to display the condition name in the notice. 7.3.3.5
result.conditions.isIncludeShortCommentsInNotice Boolean Indicates whether or not to display the condition comments in the notice. 7.3.3.5
result.conditions.longComments string Narrative comments to help identify the purpose or uses of the standard condition. 7.3.3.5
result.conditions.name string The full name for the application contact. 7.3.3.5
result.conditions.priority result.conditions.priority{} The priority level assigned to the condition. 7.3.3.5
result.conditions.priority.text string The localized display text. 7.3.3.5
result.conditions.priority.value string The value for the specified parameter. 7.3.3.5
result.conditions.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.5
result.conditions.recordId result.conditions.recordId{} The unique ID associated with a record. 7.3.3.5
result.conditions.recordId.customId string An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application. 7.3.3.5
result.conditions.recordId.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.3.5
result.conditions.recordId.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.3.5
result.conditions.recordId.trackingId long The application tracking number (IVR tracking number). 7.3.3.5
result.conditions.recordId.value string The value for the specified parameter. 7.3.3.5
result.conditions.resAdditionalInformationPlainText string An unlimited text field to use if other fields are filled. 7.3.3.5
result.conditions.resolutionAction string The action performed in response to a condition. 7.3.3.5
result.conditions.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.3.5
result.conditions.severity result.conditions.severity{} Indicates the severity of the condition. 7.3.3.5
result.conditions.severity.text string The localized display text. 7.3.3.5
result.conditions.severity.value string The value for the specified parameter. 7.3.3.5
result.conditions.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.5
result.conditions.status result.conditions.status{} The record condition status. 7.3.3.5
result.conditions.status.text string The localized display text. 7.3.3.5
result.conditions.status.value string The value for the specified parameter. 7.3.3.5
result.conditions.statusDate dateTime The date when the current status changed. 7.3.3.5
result.conditions.statusType string The status type for a standard condition or an approval condition, applied or not applied for example. 7.3.3.5
result.conditions.type result.conditions.type{} The condition type. 7.3.3.5
result.conditions.type.text string The localized display text. 7.3.3.5
result.conditions.type.value string The value for the specified parameter. 7.3.3.5
result.constructionType result.constructionType{} The US Census Bureau construction type code. 7.3.2
result.constructionType.text string The localized display text. 7.3.2
result.constructionType.value string The value for the specified parameter. 7.3.2
result.contacts[] result.contacts{} An array of contact information. 7.3.2
result.contacts.address result.contacts.address{} The address of the subject. 7.3.2
result.contacts.address.addressLine1 string The first line of the address. 7.3.2
result.contacts.address.addressLine2 string The second line of the address. 7.3.2
result.contacts.address.addressLine3 string The third line of the address. 7.3.2
result.contacts.address.city string The name of the city. 7.3.2
result.contacts.address.country result.contacts.address.country{} The name of the country. 7.3.2
result.contacts.address.country.text string The localized display text. 7.3.2
result.contacts.address.country.value string The value for the specified parameter. 7.3.2
result.contacts.address.postalCode string The postal ZIP code for the address. 7.3.2
result.contacts.address.state result.contacts.address.state{} The state corresponding to the address on record. 7.3.2
result.contacts.address.state.text string The localized display text. 7.3.2
result.contacts.address.state.value string The value for the specified parameter. 7.3.2
result.contacts.birthCity result.contacts.birthCity{} The city of birth for an individual. 7.3.2
result.contacts.birthCity.text string The localized display text. 7.3.2
result.contacts.birthCity.value string The value for the specified parameter. 7.3.2
result.contacts.birthDate dateTime The birth date of an individual. 7.3.2
result.contacts.birthRegion result.contacts.birthRegion{} The country of birth or region of birth for an individual. 7.3.2
result.contacts.birthRegion.text string The localized display text. 7.3.2
result.contacts.birthRegion.value string The value for the specified parameter. 7.3.2
result.contacts.birthState result.contacts.birthState{} The state of birth for an individual. 7.3.2
result.contacts.birthState.text string The localized display text. 7.3.2
result.contacts.birthState.value string The value for the specified parameter. 7.3.2
result.contacts.businessName string A secondary business name for the applicable individual. 7.3.2
result.contacts.comment string Comments or notes about the current context. 7.3.2
result.contacts.deceasedDate dateTime The date of death. This field is active only when the Contact Type selected is Individual. 7.3.2
result.contacts.driverLicenseNumber string The driver's license number of the contact. This field is active only when the Contact Type selected is Individual. 7.3.2
result.contacts.driverLicenseState result.contacts.driverLicenseState{} The state that issued the driver's license. 7.3.2
result.contacts.driverLicenseState.text string The localized display text. 7.3.2
result.contacts.driverLicenseState.value string The value for the specified parameter. 7.3.2
result.contacts.email string The contact's email address. 7.3.2
result.contacts.endDate dateTime The date when the contact address ceases to be active. 7.3.2
result.contacts.fax string The fax number for the contact. 7.3.2
result.contacts.faxCountryCode string Fax Number Country Code 7.3.2
result.contacts.federalEmployerId string The Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
result.contacts.firstName string The contact's first name. This field is only active when the Contact Type selected is Individual. 7.3.2
result.contacts.fullName string The contact's full name. This field is only active when the Contact Type selected is Individual. 7.3.2
result.contacts.gender result.contacts.gender{} The gender (male or female) of the individual. 7.3.2
result.contacts.gender.text string The localized display text. 7.3.2
result.contacts.gender.value string The value for the specified parameter. 7.3.2
result.contacts.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.contacts.individualOrOrganization string The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization. 7.3.2
result.contacts.isPrimary string Indicates whether or not to designate the contact as the primary contact Only one address can be primary at any given time. 7.3.2
result.contacts.lastName string The last name (surname). 7.3.2
result.contacts.middleName string The middle name. 7.3.2
result.contacts.organizationName string The organization to which the contact belongs. This field is only active when the Contact Type selected is Organization. 7.3.2
result.contacts.passportNumber string The contact's passport number. This field is only active when the Contact Type selected is Individual. 7.3.2
result.contacts.phone1 string The primary telephone number of the contact. 7.3.2
result.contacts.phone1CountryCode string Phone Number 1 Country Code 7.3.2
result.contacts.phone2 string The secondary telephone number of the contact. 7.3.2
result.contacts.phone2CountryCode string Phone Number 2 Country Code 7.3.2
result.contacts.phone3 string The tertiary telephone number for the contact. 7.3.2
result.contacts.phone3CountryCode string Phone Number 3 Country Code 7.3.2
result.contacts.postOfficeBox string The post office box number. 7.3.2
result.contacts.preferredChannel result.contacts.preferredChannel{} The method by which the contact prefers to be notified, by phone for example. 7.3.2
result.contacts.preferredChannel.text string The localized display text. 7.3.2
result.contacts.preferredChannel.value string The value for the specified parameter. 7.3.2
result.contacts.race result.contacts.race{} The contact's race/ethnicity. 7.3.2
result.contacts.race.text string The localized display text. 7.3.2
result.contacts.race.value string The value for the specified parameter. 7.3.2
result.contacts.recordId result.contacts.recordId{} The unique ID associated with a record. 7.3.2
result.contacts.recordId.customId string An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application. 7.3.2
result.contacts.recordId.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.contacts.recordId.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
result.contacts.recordId.trackingId long The application tracking number (IVR tracking number). 7.3.2
result.contacts.recordId.value string The value for the specified parameter. 7.3.2
result.contacts.referenceContactId string The unique Id generated for a contact stored in the sytem. 7.3.2
result.contacts.relation result.contacts.relation{} The contact's relationship to the application or service request. 7.3.2
result.contacts.relation.text string The localized display text. 7.3.2
result.contacts.relation.value string The value for the specified parameter. 7.3.2
result.contacts.salutation result.contacts.salutation{} The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual. 7.3.2
result.contacts.salutation.text string The localized display text. 7.3.2
result.contacts.salutation.value string The value for the specified parameter. 7.3.2
result.contacts.socialSecurityNumber string The individual's social security number. This field is only active when the Contact Type selected is Individual. 7.3.2
result.contacts.startDate dateTime The date the contact became active. 7.3.2
result.contacts.stateIdNumber string The contact's state ID number. This field is only active when the Contact Type selected is Individual. 7.3.2
result.contacts.status result.contacts.status{} The contact status. 7.3.2
result.contacts.status.text string The localized display text. 7.3.2
result.contacts.status.value string The value for the specified parameter. 7.3.2
result.contacts.suffix string The contact name suffix. 7.3.2
result.contacts.title string The individual's business title. 7.3.2
result.contacts.tradeName string The contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization. 7.3.2
result.contacts.type result.contacts.type{} The contact type. 7.3.2
result.contacts.type.text string The localized display text. 7.3.2
result.contacts.type.value string The value for the specified parameter. 7.3.2
result.costPerUnit double The cost for one unit. 7.3.2
result.createdBy string The unique user id of the individual that created the entry. 7.3.2
result.createdByCloning string Indictes whether or not the record was cloned. 7.3.2
result.customForms[] result.customForms{} The custom forms associated with the record. 7.3.2
result.customForms.<customType> string A custom field name and value pair. For example in JSON, "My Custom Field": "My Custom Value". The custom field name and its data type are defined in Automation custom forms or custom tables. For a Text field, the maximum length is 256. For a Number field, any numeric form is allowed, including negative numbers. For a Date field, the format is MM/dd/yyyy. For a Time field, the format is hh:mm. For a TextArea field, the maximum length is 4000 characters, and allows line return characters. For a DropdownList field, the dropdown list values are in the options[] array. For a CheckBox field, the (case-sensitive) valid values are "UNCHECKED" and "CHECKED". For a Radio(Y/N) field, the(case-sensitive) valid values are "Yes" and "No". 7.3.2
result.customId string An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application. 7.3.2
result.customTables[] result.customTables{} The custom tables associated with the record. 7.3.2
result.customTables.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.customTables.rows[] result.customTables.rows{} Contains the table rows. 7.3.2
result.customTables.rows.action string Audit trail action type like 'payment allocation' 7.3.2
result.customTables.rows.fields result.customTables.rows.fields{} Contains fields and their attributes. 7.3.2
result.customTables.rows.fields.<customType> string A custom field name and value pair. For example in JSON, "My Custom Field": "My Custom Value". The custom field name and its data type are defined in Automation custom forms or custom tables. For a Text field, the maximum length is 256. For a Number field, any numeric form is allowed, including negative numbers. For a Date field, the format is MM/dd/yyyy. For a Time field, the format is hh:mm. For a TextArea field, the maximum length is 4000 characters, and allows line return characters. For a DropdownList field, the dropdown list values are in the options[] array. For a CheckBox field, the (case-sensitive) valid values are "UNCHECKED" and "CHECKED". For a Radio(Y/N) field, the(case-sensitive) valid values are "Yes" and "No". 7.3.2
result.customTables.rows.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.defendantSignature Boolean Indicates whether or not a defendant's signature has been obtained. 7.3.2
result.description string The description of the record or item. 7.3.2
result.enforceDepartment string The name of the department responsible for enforcement. 7.3.2
result.enforceUser string Name of the enforcement officer. 7.3.2
result.enforceUserId string ID number of the enforcement officer. 7.3.2
result.estimatedCostPerUnit double The estimated cost per unit. 7.3.2
result.estimatedDueDate dateTime The estimated date of completion. 7.3.2
result.estimatedProductionUnit double The estimated number of production units. 7.3.2
result.estimatedTotalJobCost double The estimated cost of the job. 7.3.2
result.firstIssuedDate dateTime The first issued date for license. 7.3.2
result.housingUnits long The number of housing units. 7.3.2
result.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.infraction Boolean Indicates whether or not an infraction occurred. 7.3.2
result.initiatedProduct string The Accela Automation product area where the application is submitted: "AA" : Classic Accela Automation. "ACA" : Accela Citizen Access. "AIVR" : Accela Integrated Voice Response. "AMO" : Accela Mobile Office. "AV360" : Accela Asset Management, Accela Land Man. 7.3.2
result.inPossessionTime double The application level in possession time of the time tracking feature. 7.3.2
result.inspectorDepartment string The name of the department where the inspector works. 7.3.2
result.inspectorId string The ID number of the inspector. 7.3.2
result.inspectorName string The name of the inspector. 7.3.2
result.jobValue double The value of the job. 7.3.2
result.misdemeanor Boolean Indicates whether or not a misdemeanor occurred. 7.3.2
result.module string Use to filter by the module. 7.3.2
result.name string The full name for the application contact. 7.3.2
result.numberOfBuildings long The number of buildings. 7.3.2
result.offenseWitnessed Boolean Indicates whether or not there was a witness to the alleged offense. 7.3.2
result.openedDate dateTime The date when the system created the record. 7.3.2
result.overallApplicationTime double The amount of elapsed time from the time tracking start date to the completion of the application. 7.3.2
result.owners[] result.owners{} Contains the fields that define an owner. 7.3.2
result.owners.email string The contact's email address. 7.3.2
result.owners.fax string The fax number for the contact. 7.3.2
result.owners.firstName string The contact's first name. This field is only active when the Contact Type selected is Individual. 7.3.2
result.owners.fullName string The contact's full name. This field is only active when the Contact Type selected is Individual. 7.3.2
result.owners.id long The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.owners.isPrimary string Indicates whether or not to designate the owner as the primary owner. 7.3.2
result.owners.lastName string The last name (surname). 7.3.2
result.owners.mailAddress result.owners.mailAddress{} Contains the fields that define an owner's address. 7.3.2
result.owners.mailAddress.addressLine1 string The first line of the address. 7.3.2
result.owners.mailAddress.addressLine2 string The second line of the address. 7.3.2
result.owners.mailAddress.addressLine3 string The third line of the address. 7.3.2
result.owners.mailAddress.city string The name of the city. 7.3.2
result.owners.mailAddress.country result.owners.mailAddress.country{} The name of the country. 7.3.2
result.owners.mailAddress.country.text string The localized display text. 7.3.2
result.owners.mailAddress.country.value string The value for the specified parameter. 7.3.2
result.owners.mailAddress.postalCode string The postal ZIP code for the address. 7.3.2
result.owners.mailAddress.state result.owners.mailAddress.state{} The state corresponding to the address on record. 7.3.2
result.owners.mailAddress.state.text string The localized display text. 7.3.2
result.owners.mailAddress.state.value string The value for the specified parameter. 7.3.2
result.owners.middleName string The middle name. 7.3.2
result.owners.phone string The telephone number of the user. 7.3.2
result.owners.recordId result.owners.recordId{} The unique ID associated with a record. 7.3.2
result.owners.recordId.customId string An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application. 7.3.2
result.owners.recordId.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.owners.recordId.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
result.owners.recordId.trackingId long The application tracking number (IVR tracking number). 7.3.2
result.owners.recordId.value string The value for the specified parameter. 7.3.2
result.owners.refOwnerId double The unique Id generated for an owner stored in the system. 7.3.2
result.owners.status result.owners.status{} The owner status. 7.3.2
result.owners.status.text string The localized display text. 7.3.2
result.owners.status.value string The value for the specified parameter. 7.3.2
result.owners.taxId string The owner's tax ID number. 7.3.2
result.owners.title string The individual's business title. 7.3.2
result.owners.type string The owner type. 7.3.2
result.parcels[] result.parcels{} Contains fields that define a parcel. 7.3.2
result.parcels.block string The block number associated with the parcel. 7.3.2
result.parcels.book string A reference to the physical location of parcel information in the County Assessor's office. 7.3.2
result.parcels.censusTract string The unique number assigned by the Census Bureau that identifies the tract to which this parcel belongs. 7.3.2
result.parcels.councilDistrict string The council district to which the parcel belongs. 7.3.2
result.parcels.exemptionValue double The total value of any tax exemptions that apply to the land within the parcel. 7.3.2
result.parcels.gisSequenceNumber long This is the ID number that you use to identify the parcel in Geographic Information Systems (GIS). 7.3.2
result.parcels.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.parcels.improvedValue double This is the total value of any improvements to the land within the parcel. 7.3.2
result.parcels.isPrimary string Indicates whether or not to designate the parcel as the primary parcel. 7.3.2
result.parcels.landValue double This is the total value of the land within the parcel. 7.3.2
result.parcels.legalDescription string The legal description of the parcel. 7.3.2
result.parcels.lot string This is the lot name. 7.3.2
result.parcels.mapNumber string The unique map number that identifies the map for this parcel. 7.3.2
result.parcels.mapReferenceInfo string The reference to where the map for this parcel exists. 7.3.2
result.parcels.page string A reference to the physical location of the parcel information in the records of the County Assessor (or other responsible department). 7.3.2
result.parcels.parcel string The official parcel name or number, as determined by the county assessor or other responsible department. 7.3.2
result.parcels.parcelArea double The total area of the parcel. Your agency determines the standard unit of measure. 7.3.2
result.parcels.parcelNumber string The localized display text. 7.3.2
result.parcels.planArea string The total area of the parcel. Your agency determines the standard unit of measure. 7.3.2
result.parcels.range string When land is surveyed using the rectangular-survey system, range represents the measure of units east and west of the base line. 7.3.2
result.parcels.section long A piece of a township measuring 640 acres, one square mile, numbered with reference to the base line and meridian line. 7.3.2
result.parcels.status result.parcels.status{} The parcel status. 7.3.2
result.parcels.status.text string The localized display text. 7.3.2
result.parcels.status.value string The value for the specified parameter. 7.3.2
result.parcels.subdivision result.parcels.subdivision{} The name of the subdivision. 7.3.2
result.parcels.subdivision.text string The localized display text. 7.3.2
result.parcels.subdivision.value string The value for the specified parameter. 7.3.2
result.parcels.supervisorDistrict string The supervisor district to which the parcel belongs. 7.3.2
result.parcels.township string When land is surveyed using the rectangular-survey system, township represents the measure of units North or South of the base line. Townships typically measure 6 miles to a side, or 36 square miles. 7.3.2
result.parcels.tract string The name of the tract associated with this application. A tract may contain one or more related parcels. 7.3.2
result.priority result.priority{} The priority level assigned to the record. 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.professionals[] result.professionals{} Contains the fields that define a licensed professional. 7.3.2
result.professionals.addressLine1 string The first line of the address. 7.3.2
result.professionals.addressLine2 string The second line of the address. 7.3.2
result.professionals.addressLine3 string The third line of the address. 7.3.2
result.professionals.birthDate dateTime The birth date of an individual. 7.3.2
result.professionals.businessLicense string The official business license number issued by an agency. A licensed professional can have the same license number assigned to multiple license types. 7.3.2
result.professionals.businessName string A secondary business name for the applicable individual. 7.3.2
result.professionals.businessName2 string A secondary business name for the applicable individual. 7.3.2
result.professionals.city string The name of the city. 7.3.2
result.professionals.comment string Comments or notes about the current context. 7.3.2
result.professionals.country result.professionals.country{} The name of the country. 7.3.2
result.professionals.country.text string The localized display text. 7.3.2
result.professionals.country.value string The value for the specified parameter. 7.3.2
result.professionals.email string The contact's email address. 7.3.2
result.professionals.expirationDate dateTime The date when the condition expires. 7.3.2
result.professionals.fax string The fax number for the contact. 7.3.2
result.professionals.federalEmployerId string The Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
result.professionals.firstName string The contact's first name. This field is only active when the Contact Type selected is Individual. 7.3.2
result.professionals.fullName string The contact's full name. This field is only active when the Contact Type selected is Individual. 7.3.2
result.professionals.gender result.professionals.gender{} The gender (male or female) of the individual. 7.3.2
result.professionals.gender.text string The localized display text. 7.3.2
result.professionals.gender.value string The value for the specified parameter. 7.3.2
result.professionals.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.professionals.isPrimary string Indicates whether or not to designate the professional as the primary professional. 7.3.2
result.professionals.lastName string The last name (surname). 7.3.2
result.professionals.lastRenewalDate dateTime The last date for a professionals renewal license. 7.3.2
result.professionals.licenseNumber string This is the license number for the contact. 7.3.2
result.professionals.licenseType result.professionals.licenseType{} The type of license held by the professional. 7.3.2
result.professionals.licenseType.text string The localized display text. 7.3.2
result.professionals.licenseType.value string The value for the specified parameter. 7.3.2
result.professionals.licensingBoard result.professionals.licensingBoard{} The name of the licensing board that issued the license. 7.3.2
result.professionals.licensingBoard.text string The localized display text. 7.3.2
result.professionals.licensingBoard.value string The value for the specified parameter. 7.3.2
result.professionals.middleName string The middle name. 7.3.2
result.professionals.originalIssueDate dateTime The original issuance date of license. 7.3.2
result.professionals.phone1 string The primary telephone number of the contact. 7.3.2
result.professionals.phone2 string The secondary telephone number of the contact. 7.3.2
result.professionals.phone3 string The tertiary telephone number for the contact. 7.3.2
result.professionals.postalCode string The postal ZIP code for the address. 7.3.2
result.professionals.postOfficeBox string The post office box number. 7.3.2
result.professionals.recordId result.professionals.recordId{} The unique ID associated with a record. 7.3.2
result.professionals.recordId.customId string An ID based on a different numbering convention from the numbering convention used by the record ID (xxxxx-xx-xxxxx). Accela Automation auto-generates and applies an alternate ID value when you submit a new application. 7.3.2
result.professionals.recordId.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.professionals.recordId.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
result.professionals.recordId.trackingId long The application tracking number (IVR tracking number). 7.3.2
result.professionals.recordId.value string The value for the specified parameter. 7.3.2
result.professionals.referenceLicenseId string The unique Id generated for a professional stored in the system. 7.3.2
result.professionals.salutation result.professionals.salutation{} The salutation to be used when addressing the contact; for example Mr. or Ms. This field is active only when Contact Type = Individual. 7.3.2
result.professionals.salutation.text string The localized display text. 7.3.2
result.professionals.salutation.value string The value for the specified parameter. 7.3.2
result.professionals.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
result.professionals.state result.professionals.state{} The state corresponding to the address on record. 7.3.2
result.professionals.state.text string The localized display text. 7.3.2
result.professionals.state.value string The value for the specified parameter. 7.3.2
result.professionals.suffix string The contact name suffix. 7.3.2
result.professionals.title string The individual's business title. 7.3.2
result.publicOwned Boolean Indicates whether or not the public owns the item. 7.3.2
result.recordClass string General information about the record. 7.3.2
result.renewalInfo result.renewalInfo{} Defines the parameters related to renewal of a record. 7.3.2
result.renewalInfo.expirationDate dateTime The date when the condition expires. 7.3.2
result.renewalInfo.expirationStatus result.renewalInfo.expirationStatus{} Indicates whether the expiration is enabled or disabled. 7.3.2
result.renewalInfo.expirationStatus.text string The localized display text. 7.3.2
result.renewalInfo.expirationStatus.value string The value for the specified parameter. 7.3.2
result.reportedChannel result.reportedChannel{} The incoming channel through which the applicant submitted the application. 7.3.2
result.reportedChannel.text string The localized display text. 7.3.2
result.reportedChannel.value string The value for the specified parameter. 7.3.2
result.reportedDate dateTime The date when a complaint or incident is reported. 7.3.2
result.reportedType result.reportedType{} The type of complaint or incident being reported. 7.3.2
result.reportedType.text string The localized display text. 7.3.2
result.reportedType.value string The value for the specified parameter. 7.3.2
result.scheduledDate dateTime The date when the inspection gets scheduled. 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.shortNotes string A brief note about the record subject. 7.3.2
result.status result.status{} The record 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.statusReason result.statusReason{} The reason for the status setting on the record. 7.3.2
result.statusReason.text string The localized display text. 7.3.2
result.statusReason.value string The value for the specified parameter. 7.3.2
result.totalFee Double The total amount of the fees invoiced to the record. 7.3.2
result.totalJobCost double The combination of work order assignments (labor) and costs. 7.3.2
result.totalPay Double The total amount of pay. 7.3.2
result.trackingId long The application tracking number (IVR tracking number). 7.3.2
result.type result.type{} The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.alias string The record type alias. 7.3.2
result.type.category string The 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.filterName string The name of the record type filter which defines the record types to be displayed for the citizen user. 7.3.2
result.type.group string The 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.type.module string Use to filter by the module. 7.3.2
result.type.subType string The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.text string The localized display text. 7.3.2
result.type.type string The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.value string The value for the specified parameter. 7.3.2
result.undistributedCost double The undistributed costs for this work order. 7.3.2
result.updateDate dateTime The date when the record was last updated. 8.0.0
result.value string The value for the specified parameter. 7.3.2
status integer The record status. 7.3.3

Example

Sample Response Body

{
  "result": [
    {
      "addresses": [
        {
          "id": 1000295331,
          "serviceProviderCode": "ISLANDTON",
          "streetName": "1 Stock St",
          "city": "San Francisco",
          "postalCode": "94108",
          "county": "US",
          "recordId": {
            "id": "ISLANDTON-13CAP-00000-00062",
            "serviceProviderCode": "ISLANDTON",
            "trackingId": 0,
            "value": "13CAP-00000-00062"
          },
          "state": {
            "value": "CA",
            "text": "CA"
          }
        }
      ],
      "contacts": [
        {
          "isPrimary": "Y",
          "id": "60808136",
          "middleName": " ",
          "phone1": "875673",
          "firstName": "Carl ",
          "lastName": "Fu",
          "recordId": {
            "id": "ISLANDTON-13CAP-00000-00062",
            "serviceProviderCode": "ISLANDTON",
            "trackingId": 0,
            "value": "13CAP-00000-00062"
          },
          "status": {
            "value": "A",
            "text": "Active"
          },
          "type": {
            "value": "Complainant",
            "text": "Complainant"
          },
          "address": {}
        }
      ],
      "id": "ISLANDTON-13CAP-00000-00062",
      "type": {
        "module": "Building",
        "type": "Commercial",
        "value": "Building/Commercial/Addition/NA",
        "category": "NA",
        "text": "Commercial Addition",
        "group": "Building",
        "subType": "Addition",
        "id": "Building-Commercial-Addition-NA"
      },
      "description": "Boot release.",
      "status": {
        "value": "Submitted",
        "text": "Submitted"
      },
      "undistributedCost": 0,
      "balance": 0,
      "serviceProviderCode": "ISLANDTON",
      "statusDate": "2013-02-20 22:16:33",
      "totalJobCost": 0,
      "reportedDate": "2013-02-20 22:16:32",
      "totalFee": 0,
      "totalPay": 0,
      "initiatedProduct": "ACA",
      "createdBy": "PUBLICUSER0",
      "module": "Building",
      "infraction": false,
      "customId": "BLD13-00039",
      "booking": false,
      "publicOwned": false,
      "misdemeanor": false,
      "offenseWitnessed": false,
      "defendantSignature": false,
      "recordClass": "COMPLETE",
      "openedDate": "2013-02-20 00:00:00",
      "trackingId": 240803932,
      "value": "13CAP-00000-00062"
    },
    {
      "addresses": [
        {
          "xCoordinate": -122.40630353,
          "yCoordinate": 37.78591524,
          "id": 1000294567,
          "serviceProviderCode": "ISLANDTON",
          "streetName": "1 Stockton St",
          "city": "San Francisco",
          "postalCode": "94108",
          "county": "US",
          "recordId": {
            "id": "ISLANDTON-13CAP-00000-0001A",
            "serviceProviderCode": "ISLANDTON",
            "trackingId": 0,
            "value": "13CAP-00000-0001A"
          },
          "state": {
            "value": "CA",
            "text": "CA"
          }
        }
      ],
      "contacts": [
        {
          "isPrimary": "Y",
          "id": "60807577",
          "middleName": " ",
          "firstName": "Carl",
          "lastName": "Fu",
          "recordId": {
            "id": "ISLANDTON-13CAP-00000-0001A",
            "serviceProviderCode": "ISLANDTON",
            "trackingId": 0,
            "value": "13CAP-00000-0001A"
          },
          "status": {
            "value": "A",
            "text": "Active"
          },
          "type": {
            "value": "Complainant",
            "text": "Complainant"
          },
          "address": {}
        }
      ],
      "id": "ISLANDTON-13CAP-00000-0001A",
      "type": {
        "module": "Building",
        "type": "Commercial",
        "value": "Building/Commercial/Addition/NA",
        "category": "NA",
        "text": "Commercial Addition",
        "group": "Building",
        "subType": "Addition",
        "id": "Building-Commercial-Addition-NA"
      },
      "description": "Hello. Can you help check this issue? The baby is not well.",
      "status": {
        "value": "Submitted",
        "text": "Submitted"
      },
      "undistributedCost": 0,
      "balance": 0,
      "serviceProviderCode": "ISLANDTON",
      "statusDate": "2013-02-05 18:08:24",
      "totalJobCost": 0,
      "reportedDate": "2013-02-05 18:08:24",
      "totalFee": 0,
      "totalPay": 0,
      "initiatedProduct": "ACA",
      "createdBy": "PUBLICUSER0",
      "module": "Building",
      "infraction": false,
      "customId": "BLD13-00029",
      "booking": false,
      "publicOwned": false,
      "misdemeanor": false,
      "offenseWitnessed": false,
      "defendantSignature": false,
      "recordClass": "COMPLETE",
      "openedDate": "2013-02-05 00:00:00",
      "trackingId": 278507153,
      "value": "13CAP-00000-0001A"
    }
  ],
  "status": 200,
  "page": {
    "offset": 0,
    "limit": 25,
    "hasmore": false
  }
}