Event Registration

What can you do with EventRegistration?


Properties

Property Details
id
"id": 118
Type: Number
This is the unique numeric identifier for the EventRegistration
eventDtoTypeKey
"eventDtoTypeKey": "Hello World"
Type: String
eventActionTypeId
"eventActionTypeId": 99
Type: Number
Unique identifier for the associated EventActionType object.
eventQueueTypeId
"eventQueueTypeId": 504
Type: Number
Unique identifier for the associated EventQueueType object.
isRetrieved
"isRetrieved": true
Type: Boolean
isTracked
"isTracked": true
Type: Boolean
isActive
"isActive": true
Type: Boolean
isSystem
"isSystem": true
Type: Boolean
name
"name": "Hello World"
Type: String
tokenContextTypeId
"tokenContextTypeId": 108
Type: Number
Unique identifier for the associated TokenContextType object.


Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • eventDtoTypeKey
  • eventActionTypeId
  • eventQueueTypeId
  • isRetrieved
  • isTracked
  • isActive
  • isSystem
  • name
  • tokenContextTypeId

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the EventRegistration object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

GETapi/v1/EventRegistration
Retrieve all of the EventRegistration objects.
GETapi/v1/EventRegistration/Metadata
Retrieve all of the meta data details of the EventRegistration object.
GETapi/v1/EventRegistration/Metadata/{option}
Retrieve all the meta data details of the EventRegistration object based on provided options.
{option}Metadata options for the EventRegistration object.
GETapi/v1/EventRegistration/Paged
Retreive all of the EventRegistration objects in a paged fashion.
GETapi/v1/EventRegistration/Paged/Detail
Retreive all of the EventRegistration objects in a paged fashion with all object details.
GETapi/v1/EventRegistration/{id:int}
Retrieve an instance of the EventRegistration object by it's ID.
{id:int}Unique identifier for the EventRegistration object.
GETapi/v1/EventRegistration/{id:int}/Detail
Retreive all of the Detail objects for the specified EventRegistration.
{id:int}Unique identifier for the EventRegistration object.