1. REST API for Oracle Responsys Marketing Cloud Service
  2. Tasks
  3. Profile Extension Recipients

Retrieve Profile Extension Recipient using a query attribute

get

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

Retrieve Profile Extension Table (PET) recipient data using a query attribute

Request

Supported Media Types
Path Parameters
Query Parameters
  • End date to retrieve modified records. When qa=d, end date should be in MM-DD-YYYY format. Retrieves the PET records whose modified date is between the start and the end date. Note that the Responsys servers follow Pacific Standard Time (PST) when using this parameter.
  • Comma separated list of fields to retrieve or 'all'
  • ID corresponding to the query attribute, used to locate the record to retrieve
  • Query attribute can be either 'r' (RIID_), 'e' (EMAIL_ADDRESS_), 'c' (CUSTOMER_ID_), 'm' (MOBILE_NUMBER_), or 'd' (MODIFIED_DATE_). The corresponding value passed must match what is in the parent Profile List. Note when using 'd' (MODIFIED_DATE_) the corresponding value passed as sdate and edate should match what is in the Profile Extension table.
  • Start date to retrieve modified records. When qa=d, start date should be in MM-DD-YYYY format. Retrieves the PET records whose modified date is between the start and the end date. Note that the Responsys servers follow Pacific Standard Time (PST) when using this parameter.
Back to Top

Response

Supported Media Types

Default Response

Body ()
Root Schema : Profile Extension Recipients
Type: object
Title: Profile Extension Recipients
Show Source
  • Specifies whether a recipient record should be inserted into the Profile Extension if it does not already exist. Only used during the merge operation.
  • Allowed Values: [ "RIID", "CUSTOMER_ID", "EMAIL_ADDRESS", "MOBILE_NUMBER", "EMAIL_MD5_HASH", "EMAIL_SHA256_HASH" ]
    The column name to be used to match the recipient record to the Profile Extension records. Only used during the merge operation.
  • recordData
    Record data that represents field names and corresponding values for the recipient.
  • 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.
Nested Schema : recordData
Type: object
Record data that represents field names and corresponding values for the recipient.
Show Source
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
Nested Schema : records
Type: array
Array of values corresponding to the fieldNames. Each element in the array represents a single recipient.
Show Source
Nested Schema : items
Type: array
Field values for the recipient in the Profile List
Show Source
Back to Top

Examples

A successful request requires the following headers:

FIELDS DESCRIPTION
Authorization <AUTH_TOKEN>
FIELDS DESCRIPTION
qa Can be either r (RIID_), e (EMAIL_ADDRESS_), c (CUSTOMER_ID_), m (MOBILE_NUMBER_), or d (MODIFIED_DATE_). Note when using d (MODIFIED_DATE_) the corresponding value passed as sdate and edate should match what is in the Profile Extension table.
id ID corresponding to the query attribute
fs Comma separated field list or all
sdate Start date to retrieve modified records. When qa=d, start date should be in MM-dd-yyyy format. Retrieves the PET records whose modified date is between the start and the end date.
edate End date to retrieve modified records. When qa=d, end date should be in MM-dd-yyyy format. Retrieves the PET records whose modified date is between the start and the end date.

Example Request URLs:

  • For the PET named "DemoNewsLetterPet", retrieve all fields of the PET record where RIID_ is 1001: 
    /rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members?qa=r&id=1001&fs=all
  • For the PET named "DemoNewsLetterPet", retrieve the Salary and RIID_ fields of the PET record where the EMAIL_ADDRESS_ is responsysblr@gmail.com: 
    /rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members?qa=e&fs=riid_,salary&id=responsysblr@gmail.com
  • For the PET named "DemoNewsLetterPet", retrieve the RIID_ fields of the PET record modified between 06-13-2018 and 09-13-2018 (date format MM-DD-YYYY): 
    /rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members?qa=d&fs=RIID_&sdate=06-13-2018&edate=09-13-2018
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":       [
         "RIID_",
         "SALARY"
      ],
      "records": [      [
         "1761409",
         "239482734"
      ]],
      "mapTemplateName": null
   },
   "insertOnNoMatch": false,
   "updateOnMatch": null,
   "matchColumn": null,
   "links":    [
      {
         "rel": "self",
         "href": "/rest/api/v1.3/lists/DemoNewsLetterList/listExtensions/DemoNewsLetterPet/members?qa=e&fs=riid_,salary&id=responsysblr@gmail.com",
         "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

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