Acquiring User Statistics

Arkance Systems Benelux

The GeoView Server REST API enables acquiring user statistics as ordered list of recordings uploaded by specific user. Accessing this method requires Read permissions.


Request API method URI definition:


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


Request HTTP URI parameters:


Parameter

Description

token

Access token (returned by this API method).

id

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

index

Start index of recordings to return. If omitted, assumes 0 as starting index.

count

Number of recordings to return, counting from starting index onward. If omitted, assumes all recordings.


Example HTTP request URI without starting index nor count values:


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


Example HTTP request URI returning recordings starting at index 10, and returning next 5 recordings (10-15):


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


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.


Response JSON structure for a single recording property:


Field

Description

firstname

User's first name.

lastname

User's last name.

company

User's organization.

count

Total number of recordings for specified user in data store.

recordings

List of recordings uploaded by user, sorted by creation date.


Resulting meta-data structure and example of JSON response:


{

  "firstname":"Demo",

  "lastname":"Demo",

  "company":"Demo Company",

  "count":500

  "recordings":

  [

     {

        "id":"345d30dd-de43-4d27-b61d-6d4bd93989d5",

        "metadata":

        [

           {

              "id":"col1row1",

              "title":"",

              "value":null,

              "text":"Station Denderleeuw, 9470 Denderleeuw, Belgium",

              "type":"String",

              "category":"",

              "editable":false,

              "visible":true,

              "constraints":null,

              "description":"",

              "view":0,"link":"",

              "multiline":false,

              "mandatory":false

           },{

              "id":"col1row2",

              "name":"col1row2",

              "title":"",

              "value":null,"text":"18-5-2015 13:18",

              ...

           }

        ]

     }

  ]

}


Description of a single resulting recording structure:


Name

Description

id

Image unique identifier.

metadata

Image meta-data structure.