Retrieving List Values

listGetByCode

Lookup the RECID(s) for the List determined by the type and the code(s).

PHP

mixed listGetByCode(string $list_type, mixed $list_code)

Parameters

$list_type: The List Type specification of the desired record.
$list_code: A string or array specifying the one or more List Codes belonging to the specified List Type. Only RECIDs for valid Codes will be returned. An array of three codes where one is invalid will return an array of two valid RECIDs.

Return Values

Returns a List RECID or array of List RECIDs if records were found. Returns NULL if nothing is found.

listFindValue

Lookup the List value for given List RECID.

PHP

string listFindValue(int $recid)

Parameters

$recid: The List RECID to find in the LISTS table.

Return Values

List Value of the specified record. Returns NULL if nothing is found.

listFindCode

Lookup the List code for given List RECID.

PHP

string listFindCode(int $recid)

Parameters

$recid: The List RECID to find in the LISTS table.

Return Values

List Code of the specified record. Returns NULL if nothing is found.

Examples:

PHP


$serviceStatusAvailableRecid = $this->listGetByCode('SERVICE_STATUS', 'AVAILABLE');
$serviceStatuses = $this->listGetByCode('SERVICE_STATUS', ['AVAILABLE', 'ACTIVE']);

$listValue = $this->listFindValue(123);

$listCode = $this->listFindCode(123);