Acquiring List of All Users

GeoCrew

The GeoView Server REST API enables acquiring list of all users found in the data store. Accessing this method requires Administrator permissions.


Request API method URI definition:


HTTP GET http://api.geoview.be/geoservice/v1/users


Request HTTP URI parameters:


Parameter

Description

token

Access token (returned by this API method).


Example HTTP request URI:


HTTP GET http://api.geoview.be/geoservice/v1/users?token=3dc718f2-ab20-4f41-86e1-72abcc1810c1


Possible resulting HTTP status codes:


Value

Description

200

API request succeeded and result(s) were returned.

204

API request succeeded but query didn't produce any results.

400

API request failed due to wrong parameter value(s).

401

Supplied API request access token not valid.


Response JSON structure for a single recording property:


Field

Description

uid

User's unique identifier (GUID).

pid

User's parent object's identifier.

username

User name.

firstname

User's first name.

lastname

User's last name.

company

User's organization.

email

User's e-mail address.

loggedin

True if user is currently logged-in, False otherwise.


Example of JSON response (array of user records):


[

  {

     "uid":"3dc718f2-ab20-4f41-86e1-72abcc1810c1",

     "pid":"",

     "username":"jsmith",

     "firstname":"John",

     "lastname":"Smith",

     "company":"Demo Company",

     "email":"smith@demo.com",

  },

  {

     ...

  }

]