SA Value By User

Get SA value by user ID

GET /api/.../sysadmin/users/{id}/values/{mnemonic}

This method retrieves a specified SA value by user ID.

Response Information

Returns the SA value defined by the user
Properties
Property Type Nullable Description
Value String No User preferred value saved for the attribute.
Example
application/json, text/json 
{
    43067
}

HTTP Response Codes

Code Description
200 OK. Success
400 Bad request. Invalid user ID or mnemonic
404 Not Found. User ID is not found

Update SA value by user ID

PUT /api/.../sysadmin/users/{id}/values/{mnemonic}

Update SA value by user ID.

Request Information

Parameters
Name Type Required Description
id Integer Yes Unique id assigned to the user
mnemonic String Yes Admin attribute identifier
Request body

Contains a string representation of the new value for the specified mnemonic.

Note: For Boolean values, provide "Yes" or "No". For integer values, provide a string representation similar to "15".

Example
application/json, text/json 
"Attribute Value"

HTTP Response Codes

Code Description
200 OK. Success
400 Bad request. Examples:
"Mnemonic 'PSPARM_RECEIPTNOTEXYZ' not a valid admin attribute"
"Invalid domain for attribute 'PSPARM_RECEIPTNOTE'"
404 Not Found. User ID not found.

Permissions needed to perform this action:

AccessAdministration_Allow
StaffMembers_Access
StaffMembers_Modify

Note: Typically both permissions are required except when the logged in user is attempting to modify their own SA value for the following attributes:

  • PSPROFDEFCIRCCKIN
  • TECHPROF_WA_DEFAULT_ITEMTEMPL
  • TECHPROF_WA_RECENTRECS_PATRON
  • TECHPROF_WA_RECENTRECS_BIB
  • TECHPROF_WA_RECENTRECS_ITEM
  • TECHPROF_WA_REQMGRHLD_FILTER
  • TECHPROF_WA_REQMGRILL_FILTER
  • TECHPROF_WA_REQMGRINN_FILTER
  • WA_CATPROFDEFAULTITEMOPENVIEW