Things to remember

1. OPTIONS

Use an OPTIONS request to see all operations currently available to you.

2. Additional Format-specific Parameters

Sometimes the Operations prompt returns Additional Format-specific Parameters as part of the response. This allows you to add specific parameters from the GeognoSIS XML interface as part of the request.

3. Expressions

Sometimes the Operations prompt returns SIS Expression as part of the response. This allows you to add an expression as part of the request. The technique is used to provide the majority of the spatial analysis.

4. GET, POST, PATCH and DELETE

The GeognoSIS HTTP API uses the four main request methods supported by REST interfaces:

GET

used to list and retrieve information from existing members. This can be any component of the SWD, overlay or feature.

POST

used to create new entries or members. This could be a new session, overlay, feature or attributes.

PATCH

used to replace or update existing members. This could be altering existing geometries, attributes, functions or analytical operations, such as themes or expressions on an SWD, overlay or feature.

DELETE

used to delete members. This could be features, attributes or analytical operations such as themes or expressions on an SWD, overlay or feature.

Structure

The HTTP API allows developers to access all components of the SWD and interrogate or alter the properties. It is advisable to understand the structure of the SWD and how this can be accessed using this API.

---