request
  • dataSet
    • computeDataSet
    • getDataSetPage
  • quiz
    • addQuiz
    • getQuiz
    • getQuizAttribute
    • getQuizSet
  • result
    • getResults
  • user
    • getUser
    • getUserAttribute
    • getUserGroupSet
    • getUserSet
model
  • dataSet
    • DataSetPage
  • exception
    • JllmAPIException
    • subtypes
      • BadParameter
      • InternalServerError
      • MissingParameter
      • UnauthorizedOperation
      • UnexpectedServerResponse
      • UnsupportedRequest
  • item
    • Item
    • ItemAttribute
    • subtypes
      • ComputedResult
      • Quiz
      • User
      • UserGroup
  • question
    • Question
    • subtypes
      • FreeAnswerNumber
      • FreeAnswerText
      • MCQOneGoodAnswer
      • MCQSeveralGoodAnswers
      • TrueFalse

getUserAttribute

Returns an attribute of the user with the specified identifier.

Authentication

Authentication required : an API access token must be provided in the URL query string.

Request

Bold red : required parameter, Bold orange : at least one of parameters required, black : optional parameter.

HTTP Request

GET https://api.jelevelamain.fr/getUserAttribute?apiKey=API_KEY&accessToken=ACCESS_TOKEN

Parameters

Each parameter is URL-encoded and added to the URL query string.

userId Type : string
The identifier of the user.
attributeName Type : boolean
The name of:
  • A field in User (requires the appropriate permissions).
  • A computed property : "popularity" or "influence" (no requirement).

Response

An ItemAttribute modeling the requested User attribute on success :

{
    "itemType" : "user"
    "itemId" : string
    "itemName" : string
    "itemValue" : value
}
A JllmAPIException on error. In particular :
  • A BadParameterException if no user is found with the specified identifier.
  • A UnauthorizedOperationException if the requesting user does not have the appropriate permission(s) to access to the specified attribute of the user with the specified identifier.

Try it !

You can test this request on live data and see the API response by filling the form below.

Bold red : required parameter, Bold orange : at least one of parameters required, black : optional parameter.

userId
attributeName
The button "Execute as authenticated user" is available to connected users only. To connect, click on the "Login" button at the right top of the page.