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
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
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

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