POST 17.0/app/system/lookup

Description

Retrieves lookup table values as ID/Description pairs for the specified lookup source.

URI Parameters

None.

Lookup request containing the source table, optional group filter, inactive record inclusion flag, and selected record identifier.

SystemLookupRequest
Name Description Type Additional information
SourceId

byte

None.
GroupId

integer

None.
IncludeInactive

boolean

None.
SelectedRecordId

integer

None.

application/json, text/json
Sample: 
{
  "sourceId": 64,
  "groupId": 2,
  "includeInactive": true,
  "selectedRecordId": 4
}

application/xml, text/xml
Sample: 
<SystemLookupRequest xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <SourceId>64</SourceId>
  <GroupId>2</GroupId>
  <IncludeInactive>true</IncludeInactive>
  <SelectedRecordId>4</SelectedRecordId>
</SystemLookupRequest>

application/x-www-form-urlencoded
Sample:

Sample not available.

A list of items representing the lookup results.

Collection of IDDescriptionPair
Name Description Type Additional information
ID

integer

None.
Description

string

None.

application/json, text/json
Sample: 
[
  {
    "id": 1,
    "description": "sample string 2"
  },
  {
    "id": 1,
    "description": "sample string 2"
  }
]

application/xml, text/xml
Sample: 
<ArrayOfIDDescriptionPair xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IDDescriptionPair>
    <ID>1</ID>
    <Description>sample string 2</Description>
  </IDDescriptionPair>
  <IDDescriptionPair>
    <ID>1</ID>
    <Description>sample string 2</Description>
  </IDDescriptionPair>
</ArrayOfIDDescriptionPair>