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

Update multiple SA values by user ID

PUT /api/.../sysadmin/users/{id}/defaults

This method updates multiple user-scoped SA values in one request.

Request Information

Parameters
Name Type Required Description
id Integer Yes Unique id assigned to the user.
Request body

Contains a list of mnemonic/value pairs to update.

Item properties
Property Type Required Description
Mnemonic String Yes Admin attribute mnemonic to update.
Value String Yes New value for the mnemonic.
Example
application/json, text/json 
[
    {
        "Mnemonic": "TECHPROF_WA_RECENTRECS_PATRON",
        "Value": "15"
    },
    {
        "Mnemonic": "TECHPROF_WA_RECENTRECS_BIB",
        "Value": "20"
    }
]

Response Information

Returns one result per requested mnemonic.
Properties
Property Type Nullable Description
Item1 String No The mnemonic that was processed.
Item2 Boolean No True when the mnemonic was updated successfully; otherwise false.
Example
application/json, text/json 
[
    {
        "Item1": "TECHPROF_WA_RECENTRECS_PATRON",
        "Item2": true
    },
    {
        "Item1": "TECHPROF_WA_RECENTRECS_BIB",
        "Item2": false
    }
]

HTTP Response Codes

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

Note: This endpoint bypasses normal permission checks only for a restricted list of approved mnemonics. Any mnemonic not on the approved list is rejected.