Retrieve profile list fields

Retrieves the standard and custom fields for the specified profile list. In the request URL, specify the name of the profile list to retrieve. A successful response returns a list of the standard and custom fields for the list.

Refer to the Oracle Responsys Help Center for more information about the profile list fields returned in the response.

Service URL:

/rest/api/v1.3/lists/{listName}/fields

Required Path Parameters:

listName - Name of the profile list to retrieve fields.

Request Method:

GET

Request Header:

Authorization=<AUTH_TOKEN>

Request Body:

None

Sample Response in case of success:

{
  "name": "DemoProfileList",
  "folderName": "Responsys_Folder",
  "fields": [
    {
      "fieldName": "RIID_",
      "fieldType": "INTEGER"
    },
    {
      "fieldName": "CREATED_SOURCE_IP_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "CUSTOMER_ID_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "EMAIL_ADDRESS_",
      "fieldType": "STR500"
    },
    {
      "fieldName": "EMAIL_DOMAIN_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "EMAIL_ISP_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "EMAIL_FORMAT_",
      "fieldType": "CHAR"
    },
    {
      "fieldName": "EMAIL_PERMISSION_STATUS_",
      "fieldType": "CHAR"
    },
    {
      "fieldName": "EMAIL_DELIVERABILITY_STATUS_",
      "fieldType": "CHAR"
    },
    {
      "fieldName": "EMAIL_PERMISSION_REASON_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "EMAIL_MD5_HASH_",
      "fieldType": "STR50"
    },
    {
      "fieldName": "EMAIL_SHA256_HASH_",
      "fieldType": "STR100"
    },
    {
      "fieldName": "MOBILE_NUMBER_",
      "fieldType": "STR50"
    },
    {
      "fieldName": "MOBILE_COUNTRY_",
      "fieldType": "STR25"
    },
    {
      "fieldName": "MOBILE_PERMISSION_STATUS_",
      "fieldType": "CHAR"
    },
    {
      "fieldName": "MOBILE_DELIVERABILITY_STATUS_",
      "fieldType": "CHAR"
    },
    {
      "fieldName": "MOBILE_PERMISSION_REASON_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "POSTAL_STREET_1_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "POSTAL_STREET_2_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "CITY_",
      "fieldType": "STR50"
    },
    {
      "fieldName": "STATE_",
      "fieldType": "STR50"
    },
    {
      "fieldName": "POSTAL_CODE_",
      "fieldType": "STR25"
    },
    {
      "fieldName": "COUNTRY_",
      "fieldType": "STR50"
    },
    {
      "fieldName": "POSTAL_PERMISSION_STATUS_",
      "fieldType": "CHAR"
    },
    {
      "fieldName": "POSTAL_DELIVERABILITY_STATUS_",
      "fieldType": "CHAR"
    },
    {
      "fieldName": "POSTAL_PERMISSION_REASON_",
      "fieldType": "STR255"
    },
    {
      "fieldName": "CREATED_DATE_",
      "fieldType": "TIMESTAMP"
    },
    {
      "fieldName": "MODIFIED_DATE_",
      "fieldType": "TIMESTAMP"
    }
  ]
}

Sample Response in case of failure:

404 Not Found Errors

List not found: Requests fail when the profile list name specified is not found in Responsys. The error resembles:

{
   "type": "",
   "title": "List not found",
   "errorCode": "LIST_NOT_FOUND",
   "detail": "Account : datateam : does not have any profile lists.",
   "errorDetails": []
}

400 Bad Request Errors

Invalid list name length: Requests fail if the name of the profile list specified exceeds 100 characters. The error resembles:

{
  "type": "",
  "title": "Invalid request parameters",
  "errorCode": "INVALID_PARAMETER",
  "detail": "Max Length of listName allowed: 100",
  "errorDetails": []
}

401 Unauthorized Errors

Insufficient access to the list: Requests fail if the user performing the request does not have access to the specified list. The list may belong to a different organization. The error resembles:

{
  "type": "",
  "title": "Insufficient access",
  "errorCode": "INSUFFICIENT_ACCESS",
  "detail": "User does not have access to the list",
  "errorDetails": []
}

Insufficient privileges to API: Requests fail if the user performing the request does not have the List Web Services Manager role. This role is required to perform this request. The error resembles:

{
  "type": "",
  "title": "Insufficient access",
  "errorCode": "INSUFFICIENT_ACCESS",
  "detail": "Insufficient privileges to invoke this API",
  "errorDetails": []
}