Get My Records

Gets a list of records for the specified user, where user is the creator, contact, owner, or licenced professional for the record.

Resource Information

Scoperecords

Deprecated scope name:   get_my_records

App TypeAll
Authorization TypeNo authorization required
URI /v4/records/mine?closedByDepartment={closedByDepartment}&completedDateFrom={completedDateFrom}&statusDateFrom={statusDateFrom}&assignedDateFrom={assignedDateFrom}&lang={lang}&updateDateFrom={updateDateFrom}&module={module}&updateDateTo={updateDateTo}&openedDateTo={openedDateTo}&types={types}&type={type}&completedByUser={completedByUser}&statusDateTo={statusDateTo}&openedDateFrom={openedDateFrom}&fields={fields}&closedDateFrom={closedDateFrom}&closedByUser={closedByUser}&limit={limit}&completedByDepartment={completedByDepartment}&expand={expand}&offset={offset}&recordClass={recordClass}&customId={customId}&completedDateTo={completedDateTo}&modules={modules}&status={status}&closedDateTo={closedDateTo}&statusTypes={statusTypes}&assignedDateTo={assignedDateTo}
HTTP MethodGET
Automation Version(s)7.3.2

Request Information

Field or ParameterTypeRequiredValuesDescriptionAutomation Version
assignedDateFromstringNo The start of a date range for the assigned action.7.3.2
assignedDateTostringNo The end of a date range for the assigned action.7.3.2
closedByDepartmentstringNo Get All Departments The department responsible for closure. 7.3.2
closedByUserstringNo The staff member responsible for closure. 7.3.2
closedDateFromstringNo The start of the closure date range.7.3.2
closedDateTostringNo The end of the closure date range.7.3.2
completedByDepartmentstringNo Get All Departments The department responsible for completion.7.3.2
completedByUserstringNo The staff member responsible for completion. 7.3.2
completedDateFromstringNo The start of the completion date range.7.3.2
completedDateTostringNo The end of the completion date range.7.3.2
customIdstringNo 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
expandstringNoaddresses,parcels,professionals,contacts,
owners,customForms,customTables
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
fieldsstringNo Comma-delimited names of fields to be returned in the response. Note: Field names are case-sensitive and only first-level fields are supported. Invalid field names are ignored.7.3.2
langStringNo Indicates the language applied.7.3.2
limitlongNo Indicates the number of items that are returned in each page.7.3.2
modulestringNo Get All Modules Use to filter by the module.7.3.2
modulesstringNo Get All Modules The modules to which to confine a global search.7.3.2
offsetlongNo Indicates the offset start of each page by the number specified.7.3.2
openedDateFromstringNo The start of date range when application is opened.7.3.2
openedDateTostringNo The end of date range when application is opened.7.3.2
recordClassstringNo General information about the record. 7.3.2
statusstringNo The record status.7.3.2
statusDateFromstringNo The start of a status date range.7.3.3.7
statusDateTostringNo The end of a status date range.7.3.3.7
statusTypesstringNoAPPROVED,CLOSED,COMPLETE,DENIED,
INCOMPLETE,OPEN,PENDING,UNASSIGNED,VOID
A comma-delimited list of status types as filter criteria.7.3.3.7
typestringNo The type of entity to be queried.7.3.2
typesstringNo Get All Inspection Types Get All Record Types Comma-delimited object type values such as a list of record type or inspection type values.7.3.2
updateDateFromstringNo The start date of a date range filter.8.0.0
updateDateTostringNo The ending date of a date range filter.8.0.0

Example

Sample Request Head

GET https://apis.accela.com/v4/records/mine?module=ServiceRequest

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 GET  https://apis.accela.com/v4/records/mine?module=ServiceRequest

Response Information

