Field

Function

Permissions

Allow RequestNumber and Email queries to the Citizen Portal REST API without providing both parameters

Controls how the Citizen Portal REST API works. Enable this option to allow the API to search for a Request using either the Request Number or Email address without having to have both parameters.

App Admin

Automatically push invalid request addresses to the general location field

Allows third-party application developers to instruct the REST API to automatically move an invalid address made on a citizen Request to the general location field (if empty). This feature is helpful when citizens can enter an address which may not validate. It only applies to the Citizen Portal REST API.

App Admin

Default Public REST WKID

Specifies the WKID (well-known ID) for the coordinate system used by the external GIS service, if:

• the external GIS service's WKID is different than the Operational Data Spatial Reference WKID found on the GIS Web tab;

and

• the external service is NOT using a Mercator projection.

App Admin

Expose a service directory for Lucity Citizen Portal REST API

Determines whether a help page (directory) is included for the Lucity Citizen Portal REST API opening page. It is recommended that this setting be turned off in production environments because it exposes unnecessary information about the endpoints and access points available.

IT Admin

Expose a service directory for Lucity REST API

Determines whether a help page (directory) is included for the Lucity REST API opening page. It is recommended that this setting be turned off in production environments because it exposes unnecessary information about the endpoints and access points available.

IT Admin

Logon to use for anonymous REST API Access

Allows anonymous users to gain access to Lucity.

App Admin

Maximum records to return per request for rest api

Limits the amount of records in a filtered set. The higher the number, the more likely it is that web server performance will be affected.

IT Admin

Send Stack Traces to Client Apps on Errors from REST APIs

Provides detailed information through the REST API.

WARNING: THIS OPTION SHOULD ONLY BE SET TO TRUE FOR DEBUGGING PURPOSES, AS IT MAY REVEAL INFORMATION THAT HACKERS COULD USE TO ATTACK THE SYSTEM.

IT Admin

Url for Citizen Portal REST API (optional, rarely required)

Used by clients that have the Citizen Portal REST API installed behind a load-balancer that uses transport layer security (TLS), while the services behind the balancer use HTTP.

Alternately, this setting may also be used by clients whose URL differs from the standard http://servername.alias/LucityCitizenRestAPI.

IT Admin

URL for Internal REST API (required for internal web app)

The URL for the Internal REST API used by Lucity Web. This URL is required to run the application.

IT Admin

Url for REST API (optional, rarely required)

Used by clients that have the REST API installed behind a load-balancer that uses transport layer security (TLS), while the services behind the balancer use HTTP.

Alternately, this setting could also be used by clients whose URL differs from the standard http://servername.alias/LucityRestAPI.

IT Admin

Use an alternate coord system as the Default Coordinate System for Public REST calls

When enabled and the Default Public REST WKID is blank, the system assumes the incoming geographic information is using a Mercator projection. If the Default Public REST WKID is filled out, the system uses the specified WKID's projection.

If this option is set to FALSE, the system assumes that any incoming geographic information uses the Operational Data Spatial Reference WKID found on the GIS Web tab.

App Admin

Use Extensionless URL's (only supported in IIS7+)

Allows administrators to choose to omit the extension in the REST API URLs.

• For example, if the URL is http://restapi.gbams.net/Public/Work/Requests.svc/57481, setting this option to TRUE would allow users to use the following URL instead: http://restapi.gbams.net/Public/Work/Requests/57481. Note that the second URL does not include the ".svc" extension.

IT Admin