Skip to content
NexumAPI Docs

UserService⁠

Operations⁠

getUser⁠

POST

Retrieves information about a user.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/user/getUser
POST /nexum/627/2022.01/user/getUser HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getUserSelectFields⁠

POST

Retrieves information about a user with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/user/getUserSelectFields
POST /nexum/627/2022.01/user/getUserSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "SelectableFields": {
    "IncludeAllUserFields": false,
    "UserFields": {
      "Number": true,
      "Name": true,
      "Type": true,
      "ActiveMode": true,
      "LastLogonDate": true,
      "LastLogonTime": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getUserSelectFieldsFilterChildren⁠

POST

Retrieves information about a user with selected fields and filters children.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/user/getUserSelectFieldsFilterChildren
POST /nexum/627/2022.01/user/getUserSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "SelectableFields": {
    "IncludeAllUserFields": false,
    "UserFields": {
      "Number": true,
      "Name": true,
      "Type": true,
      "ActiveMode": true
    },
    "ActivitySelectableFields": {
      "IncludeAllActivityFields": false,
      "ActivityFields": {
        "UserNumber": true,
        "Date": true,
        "Time": true,
        "Console": true
      }
    },
    "UserTrackingSelectableFields": {
      "IncludeAllUserTrackingFields": false,
      "UserTrackingFields": {
        "Locator": true,
        "Type": true,
        "CreationDate": true
      }
    }
  },
  "ChildrenSearchFilter": {
    "ActivityFilter": {
      "Query": "string"
    },
    "UserTrackingFilter": {
      "Query": "string"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getActivityPagedList⁠

POST

Retrieves a paged list of activities.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
Responses
TokenstringoptionalThe tokenized value for the activity.
POST/nexum/{sym}/2022.01/user/getActivityPagedList
POST /nexum/627/2022.01/user/getActivityPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getActivityListSelectFields⁠

POST

Retrieves a list of selected fields for activities.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/user/getActivityListSelectFields
POST /nexum/627/2022.01/user/getActivityListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "SelectableFields": {
    "IncludeAllActivityFields": false,
    "ActivityFields": {
      "UserNumber": true,
      "Date": true,
      "Time": true,
      "Console": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchActivitySelectFields⁠

POST

Searches activities with selected fields.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
UserNumberintegerrequiredThe user number for the activity.
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/user/searchActivitySelectFields
POST /nexum/627/2022.01/user/searchActivitySelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Accept: application/json
Authorization: Bearer YOUR_JWT
Content-Type: application/json

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 0,
  "SearchFilter": {
    "Query": "string"
  },
  "SelectableFields": {
    "IncludeAllActivityFields": false,
    "ActivityFields": {
      "UserNumber": true,
      "Date": true,
      "Time": true,
      "Console": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}