Get Records

Gets the specified record(s)

Resource Information

Scope records

Deprecated: get_record
App Type All
Authorization Type No authorization required
URI /v4/records/{ids}?lang={lang}&expand={expand}&fields={fields}
HTTP Method GET
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,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
ids string Yes   One or multiple identifiers separated by a comma like id1,id2,id3. 7.3.2
lang String No   Indicates the language applied. 7.3.2

Example

Sample Request Head

GET https://apis.accela.com/v4/records/12CAP-00000-00003?expand=addresses

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 -X GET
     -H 'Content-type: application/json'
     -H 'Accept: application/json'
     -H 'Authorization: YOUR-ACCESS-TOKEN'
     https://apis.accela.com/v4/records/12CAP-00000-00003?expand=addresses

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.addresses.addressLine1 string The first line of the address. 7.3.2
result.addresses.addressLine2 string The second line of the address. 7.3.2
result.addresses.addressTypeFlag result.addresses.addressTypeFlag{} The current status of the address record. 7.3.2
result.addresses.addressTypeFlag.text string The localized display text. 7.3.2
result.addresses.addressTypeFlag.value string The value for the specified parameter. 7.3.2
result.addresses.city string The name of the city. 7.3.2
result.addresses.country result.addresses.country{} The name of the country. 7.3.2
result.addresses.country.text string The localized display text. 7.3.2
result.addresses.country.value string The value for the specified parameter. 7.3.2
result.addresses.county string The name of the county. 7.3.2
result.addresses.description string The description of the record or item. 7.3.2
result.addresses.direction result.addresses.direction{} The street direction of the primary address associated with the application. 7.3.2
result.addresses.direction.text string The localized display text. 7.3.2
result.addresses.direction.value string The value for the specified parameter. 7.3.2
result.addresses.distance double The distance from another landmark used to locate the address. 7.3.2
result.addresses.houseAlphaEnd string The ending street number that makes up the address. 7.3.2
result.addresses.houseAlphaStart string The beginning street number that makes up the address. 7.3.2
result.addresses.houseFractionEnd result.addresses.houseFractionEnd{} Used in combination with the Street # fields. 7.3.2
result.addresses.houseFractionEnd.text string The localized display text. 7.3.2
result.addresses.houseFractionEnd.value string The value for the specified parameter. 7.3.2
result.addresses.houseFractionStart result.addresses.houseFractionStart{} Used In combination with the Street # fields. 7.3.2
result.addresses.houseFractionStart.text string The localized display text. 7.3.2
result.addresses.houseFractionStart.value string The value for the specified parameter. 7.3.2
result.addresses.id long The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.addresses.inspectionDistrict string The inspection district where the address is located. 7.3.2
result.addresses.inspectionDistrictPrefix string The prefix for the inspection district where the address is located. 7.3.2
result.addresses.isPrimary string Indicates whether or not to designate the address as the primary address. Only one address can be primary at any given time. 7.3.2
result.addresses.levelEnd string The ending level number (floor number) that makes up the address within a complex. 7.3.2
result.addresses.levelPrefix string The prefix for the level numbers (floor numbers) that make up the address. 7.3.2
result.addresses.levelStart string The beginning level number (floor number) that makes up the address within a complex. 7.3.2
result.addresses.neighborhood string The neighborhood where the address is located. 7.3.2
result.addresses.neighborhoodPrefix string The prefix for the neighborhood where the address is located. 7.3.2
result.addresses.postalCode string The postal ZIP code for the address. 7.3.2
result.addresses.recordId result.addresses.recordId{} The unique ID associated with a record. 7.3.2
result.addresses.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.addresses.recordId.id string The unique identifier for the object, assigned by the Civic Platform server and provided in a response. 7.3.2
result.addresses.recordId.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
result.addresses.recordId.trackingId long The application tracking number (IVR tracking number). 7.3.2
result.addresses.recordId.value string The value for the specified parameter. 7.3.2
result.addresses.refAddressId long The unique Id generated for an address stored in the system. 7.3.2
result.addresses.secondaryStreet string 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
result.addresses.secondaryStreetNumber long 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
result.addresses.serviceProviderCode string The unique agency identifier, the system assigns, on the Accela Civic Platform. 7.3.2
result.addresses.state result.addresses.state{} The state corresponding to the address on record. 7.3.2
result.addresses.state.text string The localized display text. 7.3.2
result.addresses.state.value string The value for the specified parameter. 7.3.2
result.addresses.status result.addresses.status{} The address status indicating whether the address is active or inactive. 7.3.2
result.addresses.status.text string The localized display text. 7.3.2
result.addresses.status.value string The value for the specified parameter. 7.3.2
result.addresses.streetAddress string The street address. 7.3.2
result.addresses.streetEnd long The end of a range of street numbers. 7.3.2
result.addresses.streetEndFrom long The start of the street End range. 7.3.2
result.addresses.streetEndTo long The last of the street End range. 7.3.2
result.addresses.streetName string The street name for the address. 7.3.2
result.addresses.streetPrefix string 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
result.addresses.streetStart long The start of a range of street numbers. 7.3.2
result.addresses.streetStartFrom long The first of the street start range. 7.3.2
result.addresses.streetStartTo long The last of the street start range. 7.3.2
result.addresses.streetSuffix result.addresses.streetSuffix{} The type of street such as "Lane" or "Boulevard". 7.3.2
result.addresses.streetSuffix.text string The localized display text. 7.3.2
result.addresses.streetSuffix.value string The value for the specified parameter. 7.3.2
result.addresses.streetSuffixDirection result.addresses.streetSuffixDirection{} 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
result.addresses.streetSuffixDirection.text string The localized display text. 7.3.2
result.addresses.streetSuffixDirection.value string The value for the specified parameter. 7.3.2
result.addresses.type result.addresses.type{} The address type. 7.3.2
result.addresses.type.text string The localized display text. 7.3.2
result.addresses.type.value string The value for the specified parameter. 7.3.2
result.addresses.unitEnd string The end parameter of a range of unit numbers. 7.3.2
result.addresses.unitStart string The starting parameter of a range of unit numbers. 7.3.2
result.addresses.unitType result.addresses.unitType{} The unit type designation of the address. 7.3.2
result.addresses.unitType.text string The localized display text. 7.3.2
result.addresses.unitType.value string The value for the specified parameter. 7.3.2
result.addresses.xCoordinate double The longitudinal coordinate for this address. 7.3.2
result.addresses.yCoordinate double The latitudinal coordinate for this address. 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.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.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.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.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.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.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.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.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.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.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.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.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.salvageValue double The residual value of the asset at the end of it’s useful life. 9.0.0
result.assets.serviceProviderCode string The unique agency identifier. 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.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.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.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.type string The type of asset. 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.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.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.addresses[] result.parcels.addresses{} Contains one or more address information 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.owners[] result.parcels.owners{} Contains the fields that define an owner. 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.expirationCode string A short descriptive name used to identify the expiration of a renewal process 7.3.2
result.renewalInfo.expirationDate dateTime The date when the condition expires. 7.3.2
result.renewalInfo.expirationPeriodInterval long The number of days or months that a license remains active before expiring, then specify the date unit (days or months) in expirationUnit. For example, to enable an expiration interval of 2 months, enter "2" in the first field and choose "Months" in expirationUnit. 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.renewalInfo.expirationUnit string The unit of expiration period (days or months). 7.3.2
result.renewalInfo.gracePeriodInterval Long The number of days or months between the expiration and the start of penalty. 7.3.2
result.renewalInfo.payPeriodGroup string The name of the pay period group to use for a renewal. The pay period group defines the payment periods and fees that can be assessed for a renewal. For example, you can have a “2014” payment period within the Retail License pay period group. 7.3.2
result.renewalInfo.penaltyFeeCode string The code for the fee item to use to calculate a penalty fee. 7.3.2
result.renewalInfo.penaltyFeeFunction string The function to use to generate a penalty fee. Run this function within the License batch process. “None” : no penalty fee. 7.3.2
result.renewalInfo.penaltyPeriodInterval Long The number of days or months that each penalty period lasts. After the penalty interval, a subsequent penalty period can begin depending on the number of penalty periods specified in the penaltyPeriodNumber field. 7.3.2
result.renewalInfo.penaltyPeriodNumber Long The number of penalty periods that can pass before a license becomes inactive. 7.3.2
result.renewalInfo.renewalFeeCode string The function code for calculating a renewal fee. 7.3.2
result.renewalInfo.renewalFeeFunction string The name of the function for calculating a renewal fee. 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.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.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": [
        {
          "streetStart": 2012,
          "refAddressId": 15400,
          "id": 1000183940,
          "serviceProviderCode": "ISLANDTON",
          "isPrimary": "Y",
          "streetName": "APPALOOSA",
          "city": "PETALUMA",
          "postalCode": "94952",
          "recordId": {
            "id": "ISLANDTON-12CAP-00000-00003",
            "serviceProviderCode": "ISLANDTON",
            "trackingId": 0,
            "value": "12CAP-00000-00003"
          },
          "country": {
            "value": "US",
            "text": "United States"
          },
          "status": {
            "value": "A",
            "text": "Active"
          },
          "state": {
            "value": "CA",
            "text": "CA"
          },
          "streetSuffix": {
            "value": "DR",
            "text": "DR"
          }
        }
      ],
      "id": "ISLANDTON-12CAP-00000-00003",
      "type": {
        "module": "Building",
        "type": "Commercial",
        "value": "Building/Commercial/Alteration/NA",
        "category": "NA",
        "text": "Commercial Alteration",
        "group": "Building",
        "subType": "Alteration",
        "id": "Building-Commercial-Alteration-NA"
      },
      "description": "",
      "status": {
        "value": "Submitted",
        "text": "Submitted"
      },
      "undistributedCost": 0,
      "balance": 20,
      "serviceProviderCode": "ISLANDTON",
      "statusDate": "2012-07-23 02:22:17",
      "totalJobCost": 0,
      "reportedChannel": {
        "value": "Call Center",
        "text": "Call Center"
      },
      "reportedDate": "2012-07-16 00:00:00",
      "totalFee": 20,
      "totalPay": 0,
      "initiatedProduct": "AV360",
      "createdBy": "ADMIN",
      "module": "Building",
      "infraction": false,
      "jobValue": 0,
      "customId": "BLD12-00002",
      "booking": false,
      "publicOwned": false,
      "misdemeanor": false,
      "offenseWitnessed": false,
      "defendantSignature": false,
      "recordClass": "COMPLETE",
      "openedDate": "2012-07-16 00:00:00",
      "trackingId": 226895672,
      "estimatedProductionUnit": 0,
      "actualProductionUnit": 0,
      "value": "12CAP-00000-00003"
    }
  ],
  "status": 200
}