FieldTypeDescriptionAutomation Version
result[]result{} 7.3.2
result.actualProductionUnitdoubleActual cost per production unit.7.3.2
result.addresses[]result.addresses{}Contains one or more address information7.3.2
result.addresses.addressLine1stringThe first line of the address. 7.3.2
result.addresses.addressLine2stringThe second line of the address.7.3.2
result.addresses.addressTypeFlagresult.addresses.addressTypeFlag{}The current status of the address record.7.3.2
result.addresses.addressTypeFlag.textstringThe localized display text.7.3.2
result.addresses.addressTypeFlag.valuestringThe value for the specified parameter.7.3.2
result.addresses.citystringThe name of the city.7.3.2
result.addresses.countryresult.addresses.country{}The name of the country.7.3.2
result.addresses.country.textstringThe localized display text.7.3.2
result.addresses.country.valuestringThe value for the specified parameter.7.3.2
result.addresses.countystringThe name of the county.7.3.2
result.addresses.descriptionstringThe description of the record or item.7.3.2
result.addresses.directionresult.addresses.direction{}The street direction of the primary address associated with the application.7.3.2
result.addresses.direction.textstringThe localized display text.7.3.2
result.addresses.direction.valuestringThe value for the specified parameter.7.3.2
result.addresses.distancedoubleThe distance from another landmark used to locate the address. 7.3.2
result.addresses.houseAlphaEndstringThe ending street number that makes up the address.7.3.2
result.addresses.houseAlphaStartstringThe beginning street number that makes up the address.7.3.2
result.addresses.houseFractionEndresult.addresses.houseFractionEnd{}Used in combination with the Street # fields.7.3.2
result.addresses.houseFractionEnd.textstringThe localized display text.7.3.2
result.addresses.houseFractionEnd.valuestringThe value for the specified parameter.7.3.2
result.addresses.houseFractionStartresult.addresses.houseFractionStart{}Used In combination with the Street # fields.7.3.2
result.addresses.houseFractionStart.textstringThe localized display text.7.3.2
result.addresses.houseFractionStart.valuestringThe value for the specified parameter.7.3.2
result.addresses.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.addresses.inspectionDistrictstringThe inspection district where the address is located.7.3.2
result.addresses.inspectionDistrictPrefixstringThe prefix for the inspection district where the address is located.7.3.2
result.addresses.isPrimarystringIndicates 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.levelEndstringThe ending level number (floor number) that makes up the address within a complex.7.3.2
result.addresses.levelPrefixstringThe prefix for the level numbers (floor numbers) that make up the address.7.3.2
result.addresses.levelStartstringThe beginning level number (floor number) that makes up the address within a complex.7.3.2
result.addresses.neighborhoodstringThe neighborhood where the address is located.7.3.2
result.addresses.neighborhoodPrefixstringThe prefix for the neighborhood where the address is located.7.3.2
result.addresses.postalCodestringThe postal ZIP code for the address.7.3.2
result.addresses.recordIdresult.addresses.recordId{}The unique ID associated with a record.7.3.2
result.addresses.recordId.customIdstringAn 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.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.addresses.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.addresses.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.addresses.recordId.valuestringThe value for the specified parameter.7.3.2
result.addresses.refAddressIdlongThe unique Id generated for an address stored in the system.7.3.2
result.addresses.secondaryStreetstringThis 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.secondaryStreetNumberlongThis 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.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.addresses.stateresult.addresses.state{}The state corresponding to the address on record.7.3.2
result.addresses.state.textstringThe localized display text.7.3.2
result.addresses.state.valuestringThe value for the specified parameter.7.3.2
result.addresses.statusresult.addresses.status{}The address status indicating whether the address is active or inactive.7.3.2
result.addresses.status.textstringThe localized display text.7.3.2
result.addresses.status.valuestringThe value for the specified parameter.7.3.2
result.addresses.streetAddressstringThe street address. 7.3.2
result.addresses.streetEndlongThe end of a range of street numbers.7.3.2
result.addresses.streetEndFromlongThe start of the street End range.7.3.2
result.addresses.streetEndTolongThe last of the street End range.7.3.2
result.addresses.streetNamestringThe street name for the address.7.3.2
result.addresses.streetPrefixstringAny 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.streetStartlongThe start of a range of street numbers.7.3.2
result.addresses.streetStartFromlongThe first of the street start range.7.3.2
result.addresses.streetStartTolongThe last of the street start range.7.3.2
result.addresses.streetSuffixresult.addresses.streetSuffix{}The type of street such as "Lane" or "Boulevard".7.3.2
result.addresses.streetSuffix.textstringThe localized display text.7.3.2
result.addresses.streetSuffix.valuestringThe value for the specified parameter.7.3.2
result.addresses.streetSuffixDirectionresult.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.textstringThe localized display text.7.3.2
result.addresses.streetSuffixDirection.valuestringThe value for the specified parameter.7.3.2
result.addresses.typeresult.addresses.type{}The address type.7.3.2
result.addresses.type.textstringThe localized display text.7.3.2
result.addresses.type.valuestringThe value for the specified parameter.7.3.2
result.addresses.unitEndstringThe end parameter of a range of unit numbers.7.3.2
result.addresses.unitStartstringThe starting parameter of a range of unit numbers.7.3.2
result.addresses.unitTyperesult.addresses.unitType{}The unit type designation of the address.7.3.2
result.addresses.unitType.textstringThe localized display text.7.3.2
result.addresses.unitType.valuestringThe value for the specified parameter.7.3.2
result.addresses.xCoordinatedoubleThe longitudinal coordinate for this address. 7.3.2
result.addresses.yCoordinatedoubleThe latitudinal coordinate for this address. 7.3.2
result.appearanceDatedateTimeThe date for a hearing appearance. 7.3.2
result.appearanceDayOfWeekstringThe day for a hearing appearance.7.3.2
result.assignedDatedateTimeThe date of the assigned action.7.3.2
result.assignedToDepartmentstringThe department responsible for the action.7.3.2
result.assignedUserstringThe staff member responsible for the action.7.3.2
result.balanceDoubleThe amount due.7.3.2
result.bookingBooleanIndicates whether or not there was a booking in addition to a citation.7.3.2
result.closedByDepartmentstringThe department responsible for closure. 7.3.2
result.closedByUserstringThe staff member responsible for closure. 7.3.2
result.closedDatedateTimeThe closure date.7.3.2
result.completedByDepartmentstringThe department responsible for completion.7.3.2
result.completedByUserstringThe staff member responsible for completion. 7.3.2
result.completedDatedateTimeThe date of completion.7.3.2
result.constructionTyperesult.constructionType{}The US Census Bureau construction type code.7.3.2
result.constructionType.textstringThe localized display text.7.3.2
result.constructionType.valuestringThe value for the specified parameter.7.3.2
result.contacts[]result.contacts{}An array of contact information.7.3.2
result.contacts.addressresult.contacts.address{}The address of the subject.7.3.2
result.contacts.address.addressLine1stringThe first line of the address. 7.3.2
result.contacts.address.addressLine2stringThe second line of the address.7.3.2
result.contacts.address.addressLine3stringThe third line of the address.7.3.2
result.contacts.address.citystringThe name of the city.7.3.2
result.contacts.address.countryresult.contacts.address.country{}The name of the country.7.3.2
result.contacts.address.country.textstringThe localized display text.7.3.2
result.contacts.address.country.valuestringThe value for the specified parameter.7.3.2
result.contacts.address.postalCodestringThe postal ZIP code for the address.7.3.2
result.contacts.address.stateresult.contacts.address.state{}The state corresponding to the address on record.7.3.2
result.contacts.address.state.textstringThe localized display text.7.3.2
result.contacts.address.state.valuestringThe value for the specified parameter.7.3.2
result.contacts.birthCityresult.contacts.birthCity{}The city of birth for an individual.7.3.2
result.contacts.birthCity.textstringThe localized display text.7.3.2
result.contacts.birthCity.valuestringThe value for the specified parameter.7.3.2
result.contacts.birthDatedateTimeThe birth date of an individual.7.3.2
result.contacts.birthRegionresult.contacts.birthRegion{}The country of birth or region of birth for an individual.7.3.2
result.contacts.birthRegion.textstringThe localized display text.7.3.2
result.contacts.birthRegion.valuestringThe value for the specified parameter.7.3.2
result.contacts.birthStateresult.contacts.birthState{}The state of birth for an individual.7.3.2
result.contacts.birthState.textstringThe localized display text.7.3.2
result.contacts.birthState.valuestringThe value for the specified parameter.7.3.2
result.contacts.businessNamestringA secondary business name for the applicable individual.7.3.2
result.contacts.commentstringComments or notes about the current context.7.3.2
result.contacts.deceasedDatedateTimeThe date of death. This field is active only when the Contact Type selected is Individual.7.3.2
result.contacts.driverLicenseNumberstringThe driver's license number of the contact. This field is active only when the Contact Type selected is Individual.7.3.2
result.contacts.driverLicenseStateresult.contacts.driverLicenseState{}The state that issued the driver's license.7.3.2
result.contacts.driverLicenseState.textstringThe localized display text.7.3.2
result.contacts.driverLicenseState.valuestringThe value for the specified parameter.7.3.2
result.contacts.emailstringThe contact's email address.7.3.2
result.contacts.endDatedateTimeThe date when the contact address ceases to be active.7.3.2
result.contacts.faxstringThe fax number for the contact.7.3.2
result.contacts.faxCountryCodestringFax Number Country Code7.3.2
result.contacts.federalEmployerIdstringThe Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
result.contacts.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
result.contacts.fullNamestringThe contact's full name. This field is only active when the Contact Type selected is Individual.7.3.2
result.contacts.genderresult.contacts.gender{}The gender (male or female) of the individual.7.3.2
result.contacts.gender.textstringThe localized display text.7.3.2
result.contacts.gender.valuestringThe value for the specified parameter.7.3.2
result.contacts.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.contacts.individualOrOrganizationstringThe organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.2
result.contacts.isPrimarystringIndicates 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.lastNamestringThe last name (surname). 7.3.2
result.contacts.middleNamestringThe middle name. 7.3.2
result.contacts.organizationNamestringThe organization to which the contact belongs. This field is only active when the Contact Type selected is Organization.7.3.2
result.contacts.passportNumberstringThe contact's passport number. This field is only active when the Contact Type selected is Individual.7.3.2
result.contacts.phone1stringThe primary telephone number of the contact. 7.3.2
result.contacts.phone1CountryCodestringPhone Number 1 Country Code7.3.2
result.contacts.phone2stringThe secondary telephone number of the contact.7.3.2
result.contacts.phone2CountryCodestringPhone Number 2 Country Code7.3.2
result.contacts.phone3stringThe tertiary telephone number for the contact.7.3.2
result.contacts.phone3CountryCodestringPhone Number 3 Country Code7.3.2
result.contacts.postOfficeBoxstringThe post office box number.7.3.2
result.contacts.preferredChannelresult.contacts.preferredChannel{}The method by which the contact prefers to be notified, by phone for example.7.3.2
result.contacts.preferredChannel.textstringThe localized display text.7.3.2
result.contacts.preferredChannel.valuestringThe value for the specified parameter.7.3.2
result.contacts.raceresult.contacts.race{}The contact's race/ethnicity.7.3.2
result.contacts.race.textstringThe localized display text.7.3.2
result.contacts.race.valuestringThe value for the specified parameter.7.3.2
result.contacts.recordIdresult.contacts.recordId{}The unique ID associated with a record.7.3.2
result.contacts.recordId.customIdstringAn 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.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.contacts.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.contacts.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.contacts.recordId.valuestringThe value for the specified parameter.7.3.2
result.contacts.referenceContactIdstringThe unique Id generated for a contact stored in the sytem.7.3.2
result.contacts.relationresult.contacts.relation{}The contact's relationship to the application or service request.7.3.2
result.contacts.relation.textstringThe localized display text.7.3.2
result.contacts.relation.valuestringThe value for the specified parameter.7.3.2
result.contacts.salutationresult.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.textstringThe localized display text.7.3.2
result.contacts.salutation.valuestringThe value for the specified parameter.7.3.2
result.contacts.socialSecurityNumberstringThe individual's social security number. This field is only active when the Contact Type selected is Individual.7.3.2
result.contacts.startDatedateTimeThe date the contact became active.7.3.2
result.contacts.stateIdNumberstringThe contact's state ID number. This field is only active when the Contact Type selected is Individual.7.3.2
result.contacts.statusresult.contacts.status{}The contact status.7.3.2
result.contacts.status.textstringThe localized display text.7.3.2
result.contacts.status.valuestringThe value for the specified parameter.7.3.2
result.contacts.suffixstringThe contact name suffix.7.3.2
result.contacts.titlestringThe individual's business title. 7.3.2
result.contacts.tradeNamestringThe contact's preferred business or trade name. This field is active only when the Contact Type selected is Organization.7.3.2
result.contacts.typeresult.contacts.type{}The contact type.7.3.2
result.contacts.type.textstringThe localized display text.7.3.2
result.contacts.type.valuestringThe value for the specified parameter.7.3.2
result.costPerUnitdoubleThe cost for one unit.7.3.2
result.createdBystringThe unique user id of the individual that created the entry.7.3.2
result.createdByCloningstringIndictes 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>stringA 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.customIdstringAn 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.idstringThe 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.actionstringAudit trail action type like 'payment allocation'7.3.2
result.customTables.rows.fieldsresult.customTables.rows.fields{}Contains fields and their attributes.7.3.2
result.customTables.rows.fields.<customType>stringA 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.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.defendantSignatureBooleanIndicates whether or not a defendant's signature has been obtained.7.3.2
result.descriptionstringThe description of the record or item.7.3.2
result.enforceDepartmentstringThe name of the department responsible for enforcement.7.3.2
result.enforceUserstringName of the enforcement officer. 7.3.2
result.enforceUserIdstringID number of the enforcement officer.7.3.2
result.estimatedCostPerUnitdoubleThe estimated cost per unit. 7.3.2
result.estimatedDueDatedateTimeThe estimated date of completion.7.3.2
result.estimatedProductionUnitdoubleThe estimated number of production units.7.3.2
result.estimatedTotalJobCostdoubleThe estimated cost of the job.7.3.2
result.firstIssuedDatedateTimeThe first issued date for license.7.3.2
result.housingUnitslongThe number of housing units.7.3.2
result.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.infractionBooleanIndicates whether or not an infraction occurred.7.3.2
result.initiatedProductstringThe 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.inPossessionTimedoubleThe application level in possession time of the time tracking feature.7.3.2
result.inspectorDepartmentstringThe name of the department where the inspector works. 7.3.2
result.inspectorIdstringThe ID number of the inspector.7.3.2
result.inspectorNamestringThe name of the inspector.7.3.2
result.jobValuedoubleThe value of the job.7.3.2
result.misdemeanorBooleanIndicates whether or not a misdemeanor occurred.7.3.2
result.modulestringUse to filter by the module.7.3.2
result.namestringThe full name for the application contact.7.3.2
result.numberOfBuildingslongThe number of buildings.7.3.2
result.offenseWitnessedBooleanIndicates whether or not there was a witness to the alleged offense.7.3.2
result.openedDatedateTimeThe date when the system created the record.7.3.2
result.overallApplicationTimedoubleThe 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.emailstringThe contact's email address.7.3.2
result.owners.faxstringThe fax number for the contact.7.3.2
result.owners.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
result.owners.fullNamestringThe contact's full name. This field is only active when the Contact Type selected is Individual.7.3.2
result.owners.idlongThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.owners.isPrimarystringIndicates whether or not to designate the owner as the primary owner.7.3.2
result.owners.lastNamestringThe last name (surname). 7.3.2
result.owners.mailAddressresult.owners.mailAddress{}Contains the fields that define an owner's address.7.3.2
result.owners.mailAddress.addressLine1stringThe first line of the address. 7.3.2
result.owners.mailAddress.addressLine2stringThe second line of the address.7.3.2
result.owners.mailAddress.addressLine3stringThe third line of the address.7.3.2
result.owners.mailAddress.citystringThe name of the city.7.3.2
result.owners.mailAddress.countryresult.owners.mailAddress.country{}The name of the country.7.3.2
result.owners.mailAddress.country.textstringThe localized display text.7.3.2
result.owners.mailAddress.country.valuestringThe value for the specified parameter.7.3.2
result.owners.mailAddress.postalCodestringThe postal ZIP code for the address.7.3.2
result.owners.mailAddress.stateresult.owners.mailAddress.state{}The state corresponding to the address on record.7.3.2
result.owners.mailAddress.state.textstringThe localized display text.7.3.2
result.owners.mailAddress.state.valuestringThe value for the specified parameter.7.3.2
result.owners.middleNamestringThe middle name. 7.3.2
result.owners.phonestringThe telephone number of the user. 7.3.2
result.owners.recordIdresult.owners.recordId{}The unique ID associated with a record.7.3.2
result.owners.recordId.customIdstringAn 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.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.owners.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.owners.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.owners.recordId.valuestringThe value for the specified parameter.7.3.2
result.owners.refOwnerIddoubleThe unique Id generated for an owner stored in the system.7.3.2
result.owners.statusresult.owners.status{}The owner status.7.3.2
result.owners.status.textstringThe localized display text.7.3.2
result.owners.status.valuestringThe value for the specified parameter.7.3.2
result.owners.taxIdstringThe owner's tax ID number.7.3.2
result.owners.titlestringThe individual's business title. 7.3.2
result.owners.typestringThe owner type.7.3.2
result.parcels[]result.parcels{}Contains fields that define a parcel.7.3.2
result.parcels.blockstringThe block number associated with the parcel.7.3.2
result.parcels.bookstringA reference to the physical location of parcel information in the County Assessor's office.7.3.2
result.parcels.censusTractstringThe unique number assigned by the Census Bureau that identifies the tract to which this parcel belongs.7.3.2
result.parcels.councilDistrictstringThe council district to which the parcel belongs.7.3.2
result.parcels.exemptionValuedoubleThe total value of any tax exemptions that apply to the land within the parcel. 7.3.2
result.parcels.gisSequenceNumberlongThis is the ID number that you use to identify the parcel in Geographic Information Systems (GIS).7.3.2
result.parcels.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.parcels.improvedValuedoubleThis is the total value of any improvements to the land within the parcel.7.3.2
result.parcels.isPrimarystringIndicates whether or not to designate the parcel as the primary parcel.7.3.2
result.parcels.landValuedoubleThis is the total value of the land within the parcel.7.3.2
result.parcels.legalDescriptionstringThe legal description of the parcel.7.3.2
result.parcels.lotstringThis is the lot name.7.3.2
result.parcels.mapNumberstringThe unique map number that identifies the map for this parcel.7.3.2
result.parcels.mapReferenceInfostringThe reference to where the map for this parcel exists.7.3.2
result.parcels.pagestringA 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.parcelstringThe official parcel name or number, as determined by the county assessor or other responsible department.7.3.2
result.parcels.parcelAreadoubleThe total area of the parcel. Your agency determines the standard unit of measure.7.3.2
result.parcels.parcelNumberstringThe localized display text.7.3.2
result.parcels.planAreastringThe total area of the parcel. Your agency determines the standard unit of measure.7.3.2
result.parcels.rangestringWhen 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.sectionlongA 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.statusresult.parcels.status{}The parcel status.7.3.2
result.parcels.status.textstringThe localized display text.7.3.2
result.parcels.status.valuestringThe value for the specified parameter.7.3.2
result.parcels.subdivisionresult.parcels.subdivision{}The name of the subdivision. 7.3.2
result.parcels.subdivision.textstringThe localized display text.7.3.2
result.parcels.subdivision.valuestringThe value for the specified parameter.7.3.2
result.parcels.supervisorDistrictstringThe supervisor district to which the parcel belongs.7.3.2
result.parcels.townshipstringWhen 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.tractstringThe name of the tract associated with this application. A tract may contain one or more related parcels.7.3.2
result.priorityresult.priority{}The priority level assigned to the record.7.3.2
result.priority.textstringThe localized display text.7.3.2
result.priority.valuestringThe 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.addressLine1stringThe first line of the address. 7.3.2
result.professionals.addressLine2stringThe second line of the address.7.3.2
result.professionals.addressLine3stringThe third line of the address.7.3.2
result.professionals.birthDatedateTimeThe birth date of an individual.7.3.2
result.professionals.businessLicensestringThe 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.businessNamestringA secondary business name for the applicable individual.7.3.2
result.professionals.businessName2stringA secondary business name for the applicable individual.7.3.2
result.professionals.citystringThe name of the city.7.3.2
result.professionals.commentstringComments or notes about the current context.7.3.2
result.professionals.countryresult.professionals.country{}The name of the country.7.3.2
result.professionals.country.textstringThe localized display text.7.3.2
result.professionals.country.valuestringThe value for the specified parameter.7.3.2
result.professionals.emailstringThe contact's email address.7.3.2
result.professionals.expirationDatedateTimeThe date when the condition expires.7.3.2
result.professionals.faxstringThe fax number for the contact.7.3.2
result.professionals.federalEmployerIdstringThe Federal Employer Identification Number. It is used to identify a business for tax purposes. 7.3.2
result.professionals.firstNamestringThe contact's first name. This field is only active when the Contact Type selected is Individual.7.3.2
result.professionals.fullNamestringThe contact's full name. This field is only active when the Contact Type selected is Individual.7.3.2
result.professionals.genderresult.professionals.gender{}The gender (male or female) of the individual.7.3.2
result.professionals.gender.textstringThe localized display text.7.3.2
result.professionals.gender.valuestringThe value for the specified parameter.7.3.2
result.professionals.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.professionals.isPrimarystringIndicates whether or not to designate the professional as the primary professional.7.3.2
result.professionals.lastNamestringThe last name (surname). 7.3.2
result.professionals.lastRenewalDatedateTimeThe last date for a professionals renewal license.7.3.2
result.professionals.licenseNumberstringThis is the license number for the contact.7.3.2
result.professionals.licenseTyperesult.professionals.licenseType{}The type of license held by the professional.7.3.2
result.professionals.licenseType.textstringThe localized display text.7.3.2
result.professionals.licenseType.valuestringThe value for the specified parameter.7.3.2
result.professionals.licensingBoardresult.professionals.licensingBoard{}The name of the licensing board that issued the license. 7.3.2
result.professionals.licensingBoard.textstringThe localized display text.7.3.2
result.professionals.licensingBoard.valuestringThe value for the specified parameter.7.3.2
result.professionals.middleNamestringThe middle name. 7.3.2
result.professionals.originalIssueDatedateTimeThe original issuance date of license.7.3.2
result.professionals.phone1stringThe primary telephone number of the contact. 7.3.2
result.professionals.phone2stringThe secondary telephone number of the contact.7.3.2
result.professionals.phone3stringThe tertiary telephone number for the contact.7.3.2
result.professionals.postalCodestringThe postal ZIP code for the address.7.3.2
result.professionals.postOfficeBoxstringThe post office box number.7.3.2
result.professionals.recordIdresult.professionals.recordId{}The unique ID associated with a record.7.3.2
result.professionals.recordId.customIdstringAn 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.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.professionals.recordId.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.professionals.recordId.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.professionals.recordId.valuestringThe value for the specified parameter.7.3.2
result.professionals.referenceLicenseIdstringThe unique Id generated for a professional stored in the system.7.3.2
result.professionals.salutationresult.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.textstringThe localized display text.7.3.2
result.professionals.salutation.valuestringThe value for the specified parameter.7.3.2
result.professionals.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.professionals.stateresult.professionals.state{}The state corresponding to the address on record.7.3.2
result.professionals.state.textstringThe localized display text.7.3.2
result.professionals.state.valuestringThe value for the specified parameter.7.3.2
result.professionals.suffixstringThe contact name suffix.7.3.2
result.professionals.titlestringThe individual's business title. 7.3.2
result.publicOwnedBooleanIndicates whether or not the public owns the item.7.3.2
result.recordClassstringGeneral information about the record. 7.3.2
result.renewalInforesult.renewalInfo{}Defines the parameters related to renewal of a record. 7.3.2
result.renewalInfo.expirationDatedateTimeThe date when the condition expires.7.3.2
result.renewalInfo.expirationStatusresult.renewalInfo.expirationStatus{}Indicates whether the expiration is enabled or disabled.7.3.2
result.renewalInfo.expirationStatus.textstringThe localized display text.7.3.2
result.renewalInfo.expirationStatus.valuestringThe value for the specified parameter.7.3.2
result.reportedChannelresult.reportedChannel{}The incoming channel through which the applicant submitted the application.7.3.2
result.reportedChannel.textstringThe localized display text.7.3.2
result.reportedChannel.valuestringThe value for the specified parameter.7.3.2
result.reportedDatedateTimeThe date when a complaint or incident is reported.7.3.2
result.reportedTyperesult.reportedType{}The type of complaint or incident being reported.7.3.2
result.reportedType.textstringThe localized display text.7.3.2
result.reportedType.valuestringThe value for the specified parameter.7.3.2
result.scheduledDatedateTimeThe date when the inspection gets scheduled.7.3.2
result.serviceProviderCodestringThe unique agency identifier, the system assigns, on the Accela Civic Platform.7.3.2
result.severityresult.severity{}Indicates the severity of the condition.7.3.2
result.severity.textstringThe localized display text.7.3.2
result.severity.valuestringThe value for the specified parameter.7.3.2
result.shortNotesstringA brief note about the record subject.7.3.2
result.statusresult.status{}The record status.7.3.2
result.status.textstringThe localized display text.7.3.2
result.status.valuestringThe value for the specified parameter.7.3.2
result.statusDatedateTimeThe date when the current status changed.7.3.2
result.statusReasonresult.statusReason{}The reason for the status setting on the record.7.3.2
result.statusReason.textstringThe localized display text.7.3.2
result.statusReason.valuestringThe value for the specified parameter.7.3.2
result.statusTypestringThe record status type.7.3.3.5
result.totalFeeDoubleThe total amount of the fees invoiced to the record. 7.3.2
result.totalJobCostdoubleThe combination of work order assignments (labor) and costs. 7.3.2
result.totalPayDoubleThe total amount of pay. 7.3.2
result.trackingIdlongThe application tracking number (IVR tracking number).7.3.2
result.typeresult.type{}The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).7.3.2
result.type.aliasstringThe record type alias.7.3.2
result.type.categorystringThe 4th level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.filterNamestringThe name of the record type filter which defines the record types to be displayed for the citizen user.7.3.2
result.type.groupstringThe 1st level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.idstringThe unique identifier for the object, assigned by the Civic Platform server and provided in a response.7.3.2
result.type.modulestringUse to filter by the module.7.3.2
result.type.subTypestringThe 3rd level in a 4-level record type structure (Group-Type-Subtype-Category). 7.3.2
result.type.textstringThe localized display text.7.3.2
result.type.typestringThe 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).7.3.2
result.type.valuestringThe value for the specified parameter.7.3.2
result.undistributedCostdoubleThe undistributed costs for this work order.7.3.2
result.updateDatedateTimeThe date when the record was last updated.8.0.0
result.valuestringThe value for the specified parameter.7.3.2
statusintegerThe record status.7.3.3

