Basics

The Lucity REST API uses GET, PUT, POST, and DELETE to perform a variety of actions on resources in Lucity. A resource can be a work order, it can be a list of work orders, it can be a work order task, it can be a hydrant, etc.

• The URL for the web services is composed of the server where it is installed (potentially an alias instead) and the virtual directory (also can be aliased).

  http://server/virdir/

• Or for example:

  http://restapi.lucity.net/gbaMS/ (this is a live functioning link)

The entry page includes a list of all of the available root level resources. There are LOTS of them:

The list goes on.

Drilling into one of these resources will provide details on what can be done with that resource.

Drilling into the individual help requires authentication, so the browser will prompt for a user name and password. This is your Lucity user name and password. A small snippet of the available actions is shown here:

Drilling into an individual GET link will show what format it is expecting the data in. This may or may not be useful depending on the planned development platform. Developers using .NET should use the serialization objects we provide and not worry about manually writing XML or json.