Get All Record Types

Gets predefined record types.

Resource Information

Scope	records Deprecated scope name: get_settings_record_types
App Type	All
Authorization Type	No authorization required
URI	/v4/settings/records/types?lang={lang}
HTTP Method	GET
Automation Version(s)	7.3.2

Request Information

Field or Parameter	Type	Required	Values	Description	Automation Version
action	string	No	createApplication \| createHuntingLicense \| amendApplication \| amendContact	The action associated with the record type used for filtering record types.	8.0.0
expand	string	No	associations	The 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.3.5
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
filterName	string	No	�	The name of the record type filter which defines the record types to be displayed for the citizen user.	7.3.2
isFeeEstimate	boolean	No	true \| false	Indicates whether or not the fee is estimated.	7.3.2
lang	String	No	�	Indicates the language applied.	7.3.2
limit	long	No	�	Indicates the number of items that are returned in each page.	7.3.2
module	string	Yes	Get All Modules	Use to filter by the module.	7.3.2
offset	long	No	�	Indicates the offset start of each page by the number specified.	7.3.2

Example

Sample Request Head

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

Response Information

Field	Type	Description	Automation Version
result[]	result{}	�	7.3.2
result.alias	string	The record type alias.	7.3.2
result.associations	result.associations{}	Contains parameter settings associated with instances of the record type.	7.3.3.5
result.associations.addressTypeGroup	string	The name of the address type group that contains permissible address tyeps for instances of the record type.	7.3.3.5
result.associations.customFormGroup	string	The name of the custom forms group for instances of the record type.	7.3.3.5
result.associations.documentCode	string	The code that defines the document types for the record type.	7.3.3.5
result.associations.expirationCode	string	The code that defines the parameters for expiring records that are instances of the record type.	7.3.3.5
result.associations.feeSchedule	string	The name of the fee schedule associated with instances of the record type.	7.3.3.5
result.associations.inspectionGroup	string	The name of the inspection group that contains the inspection-related parameters applied to instances of the record type.	7.3.3.5
result.associations.recordStatusGroup	string	�	7.3.3.5
result.associations.standardCommentGroup[]	result.associations.standardCommentGroup{}	The name of the standard comment group associated with instances of the record type.	7.3.3.5
result.associations.standardCommentGroup.text	string	The localized display text.	7.3.3.5
result.associations.standardCommentGroup.value	string	The value for the specified parameter.	7.3.3.5
result.associations.virtualFolderGroup	string	The name of the virtual folder group associated with instances of the record type.	7.3.3.5
result.associations.workflow	string	The name of the workflow associated with instances of the record type.	7.3.3.5
result.category	string	The 4th level in a 4-level record type structure (Group-Type-Subtype-Category).	7.3.2
result.createable	Boolean	Indicates whether or not the record can be created.	7.3.2
result.deletable	Boolean	Indicates whether or not the record can be deleted.	7.3.2
result.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.group	string	The 1st level in a 4-level record type structure (Group-Type-Subtype-Category).	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.module	string	Use to filter by the module.	7.3.2
result.readable	Boolean	Indicates whether or not values for sibling fields are readable.	7.3.2
result.searchable	Boolean	Indicates whether or not the item is searchable. "true" : the item is searchable. "false" : the item is not searchable.	7.3.2
result.subType	string	The 3rd level in a 4-level record type structure (Group-Type-Subtype-Category).	7.3.2
result.text	string	The localized display text.	7.3.2
result.type	string	The 2nd level in a 4-level record type structure (Group-Type-Subtype-Category).	7.3.2
result.updatable	Boolean	Whether or not you can update the record.	7.3.2
result.value	string	The value for the specified parameter.	7.3.2
status	integer	The record status.	7.3.2

Example

Sample Response Body

