Settings
Settings/Activities
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Activity Priorities | Agency | settings | Access token | GET /v4/settings/activities/priorities | 7.3.3 |
| Get All Activity Statuses | Agency | settings | Access token | GET /v4/settings/activities/statuses | 7.3.3 |
| Get All Activity Types | Agency | settings | Access token | GET /v4/settings/activities/types | 7.3.3 |
Settings/Addresses
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Address Countries | All | addresses | Access token | GET /v4/settings/addresses/countries | 7.3.2 |
| Get All Address States | All | addresses | Access token | GET /v4/settings/addresses/states | 7.3.2 |
| Get All Address Street Directions | All | addresses | Access token | GET /v4/settings/addresses/streetDirections | 7.3.2 |
| Get All Address Street Fractions | All | addresses | Access token | GET /v4/settings/addresses/streetFractions | 7.3.2 |
| Get All Address Street Suffixes | All | addresses | Access token | GET /v4/settings/addresses/streetSuffixes | 7.3.2 |
| Get All Address Unit Types | All | addresses | Access token | GET /v4/settings/addresses/unitTypes | 7.3.2 |
Settings/Agencies
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Department Staff | Agency | settings | Access token | GET /v4/settings/departments/{id}/staffs | 7.3.2 |
| Get All Departments | Agency | settings | Access token | GET /v4/settings/departments | 7.3.2 |
Settings/Assessments
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Condition Assessment Types | Agency | assessments | Access token | GET /v4/settings/assessments/types | 9.0.0 |
Settings/AssetTypes
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Asset Class Types | Agency | assets | Access token | GET /v4/settings/assettypes/classTypes | 9.0.0 |
| Get All Asset Rating Types | Agency | assets | Access token | GET /v4/settings/assettypes/ratingTypes | 9.0.0 |
| Get All Asset Record Types | Agency | settings | Access token | GET /v4/settings/assettypes/recordtypes | 9.0.0 |
| Get All Asset Types | Agency | assets | Access token | GET /v4/settings/assettypes/types | 9.0.0 |
| Get All Asset Usage Types | Agency | assets | Access token | GET /v4/settings/assettypes/usageTypes | 9.0.0 |
Settings/Comments
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Standard Comment Groups | Agency | settings | Access token | GET /v4/settings/comments/groups | 7.3.2 |
| Get All Standard Comments | Agency | settings | Access token | GET /v4/settings/comments | 7.3.2 |
Settings/ConditionApprovals
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Approval Condition Statuses | Agency | conditions | Access token | GET /v4/settings/conditionApprovals/statuses | 7.3.2 |
Settings/Conditions
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Standard Condition Statuses | Agency | conditions | Access token | GET /v4/settings/conditions/statuses | 7.3.2 |
| Get All Standard Condition Types | Agency | conditions | Access token | GET /v4/settings/conditions/types | 7.3.2 |
| Get All Standard Conditon Priorities | Agency | conditions | Access token | GET /v4/settings/conditions/priorities | 7.3.2 |
Settings/Contacts
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Contact Preferred Channels | All | contacts | Access token | GET /v4/settings/contacts/preferredChannels | 7.3.2 |
| Get All Contact Races | All | contacts | Access token | GET /v4/settings/contacts/races | 7.3.2 |
| Get All Contact Relations | All | contacts | Access token | GET /v4/settings/contacts/relations | 7.3.2 |
| Get All Contact Salutations | All | contacts | Access token | GET /v4/settings/contacts/salutations | 7.3.2 |
| Get All Contact Types | All | contacts | Access token | GET /v4/settings/contacts/types | 7.3.2 |
| Get All Custom Form Settings for Contact Type | All | settings | Access token | GET /v4/settings/contacts/types/{id}/customForms | 7.3.2 |
| Get All Custom Table Settings for Contact Type | Agency | settings | Access token | GET /v4/settings/contacts/types/{id}/customTables | 8.0.3 |
Settings/Costs
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Cost Accounts | Agency | settings | Access token | GET /v4/settings/costs/accounts | 7.3.3 |
| Get All Cost Factors | Agency | settings | Access token | GET /v4/settings/costs/factors | 7.3.3 |
| Get All Cost Type Items | Agency | settings | Access token | GET /v4/settings/costs/types/{typeName}/items | 7.3.3 |
| Get All Cost Types | Agency | settings | Access token | GET /v4/settings/costs/types | 7.3.3 |
| Get All Cost Unit Types | Agency | settings | Access token | GET /v4/settings/costs/unitTypes | 7.3.3 |
Settings/Documents
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Folders | Agency | documents | Access token | POST /v4/settings/documents/folders | 7.3.3 |
| Delete Folders | Agency | documents | Access token | DELETE /v4/settings/documents/folders/{ids} | 7.3.3 |
| Get All Document Categories | All | documents | Access token | GET /v4/settings/documents/categories | 7.3.2 |
| Get All Folder Groups | Agency | documents | Access token | GET /v4/settings/documents/folderGroups | 7.3.3 |
| Get Folder Group | Agency | documents | Access token | GET /v4/settings/documents/folders/{groupId} | 7.3.3 |
| Update Folder Groups | Agency | documents | Access token | PUT /v4/settings/documents/folderGroups | 7.3.3 |
| Update Folders | Agency | documents | Access token | PUT /v4/settings/documents/folders | 7.3.3 |
Settings/Drilldowns
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get Drilldown Settings | All | settings | No auth required | GET /v4/settings/drillDowns/{drillId} | 7.3.2 |
Settings/Inspections
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Custom Form Settings for Checklist Item | Agency | inspections | Access token | GET /v4/settings/inspections/checklists/{checklistId}/checklistItems/{checklistItemId}/customForms | 7.3.2 |
| Get All Custom Table Settings for Checklist Item | Agency | inspections | Access token | GET /v4/settings/inspections/checklists/{checklistId}/checklistItems/{checklistItemId}/customTables | 7.3.2 |
| Get All Inspection Checklist Groups | Agency | inspections | Access token | GET /v4/settings/inspections/checklistsGroups | 7.3.2 |
| Get All Inspection Checklists | Agency | inspections | Access token | GET /v4/settings/inspections/checklists | 7.3.2 |
| Get All Inspection Grades | All | inspections | Access token | GET /v4/settings/inspections/grades | 7.3.2 |
| Get All Inspection Statuses | All | inspections | Access token | GET /v4/settings/inspections/statuses | 7.3.2 |
| Get All Inspection Types | All | inspections | Access token | GET /v4/settings/inspections/types | 7.3.2 |
| Get Inspection Checklist Statuses | All | inspections | Access token | GET /v4/settings/inspections/checklists/statuses | 7.3.3 |
| Get Inspection Checklists | Agency | inspections | Access token | GET /v4/settings/inspections/checklists/{ids} | 7.3.2 |
| Get Inspection Types | All | inspections | Access token | GET /v4/settings/inspections/types/{ids} | 7.3.2 |
Settings/Modules
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Modules | All | settings | Access token | GET /v4/settings/modules | 7.3.2 |
Settings/Parts
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Part Locations | ALL | settings | No auth required | GET /v4/settings/parts/locations | 7.3.3 |
| Get Part Types | Agency | settings | Access token | GET /v4/settings/parts/types | 7.3.3 |
Settings/PickLists
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Pick Lists | All | settings | Access token | GET /v4/settings/pickLists | 7.3.3 |
| Get Pick List | All | settings | Access token | GET /v4/settings/pickLists/{id} | 7.3.3 |
Settings/Priorities
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Priorities | All | settings | Access token | GET /v4/settings/priorities | 7.3.2 |
Settings/Professionals
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Professional License Boards | All | professionals | Access token | GET /v4/settings/professionals/licenseBoards | 7.3.2 |
| Get All Professional License Types | All | professionals | Access token | GET /v4/settings/professionals/types | 7.3.2 |
| Get All Professional Salutations | All | professionals | Access token | GET /v4/settings/professionals/salutations | 7.3.2 |
Settings/Records
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Asset Types for Record Type | Agency | records | Access token | GET /v4/settings/records/types/{recordTypeId}/assetTypes | 9.0.0 |
| Get All Custom Forms for Record Type | All | records | No auth required | GET /v4/settings/records/types/{id}/customForms | 7.3.2 |
| Get All Custom Tables for Record Type | All | records | No auth required | GET /v4/settings/records/types/{id}/customTables | 7.3.2 |
| Get All Fee Schedules for Record Type | All | records | Access token | GET /v4/settings/records/types/{id}/fees/schedules | 7.3.2 |
| Get All Record Construction Types | All | records | Access token | GET /v4/settings/records/constructionTypes | 7.3.2 |
| Get All Record Expiration Statuses | All | records | Access token | GET /v4/settings/records/expirationStatuses | 7.3.2 |
| Get All Record Types | All | records | No auth required | GET /v4/settings/records/types | 7.3.3.2 |
| Get All Statuses for Record Type | All | records | Access token | GET /v4/settings/records/types/{id}/statuses | 7.3.2 |
Settings/TimeAccounting
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Time Accounting Groups | All | settings | No auth required | GET /v4/settings/timeAccounting/groups | 7.3.2 |
| Get All Time Accounting Types | All | settings | No auth required | GET /v4/settings/timeAccounting/types | 7.3.2 |
ShoppingCarts
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Shopping Cart | Citizen | shoppingcart | Access token | POST /v4/shoppingCart | 7.3.3 |
| Delete Shopping Carts | Citizen | shoppingcart | Access token | DELETE /v4/shoppingCart/{ids} | 7.3.3 |
| Get All Shopping Carts | Citizen | shoppingcart | Access token | GET /v4/shoppingCart | 7.3.3 |
| Get Shopping Carts | Citizen | shoppingcart | Access token | GET /v4/shoppingCart/{ids} | 7.3.3 |
| Update Shopping Cart | Citizen | shoppingcart | Access token | PUT /v4/shoppingCart/{id} | 7.3.3 |
TimeAccounting
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Create Time Accounting | Agency | timeaccounting | Access token | POST /v4/timeAccounting | 7.3.3 |
| Delete Time Accounting | Agency | timeaccounting | Access token | DELETE /v4/timeAccounting/{ids} | 7.3.3 |
| Get Time Accounting | Agency | timeaccounting | Access token | GET /v4/timeAccounting | 7.3.3 |
| Update Time Accounting | Agency | timeaccounting | Access token | PUT /v4/timeAccounting/{id} | 7.3.3 |
TrustAccounts
| Name | App Type | Scope | Auth Type | Resource URI | Civic Platform version |
|---|---|---|---|---|---|
| Get All Trust Accounts | All | trustaccounts | Access token | GET /v4/trustAccounts | 7.3.3.4 |
Overview:
Settings
The settings object provides information on the configuration values for the settings subobjects. These values can vary based on how the hosting agency configures the system via Civic Platform Administration. Depending on various configurations and options defined by the agency, the settings can be useful to build a dynamic application. The settings object supports the GET method for read operations only; it does not support any POST or PUT methods.
