UserService

Manage user information.

Symitar eDocs References: , , ,

Operations

PreviousUserManagementService NextWireService

Last updated 10 months ago

Was this helpful?

getUser

post

Retrieves information about a user.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/getUser HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 142

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

200

Successful operation.

{
  "User": {
    "AccountVerification": "0",
    "ActivPurgeDate": "2005-10-31",
    "ActiveMode": "0",
    "AssignedBranch": "0",
    "CasTrackingCode": "0",
    "CheckTapeCols": "3",
    "ConfigurationGroup": "0",
    "DisplayItem": [
      {
        "DisplayItem": "0",
        "EntryId": "1"
      },
      {
        "DisplayItem": "0",
        "EntryId": "2"
      }
    ],
    "Functions": [
      {
        "EntryId": "1",
        "Functions": "0"
      },
      {
        "EntryId": "2",
        "Functions": "0"
      }
    ],
    "InvalidPasswordAttemptCount": "0",
    "InvalidPinAttemptCount": "0",
    "LastCheckSeq": "0",
    "LastConsole": "9051",
    "LastInvalidPasswordTime": "0",
    "LastInvalidPinTime": "0",
    "LastLogonDate": "2023-08-19",
    "LastLogonTime": "841",
    "Name": "NAAS PLAYGROUND",
    "Number": "1995",
    "OnlineAccess": "0",
    "PasswordChgDate": "2010-04-25",
    "PasswordMode": "0",
    "PinActiveMode": "1",
    "PreviousLogOnTime": "0",
    "PreviousPasswordMode": [
      {
        "EntryId": "1",
        "PreviousPasswordMode": "0"
      },
      {
        "EntryId": "2",
        "PreviousPasswordMode": "0"
      }
    ],
    "PriorDayTapeTotal": [
      {
        "EntryId": "1",
        "PriorDayTapeTotal": "0.00"
      },
      {
        "EntryId": "2",
        "PriorDayTapeTotal": "0.00"
      }
    ],
    "Privilege": [
      {
        "EntryId": "1",
        "Privilege": "true"
      },
      {
        "EntryId": "2",
        "Privilege": "true"
      }
    ],
    "PrivilegeGroup": [
      {
        "EntryId": "1",
        "PrivilegeGroup": "0"
      },
      {
        "EntryId": "2",
        "PrivilegeGroup": "0"
      }
    ],
    "PrtCheckIndex": "1",
    "RecordChangeDate": "2010-04-25",
    "SecurityAmount": [
      {
        "EntryId": "1",
        "SecurityAmount": "0.00"
      },
      {
        "EntryId": "2",
        "SecurityAmount": "0.00"
      }
    ],
    "SecurityCode": [
      {
        "EntryId": "1",
        "SecurityCode": "0"
      },
      {
        "EntryId": "2",
        "SecurityCode": "0"
      }
    ],
    "TapeTotal": [
      {
        "EntryId": "1",
        "TapeTotal": "0.00"
      },
      {
        "EntryId": "2",
        "TapeTotal": "0.00"
      }
    ],
    "TempPasswordExpirationTime": "0",
    "TemporaryPassword": "0",
    "TemporaryPin": "0",
    "Type": "0",
    "WorkList": [
      {
        "EntryId": "1",
        "WorkList": "0"
      },
      {
        "EntryId": "2",
        "WorkList": "0"
      }
    ]
  },
  "customFields": {
    "appId": "glaci"
  }
}

getUserSelectFields

post

Retrieves information about a user with selected fields.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/getUserSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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": {
    "Name": "NAAS PLAYGROUND"
  },
  "customFields": {
    "appId": "glaci"
  }
}

getUserSelectFieldsFilterChildren

post

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

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/getUserSelectFieldsFilterChildren HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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": {
    "Name": "NAAS PLAYGROUND",
    "UserTrackingList": {
      "UserTracking": {
        "CreationDate": "2010-04-25",
        "Locator": "1",
        "UserNumber1": "7"
      },
      "hasReachedMaximumListSize": "false"
    }
  },
  "customFields": {
    "appId": "glaci"
  }
}

getActivityPagedList

post

Retrieves a paged list of activities.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/getActivityPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 179

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

200

Successful operation.

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

getActivityListSelectFields

post

Retrieves a list of selected fields for activities.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/getActivityListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 180

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

200

Successful operation.

{
  "ActivityList": {}
}

searchActivitySelectFields

post

Searches activities with selected fields.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/searchActivitySelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 218

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

200

Successful operation.

{
  "ActivityList": {}
}

getActivityPagedListSelectFields

post

Retrieves a paged list of selected fields for activities.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/getActivityPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

QuerystringRequired

The filtering query string.

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/searchActivityPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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"
  ]
}

getUserTracking

post

Retrieves information about user tracking.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

UserTrackingLocatorintegerRequired

