Manage user information.
Operations
searchUserTrackingPagedSelectFields
POST
Searches user tracking with pagination and selected fields.
Authorizations
AuthorizationstringrequiredAuthenticate with your JWT.
Bearer YOUR_TOKENFor setup help, see the authentication guide.
Bodyapplication/json
UserNumberintegerrequiredThe user number for the activity.Loading fields…
Path Parameters
symstringrequired- Sym number
Responses
TokenstringoptionalThe tokenized value for the activity.Loading fields…
POST
/nexum/{sym}/persistent/user/searchUserTrackingPagedSelectFieldsPOST /nexum/627/persistent/user/searchUserTrackingPagedSelectFields 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"
},
"PagingRequestContext": {
"NumberOfRecordsToReturn": 0,
"NumberOfRecordsToSkip": 0
},
"SelectableFields": {
"IncludeAllUserTrackingFields": true
},
"nxAttributes": {
"customFields": {
"appId": "string"
}
}
}updateUserByID
POST
Updates user information based on ID.
Authorizations
AuthorizationstringrequiredAuthenticate with your JWT.
Bearer YOUR_TOKENFor setup help, see the authentication guide.
Bodyapplication/json
UserNumberintegerrequiredThe user number for the activity.Loading fields…
Path Parameters
symstringrequired- Sym number
Responses
Loading fields…
POST
/nexum/{sym}/persistent/user/updateUserByIDPOST /nexum/627/persistent/user/updateUserByID 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,
"UserFields": {
"Location": "string"
},
"nxAttributes": {
"customFields": {
"appId": "string"
}
}
}updateUserTrackingByID
POST
Updates user tracking information based on ID.
Authorizations
AuthorizationstringrequiredAuthenticate with your JWT.
Bearer YOUR_TOKENFor setup help, see the authentication guide.
Bodyapplication/json
UserNumberintegerrequiredThe user number for the activity.UserTrackingLocatorintegerrequiredThe locator for user tracking.Loading fields…
Path Parameters
symstringrequired- Sym number
Responses
Loading fields…
POST
/nexum/{sym}/persistent/user/updateUserTrackingByIDPOST /nexum/627/persistent/user/updateUserTrackingByID 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,
"UserTrackingFields": {
"UserChar1": "string",
"UserCode1": 0
},
"nxAttributes": {
"customFields": {
"appId": "string"
}
}
}createUserTracking
POST
Creates a new record for user tracking.
Authorizations
AuthorizationstringrequiredAuthenticate with your JWT.
Bearer YOUR_TOKENFor setup help, see the authentication guide.
Bodyapplication/json
UserNumberintegerrequiredThe user number for the activity.Loading fields…
Path Parameters
symstringrequired- Sym number
Responses
UserTrackingLocatorintegeroptionalThe locator for user tracking.Loading fields…
POST
/nexum/{sym}/persistent/user/createUserTrackingPOST /nexum/627/persistent/user/createUserTracking 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,
"UserTrackingFields": {
"TrackingCode": 0,
"UserChar1": "string",
"UserCode1": 0
},
"nxAttributes": {
"customFields": {
"appId": "string"
}
}
}deleteUserTracking
POST
Deletes a record for user tracking.
Authorizations
AuthorizationstringrequiredAuthenticate with your JWT.
Bearer YOUR_TOKENFor setup help, see the authentication guide.
Bodyapplication/json
UserNumberintegerrequiredThe user number for the activity.UserTrackingLocatorintegerrequiredThe locator for user tracking.Loading fields…
Path Parameters
symstringrequired- Sym number
Responses
nxAttributesobjectoptionalThe custom object for NexumAPI response attributes.Loading fields…
POST
/nexum/{sym}/persistent/user/deleteUserTrackingPOST /nexum/627/persistent/user/deleteUserTracking 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"
}
}
}