APIs

Filter by App Type: All | Agency |Citizen

Agencies

Name	Scope (Permission)	App Type	Method + URI
Get Agency	get_agency	Agency	GET /v3/agencies/{name}

Get Agency Logo	get_agency_logo	Agency	GET /v3/agencies/{name}/logo

App Settings

Name	Scope(Permission)	App Type	Method + URI
Get App Settings	get_app_settings	All	GET /v3/appsettings

Geocoding

Name	Scope(Permission)	App Type	Method + URI
Reverse Geocode Address	reverse_geocode	All	GET /v3/geo/geocode/reverse

Agency Locator

Name	Scope(Permission)	App Type	Method + URI
Search Agencies By Coordinates	search_agencies_by_geo	All	POST /v3/geo/search/agencies

Addresses

Name	Scope(Permission)	App Type	Method + URI
Describe Street Prefixes	get_ref_street_prefixes	Agency	GET /v3/system/address/streetPrefixes

Search Address	get_addresses	Agency	GET /v3/addresses

Get Address	get_address	Agency	GET /v3/addresses/{id}

Parcels

Name	Scope(Permission)	App Type	Method + URI
Search Parcels	search_parcels	Agency	POST /v3/search/parcels

Simple Search Parcels	get_parcels	Agency	GET /v3/parcels

Get Parcels By Ids	get_parcel	Agency	GET /v3/parcels/{ids}

Get Parcel's Owners	get_parcel_owners	Agency	GET /v3/parcels/{id}/owners

Get Parcel's Addresses	get_parcel_addresses	Agency	GET /v3/parcels/{id}/addresses

Owners

Name	Scope(Permission)	App Type	Method + URI
Search Owners	get_owners	Agency	GET /v3/owners

Assets

Name	Scope(Permission)	App Type	Method + URI
Describe Asset Types	get_ref_asset_types	Agency	GET /v3/system/asset/types

Describe Asset Statuses	get_ref_asset_statuses	Agency	GET /v3/system/asset/statuses

Describe Asset Unit Types	get_ref_asset_unit_types	Agency	GET /v3/system/asset/unitTypes

Describe Asset ASI	get_ref_asset_asis	Agency	GET /v3/system/asset/asis

Describe Asset ASIT	get_ref_asset_asits	Agency	GET /v3/system/asset/asits

Get Asset CA Types	get_ref_asset_catypes	Agency	GET /v3/system/asset/assetcatypes

Get Assets	get_asset	Agency	GET /v3/assets/{ids}

Get Asset Attribute Tables	get_asset_attributetables	Agency	GET /v3/assets/{id}/attributetables

Get Asset Attributes	get_asset_attributes	Agency	GET /v3/assets/{id}/attributes

Get Asset Condition Assessments	get_condition_assessments	Agency	GET /v3/assets/{id}/conditionassessments

Create Asset	create_asset	Agency	POST /v3/assets

Search Assets	search_assets	Agency	POST /v3/search/assets

Contacts

Name	Scope(Permission)	App Type	Method + URI
Describe Contact Types	get_ref_contact_types	Agency	GET /v3/system/contact/types

Simple Search Contacts	get_contacts	Citizen	GET /v3/contacts

Advanced Search Contacts	search_contacts	Citizen	POST /v3/search/contacts

Professionals

Name	Scope(Permission)	App Type	Method + URI

Get Professionals	get_professional	Citizen	GET /v3p/professionals/{ids}

Get Professionals	get_professionals	Citizen	GET /v3p/professionals/

Get Professional Records	get_professional_records	Citizen	GET /v3p/professionals/{id}/records

Search professionals	search_professionals	Citizen	POST /v3p/search/professionals/

Documents

Name	Scope(Permission)	App Type	Method + URI
Describe Document Types	get_ref_document_types	Agency	GET /v3/system/document/types

Download Attachment	get_document	All	GET /v3/documents/{id}

Download Image Thumbnail	get_thumbnail	All	GET /v3/documents/{id}/thumbnail

Download document	download_document	Citizen	GET /v3p/documents/{documentId}/download

Get document	get_document	Citizen	GET /v3p/documents/{documentIds}

Standard Comments

Name	Scope(Permission)	App Type	Method + URI
Get Standard Comment Groups	get_ref_standard_comment_groups	Agency	GET /v3/system/standardCommentGroups

Get Standard Comments	get_ref_standard_comments	Agency	GET /v3/system/standardComments

Records

Name	Scope(Permission)	App Type	Method + URI
Describe Record Type	get_ref_record_type	All	GET /v3/system/record/types/{recordTypeId}

