Get Poll Results

NAVIGATE CONTENT
Ex Libris Developer Network campusM Documentation campusM APIs Get Poll Results

This API service provides the ability to securely extract Quick Poll response data.

Resource URL 

GET /​campusm/​v1/​addons/​getPollResults 

URL Parameters 

None 

The hostname corresponds to the region where your campusM instance is hosted. For getting started using API keys, your org code and calling your campusM regional API hostname, please refer to this.

Query string Parameters

Parameter Type Required Description 
orgCode xsd:int Required Supplied by Ex Libris as part of the implementation 
startDate xsd:dateTime Required Start date (in UTC) of the date range for the Quick Polls to be retrieve. Returned Polls will be based on the Poll start date falling within the range defined by this start and end date. 
endDate xsd:dateTime Required End date (in UTC) of the date range for the Quick Polls to be retrieve. Returned Polls will be based on the Poll start date falling within the range defined by this start and end date.
(the allowed date range is 7 days from the startDate) 
apiKey xsd:string Required Supplied by Ex Libris as part of the implementation 
pollID xsd:int Optional ID code to retrieve results for a specific Quick Poll defined by said ID number 
emailAddress xsd:string Optional Will just retrieve the Quick Poll results for a particular email address which typically matches the email address stored in the University IdP/ LDAP 
resumptionToken xsd:string Optional Token used to return the next segment of rows from the service if the isFinished flag is false. The resumptionToken is sent in the response 

Body Parameters 

None 

Example 

URL –   

https://api-eu.hosted.exlibrisgroup.com/campusm/v1/addons/ getPollResults?apiKey=<API KEY>&orgCode=<ORG CODE>&startDate=<START DATE>&endDate=<END DATE>&pollId=<POLL ID>&emailAddress=<EMAIL ADDRESS> 

Output 
This service returns a list of pollEntry object. 
Description: 
Field Type Description 
pollEntry pollItem List of poll report item objects 
resumptionToken xsd:string Token used to return the next segment of rows from the service if the isFinished flag is false 
isFinished xsd:boolean Flag that identifies if there is further data to be returned by the service following the initial request 
Click here to view the xsd file. 
See a sample response at the end of this document. Below is a breakdown of the core response object, the PollItem.
PollItem 
Field Type Description 
orgCode xsd:string campusM Organisation that this check in refers to 
pollId xsd:string ID code to retrieve results for a specific Quick Poll defined by saiduniqueID number 
question xsd:string Question text for the Quick Poll 
startDate xsd:dateTime Date and time of the Quick Poll open 
endDate xsd:dateTime Date and time of the Quick Poll close 
responseDate xsd:dateTime Date and time of theusersresponse recorded in the Ex Libris Cloud 
personID xsd:string campusMuser reference number 
personEmail 
 