{
  "result": [
    {
      "type": "Animals",
      "value": "ServiceRequest/Animals/Animal Nuisance/NA",
      "category": "NA",
      "text": "Animal Nuisance",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Animal Nuisance",
      "id": "ServiceRequest-Animals-Animal.cNuisance-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Buildings and Property",
      "value": "ServiceRequest/Buildings and Property/Fence Dispute/NA",
      "category": "NA",
      "text": "Fence Dispute",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Fence Dispute",
      "id": "ServiceRequest-Buildings.cand.cProperty-Fence.cDispute-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Buildings and Property",
      "value": "ServiceRequest/Buildings and Property/Grading/NA",
      "category": "NA",
      "text": "Grading",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Grading",
      "id": "ServiceRequest-Buildings.cand.cProperty-Grading-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Buildings and Property",
      "value": "ServiceRequest/Buildings and Property/Home Occupation/NA",
      "category": "NA",
      "text": "Home Occupation",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Home Occupation",
      "id": "ServiceRequest-Buildings.cand.cProperty-Home.cOccupation-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Buildings and Property",
      "value": "ServiceRequest/Buildings and Property/Illegal Occupancy/NA",
      "category": "NA",
      "text": "Illegal Occupancy",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Illegal Occupancy",
      "id": "ServiceRequest-Buildings.cand.cProperty-Illegal.cOccupancy-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Buildings and Property",
      "value": "ServiceRequest/Buildings and Property/Junk on Property/NA",
      "category": "NA",
      "text": "Junk on Property",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Junk on Property",
      "id": "ServiceRequest-Buildings.cand.cProperty-Junk.con.cProperty-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Buildings and Property",
      "value": "ServiceRequest/Buildings and Property/Sub-Standard Property/NA",
      "category": "NA",
      "text": "Sub-Standard Property",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Sub-Standard Property",
      "id": "ServiceRequest-Buildings.cand.cProperty-Sub.1Standard.cProperty-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Buildings and Property",
      "value": "ServiceRequest/Buildings and Property/Vacant Building/NA",
      "category": "NA",
      "text": "Vacant Building",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Vacant Building",
      "id": "ServiceRequest-Buildings.cand.cProperty-Vacant.cBuilding-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Buildings and Property",
      "value": "ServiceRequest/Buildings and Property/Working Without Permit/NA",
      "category": "NA",
      "text": "Working Without Permit",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Working Without Permit",
      "id": "ServiceRequest-Buildings.cand.cProperty-Working.cWithout.cPermit-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Garbage",
      "value": "ServiceRequest/Garbage/Trash Removal/NA",
      "category": "NA",
      "text": "Trash Removal",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Trash Removal",
      "id": "ServiceRequest-Garbage-Trash.cRemoval-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Graffiti",
      "value": "ServiceRequest/Graffiti/Graffiti/NA",
      "category": "NA",
      "text": "Graffiti ",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Graffiti",
      "id": "ServiceRequest-Graffiti-Graffiti-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Noise",
      "value": "ServiceRequest/Noise/Excessive Noise/NA",
      "category": "NA",
      "text": "Excessive Noise",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Excessive Noise",
      "id": "ServiceRequest-Noise-Excessive.cNoise-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Signage",
      "value": "ServiceRequest/Signage/Illegal Sign/NA",
      "category": "NA",
      "text": "Illegal Sign",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Illegal Sign",
      "id": "ServiceRequest-Signage-Illegal.cSign-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Streets and Sidewalks",
      "value": "ServiceRequest/Streets and Sidewalks/Pothole/NA",
      "category": "NA",
      "text": "Pothole",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Pothole",
      "id": "ServiceRequest-Streets.cand.cSidewalks-Pothole-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Streets and Sidewalks",
      "value": "ServiceRequest/Streets and Sidewalks/Snow Removal/NA",
      "category": "NA",
      "text": "Snow Removal",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Snow Removal",
      "id": "ServiceRequest-Streets.cand.cSidewalks-Snow.cRemoval-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Streets and Sidewalks",
      "value": "ServiceRequest/Streets and Sidewalks/Street Flooding/NA",
      "category": "NA",
      "text": "Street Flooding",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Street Flooding",
      "id": "ServiceRequest-Streets.cand.cSidewalks-Street.cFlooding-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Streets and Sidewalks",
      "value": "ServiceRequest/Streets and Sidewalks/Street Light/NA",
      "category": "NA",
      "text": "Street Light",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Street Light",
      "id": "ServiceRequest-Streets.cand.cSidewalks-Street.cLight-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Trees and Weeds",
      "value": "ServiceRequest/Trees and Weeds/Tall Grass and Weeds/NA",
      "category": "NA",
      "text": "Tall Grass and Weeds",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Tall Grass and Weeds",
      "id": "ServiceRequest-Trees.cand.cWeeds-Tall.cGrass.cand.cWeeds-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Trees and Weeds",
      "value": "ServiceRequest/Trees and Weeds/Tree Maintenance/NA",
      "category": "NA",
      "text": "Tree Maintenance",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Tree Maintenance",
      "id": "ServiceRequest-Trees.cand.cWeeds-Tree.cMaintenance-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Vehicles",
      "value": "ServiceRequest/Vehicles/Abandoned Vehicle/NA",
      "category": "NA",
      "text": "Abandoned Vehicle",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Abandoned Vehicle",
      "id": "ServiceRequest-Vehicles-Abandoned.cVehicle-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    },
    {
      "type": "Water and Sewage",
      "value": "ServiceRequest/Water and Sewage/Leaking Fire Hydrant/NA",
      "category": "NA",
      "text": "Leaking Fire Hydrant",
      "group": "ServiceRequest",
      "module": "ServiceRequest",
      "subType": "Leaking Fire Hydrant",
      "id": "ServiceRequest-Water.cand.cSewage-Leaking.cFire.cHydrant-NA",
      "readable": true,
      "createable": true,
      "updatable": true,
      "deletable": true,
      "searchable": true
    }
  ],
  "status": 200,
  "page": {
    "offset": 0,
    "limit": 25,
    "hasmore": false
  }
}