Describe Work Order Templates	get_ref_work_order_templates	Agency	GET /v3/system/record/workordertemplates

Describe ASI	get_ref_record_type_asis	Agency	GET /v3/system/record/type/{id}/asis

Describe ASI Drilldown	get_ref_asi_drilldown	Agency	GET /v3/system/record/type/{id}/asis/drilldowns/{drilldownid}

Describe ASIT	get_ref_record_type_asits	Agency	GET /v3/system/record/type/{id}/asits

Describe ASIT Drilldown	get_ref_asit_drilldown	Agency	GET /v3/system/record/type/{id}/asits/drilldowns/{drilldownid}

Describe Priorities	get_ref_record_priorities	Agency	GET /v3/system/record/priorities

Describe Record Status	get_ref_record_type_statuses	Agency	GET /v3/system/record/type/{typeId}/statuses

Describe Work Order Task Unit	get_ref_workordertask_units	Agency	GET /v3/system/record/workordertask/units

Simple Search Records	get_records	All	GET /v3/records

Advanced Search Records	search_records	All	POST /v3/search/records

Search Records By Coordinates	geocode_search_records	All	POST /v3/search/records/coordinates

Get Records By Ids	get_record	All	GET /v3/records/{ids}

Get Drilldowns	get_record_asit_drilldown	Agency	GET /v3/records/{id}/asits/drilldowns/{drilldownid}

Get Record ASI Drilldown	get_record_asi_drilldown	Agency	GET /v3/records/{id}/asis/drilldowns/{drilldownid}

Get Record's ASI	get_record_asis	Agency	GET /v3/records/{id}/asis

Get Record's ASIT	get_record_asits	Agency	GET /v3/records/{id}/asits

Get Record's Addresses	get_record_addresses	All	GET /v3/records/{id}/addresses

Get Record's Assets	get_record_assets	Agency	GET /v3/records/{id}/assets

Get Record's comments	get_record_comments	Agency	GET /v3/records/{id}/comments

Get Record's Conditions	get_record_conditions	Agency	GET /v3/records/{id}/conditions

Get Record's Contacts	get_record_contacts	All	GET /v3/records/{id}/contacts

Get Record's Documents	get_record_documents	All	GET /v3/records/{id}/documents

Get Record's Inspections	get_record_inspections	Agency	GET /v3/records/{id}/inspections

Get Record's Plottable Location	get_record_location	Agency	GET /v3/records/{id}/location

Get Record's Owners	get_record_owners	Agency	GET /v3/records/{id}/owners

Get Record's Parcels	get_record_parcels	Agency	GET /v3/records/{id}/parcels

Get Record's Workflow Tasks	get_record_workflow_tasks	Agency	GET /v3/records/{id}/workflowtasks

Get Record's Parts	get_record_parts	Agency	GET /v3/records/{id}/parts

Get Record's Costs	get_record_costs	Agency	GET /v3/records/{id}/costs

Get Record's Workorder Tasks	get_record_workorder_tasks	Agency	GET /v3/records/{id}/workordertasks

Get Related Records	get_related_records	Agency	GET /v3/records/{id}/related


Get User votes	get_record_votes	Citizen	GET /v3/records/{id}/votes

Create Record	create_record	All	POST /v3/records


Upload Documents	create_record_document	All	POST /v3/records/{id}/documents

Update Record	update_record	Agency	PUT /v3/records/{id}

Update Workflow Task	update_record_workflow_task	Agency	PUT /v3/records/{id}/workflowtask

Make Votes	create_record_vote	Citizen	POST /v3/records/{id}/votes

Describe Record Types	get_ref_record_types	All	GET /v3/system/record/types

Get Record's Condition Summary	get_record_condition_summary	Agency	GET /v3/records/{id}/conditionsummary

Get Record's Contact Summary	get_record_contact_summary	Agency	GET /v3/records/{id}/contactsummary

Get Record's Fee Summary	get_record_fee_summary	Agency	GET /v3/records/{id}/feesummary

Get Record's Inspection Summary	get_record_inspection_summary	Agency	GET /v3/records/{id}/inspectionsummary

Get Record's Project Informations	get_record_project_informations	Agency	GET /v3/records/{id}/projectinformations

Get Record's Workflow Summary	get_record_workflow_summary	Agency	GET /v3/records/{id}/workflowsummary

Get User Activities Summary	get_record_user_activities_summary	Agency	GET /v3/records/{id}/useractivitiessummary

Create record	create_record	Citizen	POST /v3p/records

Create record document	create_record_document	Citizen	POST /v3p/records/{recordId}/documents

