General - Get lookup list

API Url

Get master data lookup list for departments, groups, employees, users, etc.

GET
http://localhost:16010/ProMarkREST/web/General/lookup/{table}

Permissions: user

Path parameters

FieldTypeDescription
tableString

Table mnemonic: "dept", "EmpGrp", "EmpList", "Usr", "division", etc.

Query parameters

FieldTypeDescription
dateoptionalDate

Date for time-sensitive restrictions.

dynamicValuesoptionalBoolean

false=Exclude dynamic values (@@DEPT_ID, etc). Default: true.

empIdoptionalString

Employee ID for context-specific lookups.

inclInactiveoptionalBoolean

true=Include inactive records. Default: false.

optionsoptionalString

Various options (parent id for cascading lookups).

Success 200

FieldTypeDescription
    lookupListObject[]

List of lookup values.

      bgColorString

Background color (HEX).

      descString

Description.

      fgColorString

Foreground color (HEX).

      idString

Unique identifier.

      inactiveBoolean

true if record is inactive.

      shortDescString

Short description.

      sortIdString

Right-aligned id for sorting.

Success example for departments:

HTTP/1.1 200 OK
{
"response": {
"data": {
"lookupList": [
{
"id": "PROD",
"sortId": "!!!!PROD",
"desc": "Production",
"shortDesc": "Prod",
"fgColor": "",
"bgColor": "",
"inactive": false
},
{
"id": "ADMIN",
"sortId": "!!!ADMIN",
"desc": "Administration",
"shortDesc": "Admin",
"fgColor": "",
"bgColor": "",
"inactive": false
}
]
},
"errorCode": 0,
"errorMessage": ""
}
}