get_record Flags

get_record

Retrieves information about a specific record.

SDK Method
C# GetRecord
Java getRecord
Python get_record

The default composite flag is SZ_RECORD_DEFAULT_FLAGS .

SZ_RECORD_DEFAULT_FLAGS

The output of SZ_RECORD_DEFAULT_FLAGS is equivalent to:

Click to expand response JSON Click to collapse 
{
  "DATA_SOURCE": "CUSTOMERS",
  "RECORD_ID": "1001",
  "JSON_DATA": {
    "DATA_SOURCE": "CUSTOMERS",
    "RECORD_ID": "1001",
    "FEATURES": [
      {
        "RECORD_TYPE": "PERSON"
      },
      {
        "NAME_LAST": "Smith",
        "NAME_FIRST": "Robert"
      },
      {
        "DATE_OF_BIRTH": "12/11/1978"
      },
      {
        "ADDR_TYPE": "MAILING",
        "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132"
      },
      {
        "PHONE_TYPE": "HOME",
        "PHONE_NUMBER": "702-919-1300"
      }
    ],
    "AMOUNT": "100",
    "DATE": "1/2/18",
    "STATUS": "Active"
  }
}

SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA

Include the record unmapped data for the entity or record.

Click to expand response JSON Click to collapse 
{
  "DATA_SOURCE": "CUSTOMERS",
  "RECORD_ID": "1001",
  "UNMAPPED_DATA": {
    "AMOUNT": "100",
    "DATE": "1/2/18",
    "STATUS": "Active"
  }
}

SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS

Include full feature details at the record level of an entity response or in a record response.

Click to expand response JSON Click to collapse 
{
  "DATA_SOURCE": "CUSTOMERS",
  "RECORD_ID": "1001",
  "FEATURES": {
    "NAME": [
      {
        "LIB_FEAT_ID": 19,
        "FEAT_DESC": "Robert Smith",
        "ATTRIBUTES": {
          "NAME_LAST": "Smith",
          "NAME_FIRST": "Robert"
        }
      }
    ],
    "DOB": [
      {
        "LIB_FEAT_ID": 2,
        "FEAT_DESC": "12/11/1978",
        "ATTRIBUTES": {
          "DATE_OF_BIRTH": "12/11/1978"
        }
      }
    ],
    "ADDRESS": [
      {
        "LIB_FEAT_ID": 21,
        "USAGE_TYPE": "MAILING",
        "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
        "ATTRIBUTES": {
          "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132"
        }
      }
    ],
    "PHONE": [
      {
        "LIB_FEAT_ID": 22,
        "USAGE_TYPE": "HOME",
        "FEAT_DESC": "702-919-1300",
        "ATTRIBUTES": {
          "PHONE_NUMBER": "702-919-1300"
        }
      }
    ],
    "RECORD_TYPE": [
      {
        "LIB_FEAT_ID": 7,
        "FEAT_DESC": "PERSON",
        "ATTRIBUTES": {
          "RECORD_TYPE": "PERSON"
        }
      }
    ]
  }
}

SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS

Adding SZ_ENTITY_INCLUDE_RECORD_FEATURE_STATS includes statistics for each record feature: ENTITY_COUNT (how many entities share the feature), and CANDIDATE_CAP_REACHED / SCORING_CAP_REACHED (whether the feature hit its generic threshold for candidate generation or scoring). Shown here combined with SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS , which provides the features the statistics describe.