Delete record document	delete_record_document	Citizen	DELETE /v3p/records/{recordId}/documents/{documentIds}

Delete record documents	delete_record_documents	Citizen	DELETE /v3p/records/{recordId}/documents

Download document	download_document	Citizen	GET /v3p/documents/{documentId}/download

Get document	get_document	Citizen	GET /v3p/documents/{documentIds}

Get my records	get_my_records	Citizen	GET /v3p/records/mine

Get record	get_record	All	GET /v3p/records/{recordIds}

Get record contacts	get_record_contacts	Citizen	GET /v3p/records/{recordId}/contacts

Get record documents	get_record_documents	Citizen	GET /v3p/records/{recordId}/documents

Get record fees	get_record_fees	Citizen	GET /v3p/records/{recordId}/fees

Get record owners	get_record_owners	Citizen	GET /v3p/records/{recordId}/owners

Get record parcels	get_record_parcels	Citizen	GET /v3p/records/{recordId}/parcels

Get record professionals	get_record_professionals	All	GET /v3p/records/{recordId}/professionals

Get records	get_records	Citizen	GET /v3p/records/

Get records addresses	get_record_addresses	Citizen	GET /v3p/records/{recordId}/addresses

Search records	search_records	Citizen	POST /v3p/search/records/

Get Record Conditions	get_record_conditions	Agency	GET /v3p/records/{recordId}/conditions

Get Record Condition	get_record_condition	Agency	GET /v3p/records/{recordId}/conditions/{id}

Create Record Conditions	create_record_conditions	Agency	POST /v3p/records/{recordId}/conditions

Update Record Condition	update_record_condition	Agency	PUT /v3p/records/{recordId}/conditions/{id}

Delete Record Conditions	delete_record_conditions	Agency	DELETE /v3p/records/{recordId}/conditions/{ids}

Inspections

Name	Scope(Permission)	App Type	Method + URI
Describe Inspection Groups	get_ref_inspection_groups	Agency	GET /v3/system/inspection/groups

Describe Inspection Types	get_ref_inspection_types	Agency	GET /v3/system/inspection/groups/{id}/types

Describe Inspection Checklists	get_ref_inspection_checklist_groups	Agency	GET /v3/system/inspection/checklist/groups

Simple Search Inspection	get_inspections	Agency	GET /v3/inspections

Advanced Search Inspections	search_inspections	Agency	POST /v3/search/inspections

Get Single Inspection	get_inspection	Agency	GET /v3/inspections/{id}

Schedule Inspection	create_inspection	Agency	POST /v3/inspections

Reassign Inspection	reassign_inspection	Agency	PUT /v3/inspections/{id}/reassign

Reschedule Inspection	reschedule_inspection	Agency	PUT /v3/inspections/{id}/reschedule

Get Inspectors	get_ref_inspectors	Agency	GET /v3/system/inspection/inspectors

Gets the checklist items	get_inspection_checklist_items	Agency	GET /v3/inspections/{id}/checklists/{checklistid}/checklistitems

Gets the checklists	get_inspection_checklists	Agency	GET /v3/inspections/{id}/Checklists

Cancel Inspection	cancel_inspection	Agency	PUT /v3/inspections/{id}/cancel

Available Inspection Dates	get_available_inspection_dates	Agency	GET /v3/inspections/availableDates

Create Inspection	create_inspection	All	POST /v3p/inspections/schedule

Delete Inspection Documents	delete_inspection_documents	All	DELETE /v3p/inspections/{inspectionId}/documents/{ids}

Get Checklists For Specific Inspection	get_inspection_checklist	Agency	GET /v3p/inspections/{inspectionId}/checklists

Get Inspection Document	get_inspection_documents	All	GET /v3p/inspections/{inspectionId}/documents

Get Inspection Grades	get_ref_inspection_grades	All	GET /v3p/settings/inspections/grades

Get Inspection Status	get_ref_inspection_statuses	All	GET /v3p/settings/inspections/status

Get Inspection Types By GroupCode	get_inspection_types_by_groupcode	Agency	GET /v3p/settings/inspections/types

Get Inspection Types By Ids	get_inspection_types_by_ids	Agency	GET /v3p/settings/inspections/types/{ids}

Get Inspection Types By Record Ids	get_inspection_types_by_recordids	All	GET /v3p/records/{recordIds}/inspectionTypes

Get Inspections By Ids	get_inspections_by_ids	All	GET /v3p/inspections/{ids}

Get Specific Inspection Checklist items.	get_inspection_checklist_items	Agency	GET /v3p/inspections/checklists/{id}/checklistItems

