Ready to Learn?Ex Libris products all provide open APIs

Send Alerts

campusM allows institutions to send alerts to their users. These are delivered as push notifications for the native iOS/Android apps.

 

Prerequisites

To utilize the API the following is required:

  • campusM service endpoint: https://<campusM_server_name</axis2v3/services/CampusMService/sendAlerts
  • Organization Code (orgCode)
  • API key (password)

In case you do not have your orgCode and password, please submit a support ticket in the Ex Libris CRM (http://exlidp.exlibrisgroup.com/).

 

Send Alerts to Individuals

The following sample request is used to send an alert to a single or a number of individuals:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="http://campusm.gw.com/campusm">
   <soapenv:Header/>
   <soapenv:Body>
      <cam:sendAlertsRequest> 

       <!-- Institution & Live/Dev Environment Identification -->   
         <cam:orgCode>*******************</cam:orgCode>
         <cam:password>*******************</cam:password>

         <cam:notifications>

           <!-- One or more messages to send -->
            <cam:notification>
               
                <!-- One or more recipients per message -->
               <cam:notificationTargets>
                 <cam:notificationTarget>
                    <cam:emailAddress>*******************@******.***</cam:emailAddress>
                 </cam:notificationTarget>
                 <cam:notificationTarget>
                    <cam:emailAddress>*******************@******.***</cam:emailAddress>
                 </cam:notificationTarget>
               </cam:notificationTargets>

                <!-- Title and body of the alert -->
               <cam:note>Hello world</cam:note>
               <cam:message>This is a test message.</cam:message>

                <!-- Additional input - NOT IN USE -->
               <cam:forceSms>N</cam:forceSms>
               <cam:forceEmail>N</cam:forceEmail>
               <cam:forceCampusmNotification>Y</cam:forceCampusmNotification>
               <cam:priority>DEFAULT</cam:priority>
               <cam:category>DEFAULT</cam:category>
            </cam:notification>
         </cam:notifications>
      </cam:sendAlertsRequest>
   </soapenv:Body>
</soapenv:Envelope>
 

Send Alerts to Groups

The following sample request is used to send an alert to a notifications group:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="http://campusm.gw.com/campusm">
   <soapenv:Header/>
   <soapenv:Body>
      <cam:sendAlertsRequest> 

       <!-- Institution & Live/Dev Environment Identification -->   
         <cam:orgCode>*******************</cam:orgCode>
         <cam:password>*******************</cam:password>

         <cam:notifications>

           <!-- One or more messages to send -->
            <cam:notification>
               
                <!-- One or more recipients per message -->
               <cam:notificationTargets>
                 <cam:notificationTarget>
                    <cam:groupCode>Insert Group Code</cam:groupCode>
                 </cam:notificationTarget>
               </cam:notificationTargets>

                <!-- Title and body of the alert -->
               <cam:note>Hello world</cam:note>
               <cam:message>This is a test message.</cam:message>

                <!-- Additional input - NOT IN USE -->
               <cam:forceSms>N</cam:forceSms>
               <cam:forceEmail>N</cam:forceEmail>
               <cam:forceCampusmNotification>Y</cam:forceCampusmNotification>
               <cam:priority>DEFAULT</cam:priority>
               <cam:category>DEFAULT</cam:category>
            </cam:notification>
         </cam:notifications>
      </cam:sendAlertsRequest>
   </soapenv:Body>
</soapenv:Envelope>

 

HTML Alert Body Example (CDATA Tags)

Please note: There is a 8000 character limit imposed on the length of the alert body.
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="http://campusm.gw.com/campusm">
   <soapenv:Header/>
   <soapenv:Body>
      <cam:sendAlertsRequest> 

       <!-- Institution & Live/Dev Environment Identification -->   
         <cam:orgCode>*******************</cam:orgCode>
         <cam:password>*******************</cam:password>

         <cam:notifications>

           <!-- One or more messages to send -->
            <cam:notification>
               
                <!-- One or more recipients per message -->
               <cam:notificationTargets>
                 <cam:notificationTarget>
                    <cam:emailAddress>*******************@******.***</cam:emailAddress>
                 </cam:notificationTarget>
                 <cam:notificationTarget>
                    <cam:emailAddress>*******************@******.***</cam:emailAddress>
                 </cam:notificationTarget>
               </cam:notificationTargets>

                <!-- Title and body of the alert -->
               <cam:note>Why Ex Libris campusM?</cam:note>
               <cam:message>
                 <![CDATA[
                   <img src="http://www.campusm.com/wp-content/uploads/2015/02/campusm-student-devices.png"/><br />   
                   <b>Why campusM?</b>
                   <br/> Many mobile app providers will say that they deliver integrated, personalized services to your students<br /> 
                   However, only campusM really can provide you with a rich experience, as individual as the user.<br /> <br /> 
                   <a href="http://www.campusm.com/">campuM The Future Of Student Engagement</a>
                   <br/>
                 ]]>

               <!-- Additional input - NOT IN USE -->
               <cam:forceSms>N</cam:forceSms>
               <cam:forceEmail>N</cam:forceEmail>
               <cam:forceCampusmNotification>Y</cam:forceCampusmNotification>
               <cam:priority>DEFAULT</cam:priority>
               <cam:category>DEFAULT</cam:category>
            </cam:notification>
         </cam:notifications>
      </cam:sendAlertsRequest>
   </soapenv:Body>
</soapenv:Envelope>