Retrieve an event

get

/api/REST/2.0/assets/eventRegistration/{id}

Retrieves the event specified by the id parameter.

Request

Supported Media Types
Path Parameters
Query Parameters
  • Level of detail returned by the request. Eloqua APIs can retrieve entities at three different levels of depth: minimal, partial, and complete. Any other values passed are reset to complete by default. For more information, see Request depth.
Back to Top

Response

Supported Media Types

200 Response

OK.
Body ()
Root Schema : EventRegistration
Type: object
Title: EventRegistration
Show Source
Nested Schema : fields
Type: array
Array consisting of event field properties.
Show Source
Nested Schema : permissions
Type: array
This property is not used for events.
Show Source
Nested Schema : sessionFields
Type: array
Array consisting of session fields within a session.
Show Source
Nested Schema : sessionFieldValues
Type: array
Array consisting of session fields values for a session. You must create session fields and session before creating the session field values.
Show Source
Nested Schema : sessions
Type: array
Array consisting of event sessions.
Show Source
Nested Schema : CustomObjectField
Type: object
Title: CustomObjectField
Show Source
Nested Schema : permissions
Type: array
This property is not used.
Show Source
Nested Schema : EventSessionField
Type: object
Title: EventSessionField
Show Source
Nested Schema : FieldOutputFormat
Type: object
Title: FieldOutputFormat
Show Source
Nested Schema : permissions
Type: array
This property is not used.
Show Source
Nested Schema : EventSessionFieldValue
Type: object
Title: EventSessionFieldValue
Show Source
Nested Schema : permissions
Type: array
This property is not used.
Show Source
Nested Schema : EventSession
Type: object
Title: EventSession
Show Source
Nested Schema : permissions
Type: array
This property is not used.
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 the event with Id #15:


GET /api/REST/2.0/assets/eventRegistration/15
			

Response:


{
  "type": "EventRegistration",
  "id": "15",
  "createdAt": "1458745461",
  "createdBy": "13",
  "depth": "complete",
  "description": "",
  "folderId": "81",
  "name": "Example Event",
  "updatedAt": "1464631246",
  "updatedBy": "13",
  "emailAddressFieldId": "34",
  "fields": [
    {
      "type": "CustomObjectField",
      "id": "32",
      "depth": "complete",
      "name": "First Name",
      "dataType": "text",
      "displayType": "text",
      "internalName": "First_Name1"
    },
    {
      "type": "CustomObjectField",
      "id": "33",
      "depth": "complete",
      "name": "Last Name",
      "dataType": "text",
      "displayType": "text",
      "internalName": "Last_Name1"
    },
    {
      "type": "CustomObjectField",
      "id": "34",
      "depth": "complete",
      "name": "Email Address",
      "dataType": "text",
      "displayType": "text",
      "internalName": "Email_Address1"
    },
    {
      "type": "CustomObjectField",
      "id": "37",
      "depth": "complete",
      "name": "City",
      "dataType": "text",
      "defaultValue": "New York",
      "displayType": "text",
      "internalName": "City1"
    },
    {
      "type": "CustomObjectField",
      "id": "35",
      "depth": "complete",
      "name": "Job Role",
      "dataType": "text",
      "displayType": "singleSelect",
      "internalName": "Job_Role1",
      "optionListId": "6"
    },
    {
      "type": "CustomObjectField",
      "id": "36",
      "depth": "complete",
      "name": "Industry",
      "dataType": "text",
      "defaultValue": "Business Software",
      "displayType": "singleSelect",
      "internalName": "Industry1",
      "optionListId": "9"
    }
  ],
  "sessionFields": [
    {
      "type": "EventSessionField",
      "id": "2",
      "name": "Date",
      "dataType": "date"
    }
  ],
  "sessions": [],
  "uniqueCodeFieldId": "34"
}
			
Back to Top