REST API

The REST API tab allows administrators to set up the Lucity REST Public and Internal Webservices API.

To make changes to the REST API settings, click in one of the Value fields and begin typing. Click Save when finished.

Field

Function

security Special 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 3rd party app developers to instruct the REST API to automatically move an invalid address made on a citizen request to the general location field (if empty). Helps when citizens can enter an address which may not validate. 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:

and

  • the external services is NOT using a Mercator projection.

App 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

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

Used by clients that have a unique system where the Citizen REST API is installed behind a load balancer that uses SSL while the services behind the balancer uses http.

Alternately it could 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 the internal web app. This is required to run Lucity Web.

 

Url for REST API (optional, rarely required)

Used by clients that have a unique system where the REST API is installed behind a load balancer that uses SSL while the services behind the balancer uses http.

Alternately it could 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

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

If this option is set to true 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.

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

Use ISO 8601 UTC Date Times instead of ISO 8601 Local Date Times for Citizen REST API

Allows administrators to choose to use a UTC date/time format instead of a local date/time format for the citizen rest api.

  • UTC Date/Time - 2015-03-14T:12:00Z
  • Local Date/Time - 2015-03-14T:07:00

App Admin

Use ISO 8601 UTC Date Times instead of ISO 8601 Local Date Times for Internal REST API

Allows administrators to choose to use a UTC date/time format instead of a local date/time format for the internal rest api.

  • UTC Date/Time - 2015-03-14T:12:00Z
  • Local Date/Time - 2015-03-14T:07:00

App Admin