SA Value By Organization

Get SA value by organization ID

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

This method retrieves a specified SA value by organization ID.

Response Information

Returns the SA value defined by the organization along with other AdminAttribute properties.
Properties
Property Type Nullable Description
AttrID Int No Internal system administration attribute identifier.
AttrTypeID Int No See "Reference of Polaris enum value" below.
AttrDesc String No Description of what this attribute controls.
ControlFlags Int No Determines where this attribute may be used. System, Library, Branch, Workstation and user.
Mnemonic String No Value used to retrieve this attribute.
MaxLength Int Yes Maximum length of attribute. May not be used for all attribute types.
Value String No
AttrTypeIDpossible Value
Boolean = 2"true" or "false"
Currency = 4string value converted from a number with decimal places, "2.55" for example
other typesstring value saved in the database
AttrClassID Int No Undefined = 1, Profile = 2, Parameter = 3 or Preference = 5
Example
application/json, text/json 
{
    "AttrID": 2112,
    "AttrTypeID": 2,
    "AttrDesc": "Distributed waives",
    "ControlFlags": 7,
    "Mnemonic": "PSPARM_DISTRIBUTED_WAIVES",
    "MaxLength": 0,
    "Value": "true",
    "AttrClassID": 3
}

{
    "AttrID": 1365,
    "AttrTypeID": 4,
    "AttrDesc": "CA: Minimum balance",
    "ControlFlags": 7,
    "Mnemonic": "PSPARMCOLAGYMINBALANCE",
    "MaxLength": 0,
    "Value": "100.00",
    "AttrClassID": 1
}

Get multiple SA values by organization ID

GET /api/.../sysadmin/organizations/{id}/values?mnemonic={m1,m2,m3}

This method retrieves a specified SA values by organization ID.

Response Information

Returns list of SA value defined by the organization along with other AdminAttribute properties.
Properties
Property Type Nullable Description
AttrID Int No Internal system administration attribute identifier.
AttrTypeID Int No See "Reference of Polaris enum value" below.
AttrDesc String No Description of what this attribute controls.
ControlFlags Int No Determines where this attribute may be used. System, Library, Branch, Workstation and user.
Mnemonic String No Value used to retrieve this attribute.
MaxLength Int Yes Maximum length of attribute. May not be used for all attribute types.
Value String No
AttrTypeIDpossible Value
Boolean = 2"true" or "false"
Currency = 4string value converted from a number with decimal places, "2.55" for example
other typesstring value saved in the database
AttrClassID Int No Undefined = 1, Profile = 2, Parameter = 3 or Preference = 5
Example
application/json, text/json 
    
[
    {
        "AttrID":3271,
        "AttrTypeID":2,
        "AttrDesc":"Web App: Suppress View: Messages",
        "ControlFlags":7,
        "Mnemonic":"TECHPROF_WA_SUPRESVIEW_MSG",
        "MaxLength":0,
        "Value":"true",
        "AttrClassID":2
    },
    {
        "AttrID":3270,
        "AttrTypeID":2,
        "AttrDesc":"Web App: Suppress View: Associations",
        "ControlFlags":7,
        "Mnemonic":"TECHPROF_WA_SUPRESVIEW_ASSOC",
        "MaxLength":0,
        "Value":"true",
        "AttrClassID":2
    },
    {
        "AttrID":3272,
        "AttrTypeID":2,
        "AttrDesc":"Web App: Suppress View: Notes",
        "ControlFlags":7,
        "Mnemonic":"TECHPROF_WA_SUPRESVIEW_NOTES",
        "MaxLength":0,
        "Value":"false",
        "AttrClassID":2
    },
    {
        "AttrID":1818,
        "AttrTypeID":2,
        "AttrDesc":"Reading history enabled",
        "ControlFlags":7,
        "Mnemonic":"PSPARM_READHIST_ENABLED",
        "MaxLength":0,
        "Value":"true",
        "AttrClassID":3
    },
    {
        "AttrID":1458,"AttrTypeID":2,
        "AttrDesc":"ILL: Enable staff requests",
        "ControlFlags":7,
        "Mnemonic":"PSPARMILLTCENABLED",
        "MaxLength":0,
        "Value":"false",
        "AttrClassID":1
    },
    {
        "AttrID":1448,
        "AttrTypeID":2,
        "AttrDesc":"ILL: Enable PAC requests",
        "ControlFlags":7,
        "Mnemonic":"PSPARMILLPACENABLED",
        "MaxLength":0,
        "Value":"false","
        AttrClassID":1
    }
]

Reference of Polaris enum values:

enum AdminAttributeTypes
{
    Read_only = 0,
    String = 1,
    Boolean = 2,
    Integer = 3,
    Currency = 4,
    Database_ID = 5,
    COLORREF = 7,
    Real = 8,
    Percent = 9,
    Scrambled = 10,
    Dialog = 11,
    Path = 12,
    Days = 13,
    Language_Strings = 14
}

HTTP Response Codes

Code Description
200 OK. Success
400 Bad request. Invalid organization ID or mnemonic
404 Not Fount. Organization ID is not found

Update SA value by organization ID

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

Update SA value by organization ID.

Request Information

Parameters
Name Type Required Description
id Integer Yes Unique id assigned to the organization
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'"
"OrganizationID 1 does not exist in the 'Branch' domain"
404 Not Found. Organization ID not found.

Permissions needed to perform this action:

AccessAdministration_Allow
System_Access (if accessing system level attributes)
Libraries_Access (if accessing library level attributes)
Branches_Access (if accessing branch level attributes)
System_Modify (if modifying system level attributes)
Libraries_Modify (if modifying library level attributes)
Branches_Modify (if modifying branch level attributes)