The locator for user tracking.

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/getUserTracking HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 151

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

200

Successful operation.

{
  "UserTracking": {
    "CreationDate": "2010-04-25",
    "CreationTime": "1047",
    "FmLastDate": "2010-04-25",
    "IdType": "0",
    "Locator": "1",
    "RecordChangeDate": "2010-04-25",
    "TrackingCode": "0",
    "Type": "30",
    "UserAmount1": "0.00",
    "UserCode1": "0",
    "UserId": "1999",
    "UserNumber1": "7",
    "UserRate1": "0.000"
  },
  "customFields": {
    "appId": "glaci"
  }
}

getUserTrackingSelectFields

post

Retrieves information about user tracking with selected fields.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

UserTrackingLocatorintegerRequired

The locator for user tracking.

Example: 1

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/getUserTrackingSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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": {
    "CreationDate": "2010-04-25",
    "Locator": "1",
    "UserNumber1": "7"
  },
  "customFields": {
    "appId": "glaci"
  }
}

getUserTrackingPagedList

post

Retrieves a paged list of user tracking.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/getUserTrackingPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 181

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

200

Successful operation.

{
  "UserTracking": [
    {
      "CreationDate": "2010-04-25",
      "CreationTime": "1111",
      "FmLastDate": "2010-04-25",
      "IdType": "0",
      "Locator": "2",
      "RecordChangeDate": "2010-04-25",
      "TrackingCode": "0",
      "Type": "30",
      "UserAmount1": "0.00",
      "UserCode1": "0",
      "UserId": "1999",
      "UserNumber1": "8",
      "UserRate1": "0.000"
    },
    {
      "CreationDate": "2010-04-25",
      "CreationTime": "1047",
      "FmLastDate": "2010-04-25",
      "IdType": "0",
      "Locator": "1",
      "RecordChangeDate": "2010-04-25",
      "TrackingCode": "0",
      "Type": "30",
      "UserAmount1": "0.00",
      "UserCode1": "0",
      "UserId": "1999",
      "UserNumber1": "7",
      "UserRate1": "0.000"
    }
  ],
  "customFields": {
    "appId": "glaci"
  }
}

getUserTrackingListSelectFields

post

Retrieves a list of selected fields for user tracking.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/getUserTrackingListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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": {
    "CreationDate": "2010-04-25",
    "Locator": "1",
    "UserNumber1": "7"
  },
  "customFields": {
    "appId": "glaci"
  }
}

searchUserTrackingSelectFields

post

Searches user tracking with selected fields.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/searchUserTrackingSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 304

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

200

Successful operation.

{
  "UserTrackingList": {
    "UserTracking": [
      {
        "CreationDate": "2010-04-25",
        "Locator": "2",
        "UserNumber1": "8"
      },
      {
        "CreationDate": "2010-04-25",
        "Locator": "1",
        "UserNumber1": "7"
      }
    ],
    "hasReachedMaximumListSize": "false"
  },
  "customFields": {
    "appId": "glaci"
  }
}

getUserTrackingPagedListSelectFields

post

Retrieves a paged list of selected fields for user tracking.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/getUserTrackingPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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.

{
  "UserTrackingList": {
    "UserTracking": [
      {
        "CreationDate": "2010-04-25",
        "Locator": "2",
        "UserNumber1": "8"
      },
      {
        "CreationDate": "2010-04-25",
        "Locator": "1",
        "UserNumber1": "7"
      }
    ],
    "hasReachedMaximumListSize": "false"
  },
  "customFields": {
    "appId": "glaci"
  }
}

searchUserTrackingPagedSelectFields

post

Searches user tracking with pagination and selected fields.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

QuerystringOptional

The filtering query string.

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/searchUserTrackingPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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": [
    {
      "CreationDate": "2010-04-25",
      "Locator": "2",
      "UserNumber1": "8"
    },
    {
      "CreationDate": "2010-04-25",
      "Locator": "1",
      "UserNumber1": "7"
    }
  ],
  "customFields": {
    "appId": "glaci"
  }
}

updateUserByID

post

Updates user information based on ID.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/updateUserByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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

Body

UserTrackingLocatorintegerRequired

The locator for user tracking.

Example: 1

UserNumberintegerRequired

The user number for the activity.

Responses

200

Successful operation.

application/json

post

POST /nexum/627/2022.01/user/updateUserTrackingByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer JWT
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

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

Responses

200

Successful operation.

application/json

post

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

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

200

Successful operation.

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

deleteUserTracking

post

Deletes a record for user tracking.

Authorizations

Body

UserNumberintegerRequired

The user number for the activity.

Example: 1995

UserTrackingLocatorintegerRequired

The locator for user tracking.

Responses

200

Successful operation.

application/json

post

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

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

200

Successful operation.

{
  "nxAttributes": {}
}