netexCloud - Web Services API | User web services | Create user

Create user

Creates a user.

• Url: /integration/ws/management/rest/users
• Method: POST
• Headers:
  • Accept: version/format header 
  • X-Cloud-Auth-Token*: authorization header 
  • X-Cloud-Synchronization: synchronization header
• Parameters:
  • user*: user to create:
    • username: user's username
    • password: user's password
    • name: user's name
    • surname: user's surname
    • language: user's language code
    • timezone: user's timezone code
    • email: user's email
    • officePhone: user's office phone number
    • mobilePhone: user's mobile phone number
    • interests: user's interests
    • aboutMe: user's information
    • location: user's location
    • image: user's image. Can be specified as:
      
      • url: url in which the image is stored ({"url": "image_url"})
      • base64: image data ({"base64Image": "image_data", "mimeType": "image_mimeType"})
    • enabled: user's activation status
    • roles: user's roles. Specified as a map with the section as key and the role list as value. Allowed values are:
      
      • management: user, admin
      • training: user, trainer, admin
      • social: user, admin
      • play: user, admin
• 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/zuul/management/rest/users
• Response example (synchronous):

Header Location: http://acme.learningcloud.me/integration/ws/management/rest/users/ff808181556ee70e015571fe3d52000e

{

"location": null,

"message": "",

"responsePlatforms": {

"training": {

"location": null,

"message": null,

"status": 201

},

"social": {

"location": null,

"message": null,

"status": 201

},

"management": {

"location": null,

"message": null,

"status": 201

}

},

"status": 201 }

• Response example (asynchronous):
  

 {

"location": null,

"message": "",

"responsePlatforms": {

"training": {

"location": null,

"message": null,

"status": 202

},

"social": {

"location": null,

"message": null,

"status": 202

},

"management": {

"location": null,

"message": null,

"status": 201

}

},

"status": 201

}