Example

Sample Response Body

{
  "result": [
    {
      "id": "ISLANDTON-14CAP-00000-000FW",
      "priority": {
        "value": "1",
        "text": "1"
      },
      "type": {
        "module": "ServiceRequest",
        "type": "Graffiti",
        "value": "ServiceRequest/Graffiti/Graffiti/NA",
        "category": "NA",
        "text": "Graffiti ",
        "group": "ServiceRequest",
        "subType": "Graffiti",
        "id": "ServiceRequest-Graffiti-Graffiti-NA"
      },
      "description": "A graffiti on the wall - Updated V3 Put 2",
      "undistributedCost": 0,
      "serviceProviderCode": "ISLANDTON",
      "statusDate": "2014-09-17 12:45:07",
      "totalJobCost": 0,
      "initiatedProduct": "AMO",
      "createdBy": "DEVELOPER",
      "module": "ServiceRequest",
      "customId": "SR-2014-00227",
      "openedDateFrom": "2014-09-17 00:00:00",
      "assignedToDepartment": "ISLANDTON/SERVREQ/NA/NA/NA/NA/NA",
      "assignedUser": "DEVELOPER",
      "trackingId": 259853590,
      "value": "14CAP-00000-000FW",
      "totalFee": 0,
      "totalPay": 0,
      "balance": 0,
      "booking": false,
      "infraction": false,
      "misdemeanor": false,
      "offenseWitnessed": false,
      "defendantSignature": false,
      "publicOwned": false
    }
  ],
  "status": 200,
  "page": {
    "offset": 0,
    "limit": 25,
    "hasmore": false
  }
}