Acquiring User Properties

GeoCrew

The GeoView Server REST API enables acquiring specific user's properties. Accessing this method requires either Read permissions for currently logged-in user, or Administrator permissions for any user.


Request API method URI definition:


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


Request HTTP URI parameters:


Parameter

Description

token

Access token (returned by this API method).

id

User identifier (returned by i.e. this API method).


Example HTTP request URI:


HTTP GET http://api.geoview.be/geoservice/v1/users/6e39547d-aed2-4e60-9e01-5d5c0921953?token=3dc718f2-ab20-4f41-86e1-72abcc1810c1


Possible resulting HTTP status codes:


Value

Description

200

API request succeeded and result(s) were returned.

400

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

401

Supplied API request access token not valid.


Resulting meta-data structure and example of JSON response:


[

  {

     "category":"User",

     "constraints":null,

     "editable":false,

     "id":"username",

     "text":"demo",

     "title":"User name",

     "type":"String",

     "value":"demo",

     "visible":true

     "view":0

  },{

     ...

  }

]


Description of possible resulting user properties:


Name

Description

uid

Unique user's identifier.

username

Unique user's name in a data store (i.e. returned by this API method).

firstname

User's first name. This value is mandatory.

lastname

User's last name. This value is mandatory.

email

User's email. This value is mandatory.

company

User's organization.

locale

Language and localization used in UI. See property constraints for more info.

map

User's default background map identifier.

linearunits

Linear units used in UI. See property constraints for more info.

angularunits

Angular units used in UI. See property constraints for more info.

srs

Spatial reference system.

permissions

User credentials bit-flag value (1=Read, 2=Write, 4=Administrator).