General - Get lookup list

API Url

Use it for loading master data for all kind of tables.

GET

http://localhost:16010/ProMarkREST/rest/General/lookup/{table}

Permissions: user

Path parameters

Field	Type	Description
table	String	Table mnemonic. Can be "emplist", "dept", "group", "division", "usr" etc.

Query parameters

Field	Type	Description
date`optional`	Date	Date for which lookup is executed. Used for restrictions. Do not use together with "options".
dynamicValues`optional`	Boolean	If false, the dynamic values will not be included. The default value is true.
empId`optional`	String	List of Employee ids (comma separated) in connection with the lookup. Do not use together with "options".
inclInactive`optional`	Boolean	true=Include also inactive records, false=Only active records.
options`optional`	String	Various options with different meaning for each table mnemonic. Can also be used for cascading lookup values, thus holding the parent id.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
lookupList	Object[]	List of table values.
bgColor	String	Background color. If not set then empty.
desc	String	Description.
fgColor	String	Foreground color. If not set then empty.
id	String	Unique id.
inactive	Boolean	Record is inactive (true/false).
shortDesc	String	Short description.
sortId	String	The right-aligned unique id.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example for 'dept'

HTTP/1.1 200 OK
{
   "response": {
      "lookupList": [
         {
            "id": "100",
            "sortId": "!!!!!!100",
            "desc": "North Pole",
            "shortDesc": "North",
            "fgColor": "",
            "bgColor": "",
            "inactive": false
         },
         {
            "id": "200",
            "sortId": "!!!!!!200",
            "desc": "South Pole",
            "shortDesc": "South",
            "fgColor": "",
            "bgColor": "",
            "inactive": false
         }
      ],
      "errorCode": 0,
      "errorMessage": ""
   }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.