Get Event Registration Summary

Ex Libris Developer Network campusM Documentation campusM APIs 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

Name	Type	Required	Description
apiKey	String	Required	Supplied by Ex Libris as part of the implementation
productInstanceId	Number	Required	The 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
eventId	String	Optional	An event ID as registered in the system
title	String	Optional	The event title
startTime	ISO-Date (yyyy-MM-dd)	Optional	The beginning of time to check against (start time of the events)
endTime	ISO-Date (yyyy-MM-dd)	Optional	The end of time to check against (start time of the events)
attributeName	xsd:string	Optional	Define the User Attribute field name defined against your users. Should be combined with and attributeValue
attributeValue	xsd:string	Optional	Define the User Attribute value to use to filter the results for a particular user

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

Path parameters

Name	Type	Required	Description
org Code	Number	Required	Supplied 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

Name	Type	Description
data	EventSummary:list	A list of events

EventSummary

Name	Type	Description
eventId	String	An event ID as registered in the system
title	String	The event’s title as displayed in the campusM application
date	ISO-Date (yyy-MM-ddTHH:mm:ssZ)	The timestamp of when the event start date as returned from the campusM application
attendees	EventAttendee:list	The list of users who have registered to the event

EventAttendee

Name	Type	Description
firstName	String	The first name of a user
lastName	String	The last name of a user
emails	String:list	A list of emails associated with a user
checkedin	Boolean	Identifies 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
         }
      ]
   }
]