Click to expand response JSON Click to collapse 
{
  "DATA_SOURCE": "CUSTOMERS",
  "RECORD_ID": "1001",
  "FEATURES": {
    "NAME": [
      {
        "LIB_FEAT_ID": 19,
        "FEAT_DESC": "Robert Smith",
        "ATTRIBUTES": {
          "NAME_LAST": "Smith",
          "NAME_FIRST": "Robert"
        },
        "USED_FOR_CAND": "N",
        "USED_FOR_SCORING": "Y",
        "ENTITY_COUNT": 2,
        "CANDIDATE_CAP_REACHED": "N",
        "SCORING_CAP_REACHED": "N"
      }
    ],
    "DOB": [
      {
        "LIB_FEAT_ID": 2,
        "FEAT_DESC": "12/11/1978",
        "ATTRIBUTES": {
          "DATE_OF_BIRTH": "12/11/1978"
        },
        "USED_FOR_CAND": "Y",
        "USED_FOR_SCORING": "Y",
        "ENTITY_COUNT": 1,
        "CANDIDATE_CAP_REACHED": "N",
        "SCORING_CAP_REACHED": "N"
      }
    ],
    "ADDRESS": [
      {
        "LIB_FEAT_ID": 21,
        "USAGE_TYPE": "MAILING",
        "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
        "ATTRIBUTES": {
          "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132"
        },
        "USED_FOR_CAND": "N",
        "USED_FOR_SCORING": "Y",
        "ENTITY_COUNT": 1,
        "CANDIDATE_CAP_REACHED": "N",
        "SCORING_CAP_REACHED": "N"
      }
    ],
    "PHONE": [
      {
        "LIB_FEAT_ID": 22,
        "USAGE_TYPE": "HOME",
        "FEAT_DESC": "702-919-1300",
        "ATTRIBUTES": {
          "PHONE_NUMBER": "702-919-1300"
        },
        "USED_FOR_CAND": "N",
        "USED_FOR_SCORING": "Y",
        "ENTITY_COUNT": 1,
        "CANDIDATE_CAP_REACHED": "N",
        "SCORING_CAP_REACHED": "N"
      }
    ],
    "RECORD_TYPE": [
      {
        "LIB_FEAT_ID": 7,
        "FEAT_DESC": "PERSON",
        "ATTRIBUTES": {
          "RECORD_TYPE": "PERSON"
        },
        "USED_FOR_CAND": "N",
        "USED_FOR_SCORING": "Y",
        "ENTITY_COUNT": 200,
        "CANDIDATE_CAP_REACHED": "N",
        "SCORING_CAP_REACHED": "N"
      }
    ]
  }
}

SZ_INCLUDE_FEATURE_HASHES

Adding SZ_INCLUDE_FEATURE_HASHES includes a FEAT_HASH value for each feature, the hashed form Senzing uses internally. Shown here combined with SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS , which provides the features being hashed.

Click to expand response JSON Click to collapse 
{
  "DATA_SOURCE": "CUSTOMERS",
  "RECORD_ID": "1001",
  "FEATURES": {
    "NAME": [
      {
        "LIB_FEAT_ID": 19,
        "FEAT_HASH": "94C7CDC81B2C39CCB0B1ECE0A2003552B95106AD",
        "FEAT_DESC": "Robert Smith",
        "ATTRIBUTES": {
          "NAME_LAST": "Smith",
          "NAME_FIRST": "Robert"
        }
      }
    ],
    "DOB": [
      {
        "LIB_FEAT_ID": 2,
        "FEAT_HASH": "E39C026DE4D45EAD4BB3C1DDB97383A90209BCC0",
        "FEAT_DESC": "12/11/1978",
        "ATTRIBUTES": {
          "DATE_OF_BIRTH": "12/11/1978"
        }
      }
    ],
    "ADDRESS": [
      {
        "LIB_FEAT_ID": 21,
        "FEAT_HASH": "E5D949FC827FC627E7D4A126825F8AE058C38719",
        "USAGE_TYPE": "MAILING",
        "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
        "ATTRIBUTES": {
          "ADDR_LINE1": "123 Main Street, Las Vegas NV 89132"
        }
      }
    ],
    "PHONE": [
      {
        "LIB_FEAT_ID": 22,
        "FEAT_HASH": "D236C03B084782CFE03191A061CB24343A11383B",
        "USAGE_TYPE": "HOME",
        "FEAT_DESC": "702-919-1300",
        "ATTRIBUTES": {
          "PHONE_NUMBER": "702-919-1300"
        }
      }
    ],
    "RECORD_TYPE": [
      {
        "LIB_FEAT_ID": 7,
        "FEAT_HASH": "3512ED09022FF802B83640A18D5D2FF814ADD947",
        "FEAT_DESC": "PERSON",
        "ATTRIBUTES": {
          "RECORD_TYPE": "PERSON"
        }
      }
    ]
  }
}

If you have any questions, contact Senzing Support. Support is 100% FREE!