Reschedule Inspection	reschedule_inspection	All	PUT /v3p/inspections/{id}/reschedule

Result Inspection	result_inspection	Agency	PUT /v3p/inspections/{id}/result

Search Inspections	search_inspections	Agency	POST /v3p/search/inspections

Update Inspection	update_inspection	All	PUT /v3p/inspections/{id}/schedule

Upload Inspection Documents	upload_inspection_documents	All	POST /v3p/inspections/{inspectionId}/documents

Create Inspection Checklists	create_checklists	Agency	POST /v3p/inspections/{inspectionId}/checklists

Delete Checklists	delete_checklists	Agency	DELETE /v3p/inspections/checklists/{ids}

Get Checklist Item Documents	get_checklistitem_documents	Agency	GET /v3p/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{checkListItemId}/documents

Get Reference Checklist By Group Id	get_ref_checklist_by_ids	Agency	GET /v3p/checklists/{ids}

Get Reference Checklist Groups	get_ref_checklist_groups	Agency	GET /v3p/checklistGroups

Get Reference Checklists	get_ref_checklists	Agency	GET /v3p/checklists

Update CheckList Items	update_checklist_items	Agency	PUT /v3p/inspections/checklists/{id}/checklistItems

Upload Checklist Item Documents	upload_checklistitem_documents	Agency	POST /v3p/inspections/{inspectionId}/checklists/{checklistId}/checklistItems/{id}/documents

Assessments

Name	Scope(Permission)	App Type	Method + URI
Describe Assessment Attributes	get_assessment_attributes_describe	Agency	GET /v3/assessments/{id}/attributes/describe

Describe Assessment Observation	get_assessment_observation_describe	Agency	GET /v3/assessments/{id}/observation/describe

Simple Search Assessment	get_assessment	Agency	GET /v3/assessments/{id}

Advanced Search Assessments	search_assessments	Agency	POST /v3/search/assessments

Get Assessment Attributes Detail	get_assessment_attributes_detail	Agency	GET /v3/assessments/{id}/attributes

Create Assessment	create_assessment	Agency	POST /v3/assessments

Create Assessment Attachment	create_assessment_document	Agency	POST /v3/assessments/{id}/document

Create Assessment Attributes	create_assessment_attributes	Agency	POST /v3/assessments/{id}/attributes

Create Assessment Observations	create_assessment_observations	Agency	POST /v3/assessments/{id}/observations

Update Assessment	update_assessment	Agency	PUT /v3/assessments/{id}

Update Assessment Attributes	update_assessment_attributes	Agency	PUT /v3/assessments/{caId}/attributes/{attrId}/subgroups/{id}

Update Assessment Observations	update_assessment_observations	Agency	PUT /v3/assessments/{caId}/observations/{obserId}

Get Assessment Observation Details.	get_assessment_observation_details	Agency	GET /v3/assessments/{id}/observations

Modules

Name	Scope(Permission)	App Type	Method + URI
Get Modules	get_ref_modules	Agency	GET /v3/system/common/modules

Users

Name	Scope(Permission)	App Type	Method + URI
Get User Profile	get_user_profile	All	GET /v3/users/me

Departments

Name	Scope(Permission)	App Type	Method + URI
Get Departments	get_ref_departments	Agency	GET /v3/system/agency/departments

Staff

Name	Scope(Permission)	App Type	Method + URI
Get Department Staff	get_ref_staffs	Agency	GET /v3/system/agency/departments/{id}/staffs

Inspector

Name	Scope(Permission)	App Type	Method + URI
Get User Inspector Profile	get_inspector	Agency	GET /v3/inspector

Get Inspector	get_inspector	Citizen	GET /v3p/inspector

Reports

Name	Scope(Permission)	App Type	Method + URI
Get Report Definition	get_report_definition	Agency	GET /v3/reports/describe/{reportId}

Get Reports Definition	get_reports_definition	Agency	GET /v3/reports/describe

Create Report	create_report	Agency	POST /v3/reports/{reportId}

Report Categories	get_report_categories	Agency	GET /v3/reports/categories

Conditions

Name	Scope(Permission)	App Type	Method + URI
Get Condition Types	get_condition_types	Agency	GET /v3p/settings/conditions/types

Get Condition Statuses	get_condition_statuses	Agency	GET /v3p/settings/conditions/statuses

Get Condition Priorities	get_condition_priorities	Agency	GET /v3p/settings/conditions/priorities

GisSerivceApp

Name	Scope(Permission)	App Type	Method + URI
Get Gis Service	gisserviceapp_get_service	Agency	GET /v3/gisserviceapp/service