JSON Identifier Lists (with Sort Key)

Describes a set of search results as a list of one or more sub lists, each containing a list of data entity identifiers along with a sorting key value for each entry.

Used specifically with the Entity service as the output from the Find Data Entity resource method, this structure groups the data entity identifiers returned into sortable sub lists of entries.

The order of the entries (including the sort key produced), and the number of sub lists returned depends on the sorting and grouping rules specified in the JSON Search Parameters structure previously submitted as input to the Find Data Entity resource method.

Structure

The structure consists of an array of object arrays, with each object containing the following name/value pairs:

  • identifier – the data entity identifier (type of number)

  • sortkey – the data entity sort key (type of string)

Example

The following is an example of this structure:

[
    [
        {
            "identifier": 1604,
            "sortkey": "NB|Vilma"
        },
        {
            "identifier": 1282,
            "sortkey": "NF|Lenard"
        },
        {
            "identifier": 1443,
            "sortkey": "NF|Lenard"
        },
        {
            "identifier": 1000,
            "sortkey": "SK|Cathleen"
        },
        {
            "identifier": 1121,
            "sortkey": "SK|Rachel"
        }
    ]
]