REST API for Oracle Eloqua Marketing Cloud Service

Retrieve an event registrant

get

/api/rest/2.0/data/eventRegistration/{parentId}/instance/{id}

Retrieves the registrant for the event specified by the parentId and id parameters.

Request

Supported Media Types

application/json

Path Parameters

id(required): integer

Id of the event registrant.
parentId(required): integer

Id of the parent event.

Query Parameters

depth: string

This parameter is not used for this endpoint.

Response

Supported Media Types

application/json

200 Response

OK.

Root Schema : EventRegistrationData

Type: object

Title: EventRegistrationData

Show Source

accountId: string

The account record Id associated to this event registrant. This is a read-only property.
contactId: string

The contact record Id associated to this event registrant. Use the desired contact's id as the value for this parameter.
createdAt: string

Read Only: true

The date and time the event registrant was created, expressed in Unix time. This is a read-only property.
createdBy: string

Read Only: true

This property is not used for event registrants.
createdByName: string

This property is not used for event registrants.
currentStatus: string

This property is not used for event registrants.
customObjectRecordStatus: string

The status of the event registrant. Only returned when creating or updating an event registrant. This is a read-only property.
depth: string

Read Only: true

This property is not used for event registrants.
description: string

This property is not used for event registrants.
fieldValues: array fieldValues

Array containing type, id, and value for all of the fields associated with a given event registrant.
folderId: string

Read Only: true

This property is not used for event registrants.
id: string

Read Only: true

Id of the event registrant. This is a read-only property.
isMapped: string

Whether or not the event registrant is mapped to a contact or account. This is a read-only property.
name: string

The name of the event registrant. This is a read-only property.
permissions: array permissions

This property is not used for event registrants.
scheduledFor: string

Read Only: true

This property is not used for event registrants.
sourceTemplateId: string

This property is not used for event registrants.
type: string

The asset's type in Eloqua. This is a read-only property.
uniqueCode: string

The unique value associated to the event registrant. This is a read-only property.
updatedAt: string

Read Only: true

Unix timestamp for the date and time the event registrant was last updated. This is a read-only property.
updatedBy: string

Read Only: true

This property is not used for event registrants.
updatedByName: string

This property is not used for event registrants.

{
    "title":"EventRegistrationData",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property. "
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"Id of the event registrant. This is a read-only property."
        },
        "currentStatus":{
            "type":"string",
            "description":"This property is not used for event registrants."
        },
        "name":{
            "type":"string",
            "description":"The name of the event registrant. This is a read-only property."
        },
        "description":{
            "type":"string",
            "description":"This property is not used for event registrants."
        },
        "permissions":{
            "type":"array",
            "description":"This property is not used for event registrants.",
            "items":{
                "type":"string"
            }
        },
        "folderId":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event registrants."
        },
        "sourceTemplateId":{
            "type":"string",
            "description":"This property is not used for event registrants."
        },
        "createdBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event registrants."
        },
        "createdByName":{
            "type":"string",
            "description":"This property is not used for event registrants."
        },
        "createdAt":{
            "type":"string",
            "readOnly":true,
            "description":"The date and time the event registrant was created, expressed in Unix time. This is a read-only property."
        },
        "updatedBy":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event registrants."
        },
        "updatedByName":{
            "type":"string",
            "description":"This property is not used for event registrants."
        },
        "updatedAt":{
            "type":"string",
            "readOnly":true,
            "description":"Unix timestamp for the date and time the event registrant was last updated. This is a read-only property."
        },
        "scheduledFor":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event registrants."
        },
        "depth":{
            "type":"string",
            "readOnly":true,
            "description":"This property is not used for event registrants."
        },
        "contactId":{
            "type":"string",
            "description":"The contact record Id associated to this event registrant. Use the desired contact's id as the value for this parameter."
        },
        "accountId":{
            "type":"string",
            "description":"The account record Id associated to this event registrant. This is a read-only property."
        },
        "uniqueCode":{
            "type":"string",
            "description":"The unique value associated to the event registrant. This is a read-only property."
        },
        "customObjectRecordStatus":{
            "type":"string",
            "description":"The status of the event registrant. Only returned when creating or updating an event registrant. This is a read-only property."
        },
        "fieldValues":{
            "type":"array",
            "description":"Array containing <code>type</code>, <code>id</code>, and <code>value</code> for all of the fields associated with a given event registrant.",
            "items":{
                "$ref":"#/definitions/FieldValueRest20"
            }
        },
        "isMapped":{
            "type":"string",
            "description":"Whether or not the event registrant is mapped to a contact or account. This is a read-only property."
        }
    }
}

Nested Schema : fieldValues

Type: array

Array containing type, id, and value for all of the fields associated with a given event registrant.

Show Source

Array of: object FieldValue

Title: FieldValue

{
    "type":"array",
    "description":"Array containing <code>type</code>, <code>id</code>, and <code>value</code> for all of the fields associated with a given event registrant.",
    "items":{
        "$ref":"#/definitions/FieldValueRest20"
    }
}

Nested Schema : permissions

Type: array

This property is not used for event registrants.

Show Source

Array of: string

{
    "type":"array",
    "description":"This property is not used for event registrants.",
    "items":{
        "type":"string"
    }
}

Nested Schema : FieldValue

Type: object

Title: FieldValue

Show Source

id: string

Read Only: true

The id of the field to be set to the corresponding value.
name: string

Name of the field value.
type: string

The asset's type in Eloqua. This is a read-only property.
value: string

The value to set the corresponding field id to. Date values must be submitted as a unix timestamp.

{
    "title":"FieldValue",
    "properties":{
        "type":{
            "type":"string",
            "description":"The asset's type in Eloqua. This is a read-only property."
        },
        "value":{
            "type":"string",
            "description":"The value to set the corresponding field id to. Date values must be submitted as a unix timestamp."
        },
        "id":{
            "type":"string",
            "readOnly":true,
            "description":"The id of the field to be set to the corresponding value."
        },
        "name":{
            "type":"string",
            "description":"Name of the field value."
        }
    }
}

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.

Examples

Retrieve the event registrant whose Id# is 332375, for the event with the Id# 1260:


GET /api/REST/2.0/data/eventRegistration/1260/instance/332375

Response:


{
  "type": "EventRegistrationData",
  "id": "332375",
  "createdAt": "1493161593",
  "name": "john.doe@oracle.com",
  "updatedAt": "1493161644",
  "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": "Male"
    },
    {
      "type": "FieldValue",
      "id": "3964",
      "value": "North America"
    },
    {
      "type": "FieldValue",
      "id": "3963",
      "value": "Married"
    },
    {
      "type": "FieldValue",
      "id": "3961",
      "value": "Yes"
    }
  ],
  "isMapped": "No",
  "uniqueCode": "john.doe@oracle.com"
}