LoginResponse Data Type

Response to a login request

Properties
name data type constraints description
sid string   Get the session id
user User   Get the user
messages array of Message   Messages contained in the response (which should be shown to the user)
responseInfo ResponseInfo  
inBackground boolean required boolean Whether the job was pushed into the background.

Example

{
  "sid" : "...",
  "user" : {
    "id" : 12345,
    "firstName" : "...",
    "lastName" : "...",
    "description" : "...",
    "email" : "...",
    "groups" : [ {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "children" : [ { }, { } ]
    }, {
      "id" : 12345,
      "name" : "...",
      "description" : "...",
      "children" : [ { }, { } ]
    } ],
    "login" : "...",
    "password" : "..."
  },
  "messages" : [ { }, { } ],
  "responseInfo" : {
    "responseCode" : "OK",
    "responseMessage" : "...",
    "property" : "..."
  },
  "inBackground" : true
}