Get Event Registration Summary

This RESTful API service provides the ability to get a summary of event registrations data.

Resource URL:

GET /campusm/v1/cmrest/eventRegistrations/<ORG CODE>/getRegistrations

Query string parameters

NameTypeRequiredDescription
apiKeyStringRequiredSupplied by Ex Libris as part of the implementation
productInstanceIdNumberRequiredThe Product integration number represents the Events instance. This can be found in the URL of the Product Integration Instance in App Manager: https://appmanager.ombiel.com/product-integrations/events2/13975
eventIdStringOptionalAn event ID as registered in the system
titleStringOptionalThe event title
startTimeISO-Date (yyyy-MM-dd)OptionalThe beginning of time to check against (start time of the events)
endTimeISO-Date (yyyy-MM-dd)OptionalThe end of time to check against (start time of the events)

Notice: a request MUST contain either an event ID, a date range (startDate and endDate), or a Title and startDate

Path parameters

NameTypeRequiredDescription
org CodeNumberRequiredSupplied by Ex Libris as part of the implementation

 

Example

https://api-eu.hosted.exlibrisgroup.com/campusm/v1/cmrest/eventRegistrations/<ORG CODE>/getRegistrations/?productInstanceId=<Product Integration ID>&eventId=<EVENT ID>

Output

The service returns an EventsSummary JSON object

Description

 

NameTypeDescription
dataEventSummary:listA list of events

 

EventSummary

NameTypeDescription
eventIdStringAn event ID as registered in the system
titleStringThe event’s title as displayed in the campusM application
dateISO-Date (yyy-MM-ddTHH:mm:ssZ)The timestamp of when the event start date as returned from the campusM application
attendeesEventAttendee:listThe list of users who have registered to the event

 

EventAttendee

NameTypeDescription
firstNameStringThe first name of a user
lastNameStringThe last name of a user
emailsString:listA list of emails associated with a user
checkedinBooleanIdentifies if the registered attendee checked in to the event to not

 

Sample Response

"data":[
   {
      "eventId":"Event_ID",
      "title":"Event Title",
      "date":"2021-05-21T00:00:00Z",
      "attendees":[
         {
            "firstName":"XXX",
            "lastName":"XXXXX",
            "emails":[
               "user@email.com"
            ],
            "checkedin":false
         },
         {
            "firstName":"XXXXX",
            "lastName":"XXXXXXX",
            "emails":[
               "user2@emailS.com"
            ],
            "checkedin":true
         }
      ]
   }
]