netexCloud - Web Services API | User web services | List users

List users

Obtains a list of users (always synchronously).

  • Url: /integration/ws/management/rest/users
  • Method: GET
  • Headers:
    • Accept: version/format header
    • X-Cloud-Auth-Token*: authorization header 
  • Parameters:
    • startIndex: index of the first user to list
    • count: maximum number of users to list
  • Responses:
    • 200: OK. Content:
      • status: generic status
      • location: generic location of the resultant resource, if any
      • message: generic success or error message, if any
      • responsePlatforms: response for every platform it concerns. Each one with the content:
        • status: status in the platform
        • location: location of the resultant resource in the platform, if any
        • message: success or error message in the platform, if any
  • Url example: http://acme.learningcloud.me/integration/ws/management/rest/users
  • Parameters example:
    • startIndex: 5
    • count: 3
  • Response example:

{

 "aboutMe": "Soy una niña a la que le gusta mucho vestir con una caperuza roja.",·

"email": "caperucita.roja@netex.com",

 "enabled": true,

 "extra": {},

 "id": "ff8081814fb1ee7f014fb1f319800000",

 "image": {

 "url": "/opt/cloud/netex/2015/09/09/b59236b6-9fef-4225-9e3d-ea999036e3e2.jpg"

 },

 "interests": "Llevar comida a mi abuelita, asustarme con el lobo feroz.",

 "language": "es",

 "location": null,

 "mobilePhone": "222222222",

 "name": "Caperucita",

 "officePhone": "111111111",

 "roles": {

 "social": ["user"],

 "training": ["user"],

 "management": ["user"]

 "play": ["user"]

 },

 "surname": "Roja",

 "timezone": "Europe/Paris",

 "username": "caperucita.roja"

 }, {

 "aboutMe": "I'm the title character and protagonist of the novel Oliver Twist by Charles Dickens. I was the first child protagonist in an English novel.",

 "email": "oliver.twist.pero@netex.com",

 "enabled": true,

 "extra": {},

 "id": "ff8081814fb1ee7f014fb20105ba0004",

 "image": {

 "url": "/opt/cloud//netex/2015/09/29/bfc5296d-e36f-4888-bfef-74643c220e50.jpg"

 },

 "interests": "I want some more",

 "language": "en",

 "location": "London",

 "mobilePhone": "222222222",

 "name": "Oliver",

 "officePhone": "111111111",

 "roles": {

 "management": ["user"],

 "social": ["user"],

 "training": ["user"]

 "play": ["user"]

 },

 "surname": "Twist",

 "timezone": "Europe/London",

 "username": "oliver.twist"

 }, {

 "aboutMe": "Hiperbólico andaluz, poeta de odas y madrigales, anciano, miserable y ciego.",

 "email": "max.estrella@netex.com",

 "enabled": true,

 "extra": {},

 "id": "ff8081814fb1ee7f014fb201ea240008",

 "image": {

 "url": "/opt/cloud/netex/2015/09/09/a6d831d1-e6f7-42bd-a8f8-30cb138796a3.jpg"

 },

 "interests": null,

 "language": "es",

 "location": "Madrid",

 "mobilePhone": "222222222",

 "name": "Max",

 "officePhone": "111111111",

 "roles": {

 "social": ["user"],

 "training": ["user"],

 "management": ["user"]

 "play": ["user"]

 },

 "surname": "Estrella",

 "timezone": "Europe/Paris",

 "username": "max.estrella"

}