Skip to content
NexumAPI Docs

UserService⁠

Operations⁠

getActivityPagedListSelectFields⁠

POST

Retrieves a paged 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
TokenstringoptionalThe tokenized value for the activity.
POST/nexum/{sym}/2022.01/user/getActivityPagedListSelectFields
POST /nexum/627/2022.01/user/getActivityPagedListSelectFields 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
  },
  "SelectableFields": {
    "IncludeAllActivityFields": false,
    "ActivityFields": {
      "UserNumber": true,
      "Date": true,
      "Time": true,
      "Branch": true,
      "Console": true,
      "Session": true,
      "HelpCode": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

searchActivityPagedSelectFields⁠

POST

Searches activities with pagination and 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.
QuerystringrequiredThe filtering query string.
Path Parameters
symstringrequired
Sym number
Responses
TokenstringoptionalThe tokenized value for the activity.
POST/nexum/{sym}/2022.01/user/searchActivityPagedSelectFields
POST /nexum/627/2022.01/user/searchActivityPagedSelectFields 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,
  "Query": "string",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 0,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "IncludeAllActivityFields": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getUserTracking⁠

POST

Retrieves information about user tracking.

Authorizations
Authorizationstringrequired

Authenticate with your JWT.

Bearer YOUR_TOKEN

For setup help, see the authentication guide.

Bodyapplication/json
UserNumberintegerrequiredThe user number for the activity.
UserTrackingLocatorintegerrequiredThe locator for user tracking.
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/user/getUserTracking
POST /nexum/627/2022.01/user/getUserTracking 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,
  "UserTrackingLocator": 0,
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getUserTrackingSelectFields⁠

POST

Retrieves information about user tracking 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.
UserTrackingLocatorintegerrequiredThe locator for user tracking.
Path Parameters
symstringrequired
Sym number
Responses
POST/nexum/{sym}/2022.01/user/getUserTrackingSelectFields
POST /nexum/627/2022.01/user/getUserTrackingSelectFields 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,
  "UserTrackingLocator": 0,
  "SelectableFields": {
    "IncludeAllUserTrackingFields": false,
    "UserTrackingFields": {
      "Locator": true,
      "TrackingCode": true,
      "UserChar1": true,
      "UserCode1": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}

getUserTrackingPagedList⁠

POST

Retrieves a paged list of user tracking.

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/getUserTrackingPagedList
POST /nexum/627/2022.01/user/getUserTrackingPagedList 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"
    }
  }
}

getUserTrackingListSelectFields⁠

POST

Retrieves a list of selected fields for user tracking.

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/getUserTrackingListSelectFields
POST /nexum/627/2022.01/user/getUserTrackingListSelectFields 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": {
    "IncludeAllUserTrackingFields": false,
    "UserTrackingFields": {
      "Locator": true,
      "Type": true,
      "CreationDate": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "string"
    }
  }
}