UserService

Manage user information.

Symitar eDocs References: User Control, Creating a new user, Performing a User Inquiry, Reserved user numbers

Operations

getUserSelectFields

post

Retrieves information about a user with selected fields.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

/getUserSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/user/getUserSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 204

{
  "UserNumber": "1995",
  "SelectableFields": {
    "IncludeAllUserFields": false,
    "UserFields": {
      "Name": true
    }
  },
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}

200

Successful operation.

{
  "User": {}
}

getUserSelectFieldsFilterChildren

post

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

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

/getUserSelectFieldsFilterChildren

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/user/getUserSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 423

{
  "UserNumber": "1995",
  "SelectableFields": {
    "IncludeAllUserFields": false,
    "UserFields": {
      "Name": true
    },
    "UserTrackingSelectableFields": {
      "IncludeAllUserTrackingFields": false,
      "UserTrackingFields": {
        "CreationDate": true,
        "Locator": true,
        "UserNumber1": true
      }
    }
  },
  "ChildrenSearchFilter": {
    "UserTrackingFilter": {
      "Query": "UserNumber1=7"
    }
  },
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}

200

Successful operation.

{
  "User": {}
}

getActivityPagedListSelectFields

post

Retrieves a paged list of selected fields for activities.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

/getActivityPagedListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/user/getActivityPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 234

{
  "UserNumber": "1995",
  "SelectableFields": {
    "IncludeAllActivityFields": true
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 10
  },
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}

200

Successful operation.

{
  "Activity": [
    {}
  ],
  "Token": [
    "object Object"
  ]
}

searchActivityPagedSelectFields

post

Searches activities with pagination and selected fields.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

/searchActivityPagedSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/user/searchActivityPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 255

{
  "UserNumber": 1995,
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 10
  },
  "SelectableFields": {
    "IncludeAllActivityFields": true
  },
  "Query": "Console=1234",
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}

200

Successful operation.

{
  "Activity": [
    {}
  ],
  "Token": [
    "object Object"
  ]
}

getUserTrackingSelectFields

post

Retrieves information about user tracking with selected fields.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UserNumberintegerRequired

The user number for the activity.

Example: 1995

UserTrackingLocatorintegerRequired

The locator for user tracking.

Example: 1

Responses

200

Successful operation.

application/json

post

/getUserTrackingSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/user/getUserTrackingSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 286

{
  "UserNumber": "1995",
  "UserTrackingLocator": 1,
  "SelectableFields": {
    "IncludeAllUserTrackingFields": false,
    "UserTrackingFields": {
      "CreationDate": true,
      "Locator": true,
      "UserNumber1": true
    }
  },
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}

200

Successful operation.

{
  "UserTracking": {}
}

getUserTrackingPagedListSelectFields

post

Retrieves a paged list of selected fields for user tracking.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

/getUserTrackingPagedListSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/user/getUserTrackingPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 316

{
  "UserNumber": "1995",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 10
  },
  "SelectableFields": {
    "IncludeAllUserTrackingFields": false,
    "UserTrackingFields": {
      "CreationDate": true,
      "Locator": true,
      "UserNumber1": true
    }
  },
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}

200

Successful operation.

{
  "UserTracking": [
    {}
  ],
  "Token": [
    "object Object"
  ]
}

searchUserTrackingPagedSelectFields

post

Searches user tracking with pagination and selected fields.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

/searchUserTrackingPagedSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/user/searchUserTrackingPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 358

{
  "UserNumber": "1995",
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 10
  },
  "SearchFilter": {
    "Query": "UserNumber1<10"
  },
  "SelectableFields": {
    "IncludeAllUserTrackingFields": false,
    "UserTrackingFields": {
      "CreationDate": true,
      "Locator": true,
      "UserNumber1": true
    }
  },
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}

200

Successful operation.

{
  "UserTracking": [
    {}
  ],
  "Token": [
    "object Object"
  ]
}

updateUserByID

post

Updates user information based on ID.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

/updateUserByID

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/user/updateUserByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 174

{
  "UserNumber": 1995,
  "UserUpdatableFields": {
    "DeptName": "Engineering"
  },
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true
  }
}

updateUserTrackingByID

post

Updates user tracking information based on ID.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UserNumberintegerRequired

The user number for the activity.

Example: 1995

UserTrackingLocatorintegerRequired

The locator for user tracking.

Example: 1

Responses

200

Successful operation.

application/json

post

/updateUserTrackingByID

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/user/updateUserTrackingByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "UserTrackingLocator": 1,
  "UserTrackingUpdatableFields": {
    "UserNumber1": 9
  },
  "UserNumber": 1995,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true
  }
}

createUserTracking

post

Creates a new record for user tracking.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

/createUserTracking

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/user/createUserTracking HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 166

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "UserNumber": 1995,
  "UserTrackingFields": {},
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UserTrackingLocator": 1,
  "customFields": {
    "appId": "glaci"
  }
}

deleteUserTracking

post

Deletes a record for user tracking.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UserNumberintegerRequired

The user number for the activity.

Example: 1995

UserTrackingLocatorintegerRequired

The locator for user tracking.

Responses

200

Successful operation.

application/json

post

/deleteUserTracking

HTTPcURLJavaScriptPython

POST /nexum/627/persistent/user/deleteUserTracking HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 149

{
  "UserNumber": 1995,
  "UserTrackingLocator": 1,
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}

200

Successful operation.

{
  "nxAttributes": {}
}