Flags are optional parameters that specify what data about an entity, record, features, or relationships to retrieve. Each function’s relevant flags are detailed here. If no flag parameter is given then the default flags are used.
get_record
These are the control flags applicable to:
- C/C++:
Sz_getRecord
- C#:
GetRecord
- Java:
getRecord
- Python:
get_record
- sz_command:
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",
"RECORD_TYPE": "PERSON",
"PRIMARY_NAME_LAST": "Smith",
"PRIMARY_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",
"DATE": "1/2/18",
"STATUS": "Active",
"AMOUNT": "100"
}
}
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": {
"DATE": "1/2/18",
"STATUS": "Active",
"AMOUNT": "100"
}
}
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": 1,
"USAGE_TYPE": "PRIMARY",
"FEAT_DESC": "Robert Smith",
"ATTRIBUTES": {
"PRIMARY_NAME_LAST": "Smith",
"PRIMARY_NAME_FIRST": "Robert"
}
}
],
"DOB": [
{
"LIB_FEAT_ID": 2,
"FEAT_DESC": "12/11/1978",
"ATTRIBUTES": {
"DATE_OF_BIRTH": "12/11/1978"
}
}
],
"ADDRESS": [
{
"LIB_FEAT_ID": 3,
"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": 4,
"USAGE_TYPE": "HOME",
"FEAT_DESC": "702-919-1300",
"ATTRIBUTES": {
"PHONE_NUMBER": "702-919-1300"
}
}
],
"RECORD_TYPE": [
{
"LIB_FEAT_ID": 9,
"FEAT_DESC": "PERSON",
"ATTRIBUTES": {
"RECORD_TYPE": "PERSON"
}
}
]
}
}