Jump to

• Request
• Response
• Examples

Retrieve Profile Extension Recipient using an RIID

get

/rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members/{riid}

Retrieve Profile Extension Table (PET) recipient data using the RIID of the parent Profile List record

Request

Supported Media Types

• application/x-www-form-urlencoded

Path Parameters

• listName: string
  List name
• petName: string
  Profile Extension Table (PET) name
• riid: string
  RIID of the parent Profile List record, which is used to locate the corresponding PET record

Query Parameters

• fs: string
  Comma separated list of fields to retrieve or 'all'

Back to Top

Response

Supported Media Types

• application/json

Default Response

Body ()

Root Schema : Profile Extension Recipients

Type: object

Title: Profile Extension Recipients

Show Source

• insertOnNoMatch: boolean
  Specifies whether a recipient record should be inserted into the Profile Extension if it does not already exist. Only used during the merge operation.
• matchColumnName1:
  Allowed Values: [ "RIID", "CUSTOMER_ID", "EMAIL_ADDRESS", "MOBILE_NUMBER", "EMAIL_MD5_HASH", "EMAIL_SHA256_HASH" ]

  The first column name to be used to match the recipient record to the Profile Extension records. Only used during the merge operation.
• matchColumnName2(optional):
  Allowed Values: [ "RIID", "CUSTOMER_ID", "EMAIL_ADDRESS", "MOBILE_NUMBER", "EMAIL_MD5_HASH", "EMAIL_SHA256_HASH" ]

  Second match column for determining whether an insert or update should occur. (optional).
• recordData: object recordData
  Record data that represents field names and corresponding values for the recipient.
• updateOnMatch:
  Allowed Values: [ "REPLACE_ALL", "NO_UPDATE" ]

  Specifies whether a recipient record should be updated in the Profile Extension if it already exists. Only used during the merge operation.

{
    "title":"Profile Extension Recipients",
    "type":"object",
    "properties":{
        "recordData":{
            "description":"Record data that represents field names and corresponding values for the recipient.",
            "required":[
                "fieldNames",
                "records"
            ],
            "type":"object",
            "properties":{
                "fieldNames":{
                    "type":"array",
                    "description":"Field names of the Profile List. Must contain contain at least one of the merge key fields from the Profile List.",
                    "items":{
                        "type":"string"
                    }
                },
                "records":{
                    "type":"array",
                    "description":"Array of values corresponding to the fieldNames. Each element in the array represents a single recipient.",
                    "items":{
                        "type":"array",
                        "description":"Field values for the recipient in the Profile List",
                        "items":{
                            "type":"string"
                        }
                    }
                },
                "mapTemplateName":{
                    "type":"string",
                    "description":"The map template in CX Audience that can be used to map field names of the Profile List to column names."
                }
            }
        },
        "insertOnNoMatch":{
            "description":"Specifies whether a recipient record should be inserted into the Profile Extension if it does not already exist. Only used during the merge operation.",
            "type":"boolean"
        },
        "updateOnMatch":{
            "description":"Specifies whether a recipient record should be updated in the Profile Extension if it already exists. Only used during the merge operation.",
            "enum":[
                "REPLACE_ALL",
                "NO_UPDATE"
            ]
        },
        "matchColumnName1":{
            "description":"The first column name to be used to match the recipient record to the Profile Extension records. Only used during the merge operation.",
            "enum":[
                "RIID",
                "CUSTOMER_ID",
                "EMAIL_ADDRESS",
                "MOBILE_NUMBER",
                "EMAIL_MD5_HASH",
                "EMAIL_SHA256_HASH"
            ]
        },
        "matchColumnName2":{
            "description":"Second match column for determining whether an insert or update should occur. (optional).",
            "enum":[
                "RIID",
                "CUSTOMER_ID",
                "EMAIL_ADDRESS",
                "MOBILE_NUMBER",
                "EMAIL_MD5_HASH",
                "EMAIL_SHA256_HASH"
            ]
        }
    },
    "required":[
        "recordData",
        "insertOnNoMatch",
        "updateOnMatch",
        "matchColumnName1"
    ]
}

