Using the API

The Accela GIS REST API uses standard HTTP protocols to send client requests and receive response data.

Base URI

The base URI for the Accela GIS REST API is the same server URI used to deploy the Accela GIS server, which hosts the JavaScript version of the map viewer and the GIS Admin site.

For example, if Accela GIS is installed on https://agency.host.com/agis, the following shows a sample Accela GIS REST request URI: 
https://agency.host.com/agis/api/geo/v1/xapo/myagency/addresses/byParcel

Configuration

The agency specified in the {agencyId} request paramater for all Accela GIS API's must be an agency that has been configured on the Accela GIS admin site. Check with the Accela GIS administrator to verify that the following has been configured for the agency on the GIS Admin site:

  • At least one map profile with a map service connection has been defined. See Map Profiles.

  • A product integration environment has been set up, such as integration with Civic Platform ("AA") and Citizen Access ("Citizen Portal"). See Product Integrations.

  • XAPO data mapping for the XAPO API. See XAPO Configuration for Accela GIS.

Error Codes

Accela GIS API returns an error in the following JSON response:

{
"error": {
  "code": 400,
  "desc": "petalumas is not a valid agency name or provider code.",
  "traceId": "traceID is not available at this time."
  }
}
Note: traceId is not currently supported.

The following are the HTTP error codes and descriptions:

Http Status Description
404 Invalid request URL.
400 Request parameter or data validation error.
500 System or server connection error.

 

Related Information

  • XAPO Configuration for Accela GIS - The XAPO API requires proper XAPO configuration to enable the integration with an external GIS service. XAPO Configuration is performed on the GIS Administration site < XAPO Configuration.