xsd:string Email address of the responded user 
answerId xsd:string Unique reference number for the answer 
answer xsd:string Answer text 
Samples 
XML 
<ns1:pollResponse xmlns:ns1="http://campusm.gw.com/campusm"> 
    <ns1:pollEntry> 
        <ns1:orgCode>212</ns1:orgCode> 
        <ns1:pollId>143</ns1:pollId> 
        <ns1:question>Are you experiencing one or more of the following symptoms? A high temperature; a new, continuous cough; a loss or change to your sense of smell or taste.</ns1:question> 
        <ns1:startDate>2020-07-13T09:00:00.000+00:00</ns1:startDate> 
        <ns1:endDate>2020-07-14T09:00:00.000+00:00</ns1:endDate> 
        <ns1:responseDate>2020-07-13T09:18:58.000+00:00</ns1:responseDate> 
        <ns1:personId>XXXX</ns1:personId> 
        <ns1:personEmail>XXXX</ns1:personEmail> 
        <ns1:answerId>203</ns1:answerId> 
        <ns1:answer>YES</ns1:answer> 
    </ns1:pollEntry> 
    <ns1:pollEntry> 
        <ns1:orgCode>212</ns1:orgCode> 
        <ns1:pollId>143</ns1:pollId> 
        <ns1:question>Are you experiencing one or more of the following symptoms? A high temperature; a new, continuous cough; a loss or change to your sense of smell or taste.</ns1:question> 
        <ns1:startDate>2020-07-13T09:00:00.000+00:00</ns1:startDate> 
        <ns1:endDate>2020-07-14T09:00:00.000+00:00</ns1:endDate> 
        <ns1:responseDate>2020-07-13T09:28:32.000+00:00</ns1:responseDate> 
        <ns1:personId>XXXX</ns1:personId> 
        <ns1:personEmail>XXXX</ns1:personEmail> 
        <ns1:answerId>204</ns1:answerId> 
        <ns1:answer>NO</ns1:answer> 
    </ns1:pollEntry> 
    <ns1:pollEntry> 
        <ns1:orgCode>212</ns1:orgCode> 
        <ns1:pollId>143</ns1:pollId> 
        <ns1:question>Are you experiencing one or more of the following symptoms? A high temperature; a new, continuous cough; a loss or change to your sense of smell or taste.</ns1:question> 
        <ns1:startDate>2020-07-13T09:00:00.000+00:00</ns1:startDate> 
        <ns1:endDate>2020-07-14T09:00:00.000+00:00</ns1:endDate> 
        <ns1:responseDate>2020-07-13T09:33:14.000+00:00</ns1:responseDate> 
        <ns1:personId>XXXX</ns1:personId> 
        <ns1:personEmail>XXXX</ns1:personEmail> 
        <ns1:answerId>204</ns1:answerId> 
        <ns1:answer>NO</ns1:answer> 
    </ns1:pollEntry> 
    <ns1:pollEntry> 
        <ns1:orgCode>212</ns1:orgCode> 
        <ns1:pollId>143</ns1:pollId> 
        <ns1:question>Are you experiencing one or more of the following symptoms? A high temperature; a new, continuous cough; a loss or change to your sense of smell or taste.</ns1:question> 
        <ns1:startDate>2020-07-13T09:00:00.000+00:00</ns1:startDate> 
        <ns1:endDate>2020-07-14T09:00:00.000+00:00</ns1:endDate> 
        <ns1:responseDate>2020-07-13T09:49:48.000+00:00</ns1:responseDate> 
        <ns1:personId>XXXX</ns1:personId> 
        <ns1:personEmail>XXXX</ns1:personEmail> 
        <ns1:answerId>204</ns1:answerId> 
        <ns1:answer>NO</ns1:answer> 
    </ns1:pollEntry> 
    <ns1:pollEntry> 
        <ns1:orgCode>212</ns1:orgCode> 
        <ns1:pollId>143</ns1:pollId> 
        <ns1:question>Are you experiencing one or more of the following symptoms? A high temperature; a new, continuous cough; a loss or change to your sense of smell or taste.</ns1:question> 
        <ns1:startDate>2020-07-13T09:00:00.000+00:00</ns1:startDate> 
        <ns1:endDate>2020-07-14T09:00:00.000+00:00</ns1:endDate> 
        <ns1:responseDate>2020-07-13T09:26:46.000+00:00</ns1:responseDate> 
        <ns1:personId>XXXX</ns1:personId> 
        <ns1:personEmail>XXXX</ns1:personEmail> 
        <ns1:answerId>204</ns1:answerId> 
        <ns1:answer>NO</ns1:answer> 
    </ns1:pollEntry> 
    <ns1:pollEntry> 
        <ns1:orgCode>212</ns1:orgCode> 
        <ns1:pollId>143</ns1:pollId> 
        <ns1:question>Are you experiencing one or more of the following symptoms? A high temperature; a new, continuous cough; a loss or change to your sense of smell or taste.</ns1:question> 
        <ns1:startDate>2020-07-13T09:00:00.000+00:00</ns1:startDate> 
        <ns1:endDate>2020-07-14T09:00:00.000+00:00</ns1:endDate> 
        <ns1:responseDate>2020-07-13T09:27:29.000+00:00</ns1:responseDate> 
        <ns1:personId>XXXX</ns1:personId> 
        <ns1:personEmail>XXXX</ns1:personEmail> 
        <ns1:answerId>204</ns1:answerId> 
        <ns1:answer>NO</ns1:answer> 
    </ns1:pollEntry> 
    <ns1:pollEntry> 
        <ns1:orgCode>212</ns1:orgCode> 
        <ns1:pollId>143</ns1:pollId> 
        <ns1:question>Are you experiencing one or more of the following symptoms? A high temperature; a new, continuous cough; a loss or change to your sense of smell or taste.</ns1:question> 
        <ns1:startDate>2020-07-13T09:00:00.000+00:00</ns1:startDate> 
        <ns1:endDate>2020-07-14T09:00:00.000+00:00</ns1:endDate> 
        <ns1:responseDate>2020-07-13T09:31:03.000+00:00</ns1:responseDate> 
        <ns1:personId>XXXX</ns1:personId> 
        <ns1:personEmail>XXXX</ns1:personEmail> 
        <ns1:answerId>204</ns1:answerId> 
        <ns1:answer>NO</ns1:answer> 
    </ns1:pollEntry> 
    <ns1:isFinished>true</ns1:isFinished> 
</ns1:pollResponse>