Nested Schema : recordData

Type: object

Record data that represents field names and corresponding values for the recipient.

Show Source

• fieldNames: array fieldNames
  Field names of the Profile List. Must contain contain at least one of the merge key fields from the Profile List.
• mapTemplateName(optional): string
  The map template in CX Audience that can be used to map field names of the Profile List to column names.
• records: array records
  Array of values corresponding to the fieldNames. Each element in the array represents a single recipient.

{
    "description":"Record data that represents field names and corresponding values for the recipient.",
    "required":[
        "fieldNames",
        "records"
    ],
    "type":"object",
    "properties":{
        "fieldNames":{
            "type":"array",
            "description":"Field names of the Profile List. Must contain contain at least one of the merge key fields from the Profile List.",
            "items":{
                "type":"string"
            }
        },
        "records":{
            "type":"array",
            "description":"Array of values corresponding to the fieldNames. Each element in the array represents a single recipient.",
            "items":{
                "type":"array",
                "description":"Field values for the recipient in the Profile List",
                "items":{
                    "type":"string"
                }
            }
        },
        "mapTemplateName":{
            "type":"string",
            "description":"The map template in CX Audience that can be used to map field names of the Profile List to column names."
        }
    }
}

Nested Schema : fieldNames

Type: array

Field names of the Profile List. Must contain contain at least one of the merge key fields from the Profile List.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Field names of the Profile List. Must contain contain at least one of the merge key fields from the Profile List.",
    "items":{
        "type":"string"
    }
}

Nested Schema : records

Type: array

Array of values corresponding to the fieldNames. Each element in the array represents a single recipient.

Show Source

• Array of: array items
  Field values for the recipient in the Profile List

{
    "type":"array",
    "description":"Array of values corresponding to the fieldNames. Each element in the array represents a single recipient.",
    "items":{
        "type":"array",
        "description":"Field values for the recipient in the Profile List",
        "items":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: array

Field values for the recipient in the Profile List

Show Source

• Array of: string

{
    "type":"array",
    "description":"Field values for the recipient in the Profile List",
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

A successful request requires the following headers:

FIELDS	DESCRIPTION
Authorization	<AUTH_TOKEN>

FIELDS	DESCRIPTION
fs	comma separated list of fields to retrieve or all

Example Request URLs:

• To retrieve all PET fields:

     /rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members/1761408?fs=all
  
  	

• To retrieve the Salary and RIID_ fields:

     /rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members/1761408?fs=salary,riid_
  
  	

Request Notes:

• The service URL requires the names of both the Profile List and the Profile Extension Table.
• The total length of the string passed in for the fs parameter (containing the comma separated field names) cannot exceed 150 characters.
• To retrieve values of all columns, you can specify only one field with value set to all (if you have a column called all, you should use two or more specific column names to avoid getting all of the columns).

Sample Response: Success

NOTE: Other attributes in the response like mapTemplateName, insertOnNoMatch, updateOnMatch, and matchColumn will have default values (null/false).

    {
   "recordData":    {
      "fieldNames":       [
         "SALARY",
         "RIID_"
      ],
      "records": [      [
         "10000",
         "1761408"
      ]],
      "mapTemplateName": null
   },
   "insertOnNoMatch": false,
   "updateOnMatch": null,
   "matchColumn": null,
   "links":    [
   {
         "rel": "self",
         "href": "/rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members/1761408?fs=salary,riid_",
         "method": "GET"
   },
   {
         "rel": "mergeProfileExtensionRecipients",
         "href": "/rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members",
         "method": "POST"
   },
   {
         "rel": "deleteProfileExtensionRecipientsRIID",
         "href": "/rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members/<riid>",
         "method": "DELETE"
    }
   ]
}

	

Sample Response: Failure - When the system cannot find a record matching the ID that you sent

{
   "type": "",
   "title": "Record not found",
   "errorCode": "RECORD_NOT_FOUND",
   "detail": "No records found in the table for the given ids",
   "errorDetails": []
}
     

Sample Response: Failure - If the fs parameter is omitted:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "FieldList is null OR empty",
  "errorDetails": []
}

     

Back to Top