1. REST API for Oracle Eloqua Marketing Cloud Service
  2. Tasks
  3. Application
  4. 2.0
  5. Event registrants

Retrieve a list of event registrants

get

/api/rest/2.0/data/eventRegistration/{parentId}/instances

Retrieves the registrants (records) for an event specified by the parentId that match the criteria specified by the query parameters.

Request

Supported Media Types
Path Parameters
Query Parameters
  • Maximum number of entities to return. Must be less than or equal to 1000 and greater than or equal to 1.
  • This parameter is not used for this endpoint.
  • Specifies the field by which list results are ordered.
  • Specifies which page of event registrant to return (the count parameter defines the number of event registrant assets per page). If the page parameter is not supplied, 1 will be used by default.
  • Specifies the search criteria used to retrieve entities. See the tutorial for information about using this parameter.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : QueryResultEventRegistrationData
Type: object
Title: QueryResultEventRegistrationData
Show Source
Nested Schema : elements
Type: array
Array of event field elements.
Show Source
Nested Schema : EventRegistrationData
Type: object
Title: EventRegistrationData
Show Source
  • The account record Id associated to this event registrant. This is a read-only property.
  • The contact record Id associated to this event registrant. Use the desired contact's id as the value for this parameter.
  • Read Only: true
    The date and time the event registrant was created, expressed in Unix time. This is a read-only property.
  • Read Only: true
    This property is not used for event registrants.
  • This property is not used for event registrants.
  • The status of the event registrant. Only returned when creating or updating an event registrant. This is a read-only property.
  • Read Only: true
    This property is not used for event registrants.
  • This property is not used for event registrants.
  • fieldValues
    Array containing type, id, and value for all of the fields associated with a given event registrant.
  • Read Only: true
    This property is not used for event registrants.
  • Read Only: true
    Id of the event registrant. This is a read-only property.
  • Whether or not the event registrant is mapped to a contact or account. This is a read-only property.
  • The name of the event registrant. This is a read-only property.
  • permissions
    This property is not used for event registrants.
  • Read Only: true
    This property is not used for event registrants.
  • This property is not used for event registrants.
  • The asset's type in Eloqua. This is a read-only property.
  • The unique value associated to the event registrant. This is a read-only property.
  • Read Only: true
    Unix timestamp for the date and time the event registrant was last updated. This is a read-only property.
  • Read Only: true
    This property is not used for event registrants.
Nested Schema : fieldValues
Type: array
Array containing type, id, and value for all of the fields associated with a given event registrant.
Show Source
Nested Schema : permissions
Type: array
This property is not used for event registrants.
Show Source
Nested Schema : FieldValue
Type: object
Title: FieldValue
Show Source
  • Read Only: true
    The id of the field to be set to the corresponding value.
  • Name of the field value.
  • The asset's type in Eloqua. This is a read-only property.
  • The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.

400 Response

Bad request. See Status Codes for information about other possible HTTP status codes.

401 Response

Unauthorized. See Status Codes for information about other possible HTTP status codes.

403 Response

Forbidden. See Status Codes for information about other possible HTTP status codes.

404 Response

The requested resource was not found. See Status Codes for information about other possible HTTP status codes.

500 Response

The service has encountered an error. See Status Codes for information about other possible HTTP status codes.
Back to Top

Examples

Retrieve all event registrants for the event with Id #1260:


GET /api/REST/2.0/data/eventRegistration/1260/instances

Response:


{
  "elements": [
    {
      "type": "EventRegistrationData",
      "id": "332375",
      "createdAt": "1493161593",
      "name": "john.doe@oracle.com",
      "updatedAt": "1493161644",
      "contactId": "1504652",
      "fieldValues": [
        {
          "type": "FieldValue",
          "id": "3958",
          "value": "john.doe@oracle.com"
        },
        {
          "type": "FieldValue",
          "id": "3959",
          "value": "John"
        },
        {
          "type": "FieldValue",
          "id": "3960",
          "value": "Technology"
        },
        {
          "type": "FieldValue",
          "id": "3962",
          "value": "Married"
        },
        {
          "type": "FieldValue",
          "id": "3964",
          "value": "North America"
        },
        {
          "type": "FieldValue",
          "id": "3963",
          "value": "Doe"
        },
        {
          "type": "FieldValue",
          "id": "3961",
          "value": "Yes"
        }
      ],
      "isMapped": "Yes",
      "uniqueCode": "john.doe@oracle.com"
    },
    {
      "type": "EventRegistrationData",
      "id": "332377",
      "createdAt": "1493232098",
      "name": "anna.nystrom@oracle.com",
      "updatedAt": "1493232255",
      "contactId": "1653174",
      "fieldValues": [
        {
          "type": "FieldValue",
          "id": "3958",
          "value": "anna.nystrom@oracle.com"
        },
        {
          "type": "FieldValue",
          "id": "3959",
          "value": "Anna"
        },
        {
          "type": "FieldValue",
          "id": "3960",
          "value": "Computer Hardware"
        },
        {
          "type": "FieldValue",
          "id": "3962",
          "value": "Nystrom"
        },
        {
          "type": "FieldValue",
          "id": "3964",
          "value": "Europe"
        },
        {
          "type": "FieldValue",
          "id": "3963",
          "value": "Female"
        },
        {
          "type": "FieldValue",
          "id": "3961",
          "value": "No"
        }
      ],
      "isMapped": "Yes",
      "uniqueCode": "anna.nystrom@oracle.com"
    },
    {
      "type": "EventRegistrationData",
      "id": "332378",
      "createdAt": "1493232353",
      "name": "terry@oracle.com",
      "updatedAt": "1493232353",
      "fieldValues": [
        {
          "type": "FieldValue",
          "id": "3958",
          "value": "terry@oracle.com"
        },
        {
          "type": "FieldValue",
          "id": "3959",
          "value": "Terry"
        },
        {
          "type": "FieldValue",
          "id": "3960",
          "value": "Education"
        },
        {
          "type": "FieldValue",
          "id": "3962",
          "value": "Married"
        },
        {
          "type": "FieldValue",
          "id": "3964",
          "value": "North America"
        },
        {
          "type": "FieldValue",
          "id": "3963",
          "value": "Multiple"
        },
        {
          "type": "FieldValue",
          "id": "3961",
          "value": "Yes"
        }
      ],
      "isMapped": "No",
      "uniqueCode": "terry@oracle.com"
    }
  ],
  "page": 1,
  "pageSize": 1000,
  "total": 3
}
Back to Top