get_entity* Flags

get_entity_by_entity_id, get_entity_by_record_id

These are the control flags applicable to:

  • C/C++: Sz_getEntityByEntityID, Sz_getEntityByRecordID
  • C#: GetEntity
  • Java: getEntity
  • Python: get_entity_by_entity_id, get_entity_by_record_id
  • sz_command: get_entity_by_entity_id, get_entity_by_record_id

The default composite flag is SZ_ENTITY_DEFAULT_FLAGS.

SZ_ENTITY_DEFAULT_FLAGS

The output of SZ_RECORD_DEFAULT_FLAGS is a composite of:

  • SZ_ENTITY_INCLUDE_ALL_RELATIONS
  • SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES
  • SZ_ENTITY_INCLUDE_ENTITY_NAME
  • SZ_ENTITY_INCLUDE_RECORD_SUMMARY
  • SZ_ENTITY_INCLUDE_RECORD_DATA
  • SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO
  • SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME
  • SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY
  • SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO
Click to expand response JSON

SZ_ENTITY_INCLUDE_ALL_RELATIONS

The output of SZ_RECORD_DEFAULT_FLAGS is composite of:

  • SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS
  • SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS
  • SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS
  • SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS
Click to expand response JSON
Click to expand response JSON

SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS

Click to expand response JSON

SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS

The parameter values (from our truthset) used to generate the response messages are:

  • datasource_code: REFERENCE
  • record_id: 2081
Click to expand response JSON

SZ_ENTITY_INCLUDE_ALL_FEATURES

Click to expand response JSON

SZ_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES

Click to expand response JSON

SZ_ENTITY_INCLUDE_ENTITY_NAME

Click to expand response JSON

SZ_ENTITY_INCLUDE_RECORD_SUMMARY

Click to expand response JSON

SZ_ENTITY_INCLUDE_RECORD_DATA

Click to expand response JSON

SZ_ENTITY_INCLUDE_RECORD_MATCHING_INFO

Click to expand response JSON

SZ_ENTITY_INCLUDE_RECORD_JSON_DATA

Click to expand response JSON

SZ_ENTITY_INCLUDE_RECORD_UNMAPPED_DATA

Click to expand response JSON

SZ_ENTITY_INCLUDE_RECORD_FEATURES

Click to expand response JSON

SZ_ENTITY_INCLUDE_RECORD_FEATURE_DETAILS

Click to expand response JSON

NOTE: The SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME flag is dependent on using one of the following flags: SZ_ENTITY_INCLUDE_ALL_FEATURES, SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS, SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS, SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS, or SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS.

This sample response message was generated using SZ_ENTITY_INCLUDE_RELATED_ENTITY_NAME and SZ_ENTITY_INCLUDE_ALL_FEATURES:

Click to expand response JSON

NOTE: The SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO flag is dependent on using one of the following flags: SZ_ENTITY_INCLUDE_ALL_FEATURES, SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS, SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS, SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS, or SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS.

This sample response message was generated using SZ_ENTITY_INCLUDE_RELATED_MATCHING_INFO and SZ_ENTITY_INCLUDE_ALL_FEATURES:

Click to expand response JSON

NOTE: The SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY flag is dependent on using one of the following flags: SZ_ENTITY_INCLUDE_ALL_FEATURES, SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS, SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS, SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS, or SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS.

This sample response message was generated using SZ_ENTITY_INCLUDE_RELATED_RECORD_SUMMARY and SZ_ENTITY_INCLUDE_ALL_FEATURES:

Click to expand response JSON

NOTE: The SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA flag is dependent on using one of the following flags: SZ_ENTITY_INCLUDE_ALL_FEATURES, SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS, SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS, SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS, or SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS.

This sample response message was generated using SZ_ENTITY_INCLUDE_RELATED_RECORD_DATA and SZ_ENTITY_INCLUDE_ALL_FEATURES:

{
    "RESOLVED_ENTITY":
    {
        "ENTITY_ID": 100001,
        "FEATURES":
        {
            "ADDRESS":
            [
                {
                    "FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
                    "LIB_FEAT_ID": 100079,
                    "USAGE_TYPE": "HOME",
                    "FEAT_DESC_VALUES":
                    [
                        {
                            "FEAT_DESC": "1515 Adela Lane Las Vegas NV 89111",
                            "LIB_FEAT_ID": 100079
                        }
                    ]
                },
                {
                    "FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
                    "LIB_FEAT_ID": 100067,
                    "USAGE_TYPE": "HOME",
                    "FEAT_DESC_VALUES":
                    [
                        {
                            "FEAT_DESC": "1515 Adela Ln Las Vegas NV 89132",
                            "LIB_FEAT_ID": 100067
                        }
                    ]
                },
                {
                    "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
                    "LIB_FEAT_ID": 100043,
                    "USAGE_TYPE": "MAILING",
                    "FEAT_DESC_VALUES":
                    [
                        {
                            "FEAT_DESC": "123 Main Street, Las Vegas NV 89132",
                            "LIB_FEAT_ID": 100043
                        }
                    ]
                }
            ],
            "DOB":
            [
                {
                    "FEAT_DESC": "11/12/1978",
                    "LIB_FEAT_ID": 100078,
                    "FEAT_DESC_VALUES":
                    [
                        {
                            "FEAT_DESC": "11/12/1978",
                            "LIB_FEAT_ID": 100078
                        }
                    ]
                },
                {
                    "FEAT_DESC": "11/12/1979",
                    "LIB_FEAT_ID": 100066,
                    "FEAT_DESC_VALUES":
                    [
                        {
                            "FEAT_DESC": "11/12/1979",
                            "LIB_FEAT_ID": 100066
                        }
                    ]
                },
                {
                    "FEAT_DESC": "12/11/1978",
                    "LIB_FEAT_ID": 100002,
                    "FEAT_DESC_VALUES":
                    [
                        {
                            "FEAT_DESC": "12/11/1978",
                            "LIB_FEAT_ID": 100002
                        }
                    ]
                }
            ],
            "EMAIL":
            [
                {
                    "FEAT_DESC": "bsmith@work.com",
                    "LIB_FEAT_ID": 100003,
                    "FEAT_DESC_VALUES":
                    [
                        {
                            "FEAT_DESC": "bsmith@work.com",
                            "LIB_FEAT_ID": 100003
                        }
                    ]
                }
            ],
            "NAME":
            [
                {
                    "FEAT_DESC": "B Smith",
                    "LIB_FEAT_ID": 100065,
                    "USAGE_TYPE": "PRIMARY",
                    "FEAT_DESC_VALUES":
                    [
                        {
                            "FEAT_DESC": "B Smith",
                            "LIB_FEAT_ID": 100065
                        }
                    ]
                },
                {
                    "FEAT_DESC": "Bob J Smith",
                    "LIB_FEAT_ID": 100001,
                    "USAGE_TYPE": "PRIMARY",
                    "FEAT_DESC_VALUES":
                    [
                        {
                            "FEAT_DESC": "Bob J Smith",
                            "LIB_FEAT_ID": 100001
                        }
                    ]
                },
                {
                    "FEAT_DESC": "Bob Smith",
                    "LIB_FEAT_ID": 100077,
                    "USAGE_TYPE": "PRIMARY",
                    "FEAT_DESC_VALUES":
                    [
                        {
                            "FEAT_DESC": "Bob Smith",
                            "LIB_FEAT_ID": 100077
                        }
                    ]
                },
                {
                    "FEAT_DESC": "Robert Smith",
                    "LIB_FEAT_ID": 9,
                    "USAGE_TYPE": "PRIMARY",
                    "FEAT_DESC_VALUES":
                    [
                        {
                            "FEAT_DESC": "Robert Smith",
                            "LIB_FEAT_ID": 9
                        }
                    ]
                }
            ],
            "PHONE":
            [
                {
                    "FEAT_DESC": "702-919-1300",
                    "LIB_FEAT_ID": 100080,
                    "USAGE_TYPE": "HOME",
                    "FEAT_DESC_VALUES":
                    [
                        {
                            "FEAT_DESC": "702-919-1300",
                            "LIB_FEAT_ID": 100080
                        }
                    ]
                },
                {
                    "FEAT_DESC": "702-919-1300",
                    "LIB_FEAT_ID": 100080,
                    "USAGE_TYPE": "MOBILE",
                    "FEAT_DESC_VALUES":
                    [
                        {
                            "FEAT_DESC": "702-919-1300",
                            "LIB_FEAT_ID": 100080
                        }
                    ]
                }
            ],
            "RECORD_TYPE":
            [
                {
                    "FEAT_DESC": "PERSON",
                    "LIB_FEAT_ID": 7,
                    "FEAT_DESC_VALUES":
                    [
                        {
                            "FEAT_DESC": "PERSON",
                            "LIB_FEAT_ID": 7
                        }
                    ]
                }
            ]
        }
    }
}

SZ_ENTITY_INCLUDE_INTERNAL_FEATURES

NOTE: The SZ_ENTITY_INCLUDE_INTERNAL_FEATURES flag is dependent on using one of the following flags: SZ_ENTITY_INCLUDE_ALL_FEATURES, SZ_ENTITY_INCLUDE_POSSIBLY_SAME_RELATIONS, SZ_ENTITY_INCLUDE_POSSIBLY_RELATED_RELATIONS, SZ_ENTITY_INCLUDE_NAME_ONLY_RELATIONS, or SZ_ENTITY_INCLUDE_DISCLOSED_RELATIONS.

This sample response message was generated using SZ_ENTITY_INCLUDE_INTERNAL_FEATURES and SZ_ENTITY_INCLUDE_ALL_FEATURES:

Click to expand response JSON

SZ_ENTITY_INCLUDE_FEATURE_STATS

NOTE: The G2_ENTITY_OPTION_INCLUDE_FEATURE_STATS flag is dependent on using one of the following flags: G2_ENTITY_INCLUDE_ALL_FEATURES, or G2_ENTITY_INCLUDE_REPRESENTATIVE_FEATURES.

This sample response message was generated using G2_ENTITY_OPTION_INCLUDE_FEATURE_STATS and SZ_ENTITY_INCLUDE_FEATURE_STATS:

Click to expand response JSON