Get Contact Tracing Results

NAVIGATE CONTENT
Ex Libris Developer Network campusM Documentation campusM APIs Get Contact Tracing Results

This API service provides the ability to securely extract Contact Tracing response data. 

GET Method  

 Resource URL  

GET /​campusm/​v1/​addons/​contactTracingReport  

 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 Contact Tracing responses to be retrieved.  
endDate  xsd:dateTime  Required  End date (in UTC) of the date range for the Contact Tracing responses to be retrieved.  
(the allowed date range is 7 days from the startDate)  
apiKey  xsd:string  Required  Supplied by Ex Libris as part of the implementation  
emailAddress  xsd:string  Optional  Will just retrieve the Contact Tracing results for a particular email address which typically matches the email address stored in the University IdP/ LDAP  
locationId xsd:string  Optional   
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/ contactTracingReport?apiKey=<API KEY>&orgCode=<ORG CODE>&startDate=<START DATE>&endDate=<END DATE>&emailAddress=<EMAIL ADDRESS>&locationID=<LOCATION ID>  

​ 

POST Method  

Resource URL  

POST /​campusm/​v1/​addons/​contactTracingReport 

URL Parameters  

None  

Query string Parameters  

Parameter  Type  Required  Description  
apiKey  xsd:string  Required  Supplied by Ex Libris as part of the implementation  

Body 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 Contact Tracing responses to be retrieved.  
endDate  xsd:dateTime  Required  End date (in UTC) of the date range for the Contact Tracing responses to be retrieved.  
(the allowed date range is 7 days from the startDate)  
apiKey  xsd:string  Required  Supplied by Ex Libris as part of the implementation  
emailAddress  xsd:string  Optional  Will just retrieve the Contact Tracing results for a particular email address which typically matches the email address stored in the University IdP/ LDAP  
locationId xsd:string  Optional   
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  

 

Enter the parameters as a raw text in the body of the request such as the following text and fill in the fields with actual data:  

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="http://campusm.gw.com/campusm">  
   <soapenv:Header/>  
   <soapenv:Body> 
      <cam: ContactTracingReportRequest>  
         <cam:orgCode>123456789</cam:orgCode>  
         <cam:startDate>2020-07-11T00:00:00</cam:startDate>  
         <cam:endDate>2020-07-15T00:00:00</cam:endDate>  
         <!--Optional:-->  
         <cam:locationId></cam:locationId>  
         <!--Optional:-->  
         <cam:emailAddress>matt@rolesdemo.com</cam:emailAddress>  
         <!--Optional:-->  
         <cam:resumptionToken></cam:resumptionToken>  
      </cam: ContactTracingReportRequest>  
   </soapenv:Body>  
</soapenv:Envelope>

 

Example  

URL –  
https://api-eu.hosted.exlibrisgroup.com/campusm/v1/addons/ contactTracingReport?apiKey=<API KEY>  

Body –  

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cam="http://campusm.gw.com/campusm">  
   <soapenv:Header/>  
   <soapenv:Body>  
      <cam: ContactTracingReportRequest>  
         <cam:orgCode>123456879</cam:orgCode>  
         <cam:startDate>2020-07-11T00:00:00</cam:startDate>  
         <cam:endDate>2020-07-15T00:00:00</cam:endDate>  
         <!--Optional:-->  
         <cam:locationId></cam:locationId>  
         <!--Optional:-->  
         <cam:emailAddress>matt@rolesdemo.com</cam:emailAddress>  
         <!--Optional:-->  
         <cam:resumptionToken></cam:resumptionToken>  
      </cam: ContactTracingReportRequest>  
   </soapenv:Body>  
</soapenv:Envelope>

 

Output  

This service returns a list of ContactTracingReportResponse object.  

Description:  

Field  Type  Description  
contactTracing Entry  contactTracing Item  List of Contact Tracing 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  

Below is a breakdown of the core response object, the contactTracing Item . 

contactTracing Item 

 

Field  Type  Description  
contactTracingId xsd:string  Unique contact tracing transition ID 
orgCode  xsd:string  campusM Organisation that this check in refers to  
personId xsd:string  campusM user reference number 
emailAddress xsd:string  Email address of the user 
locationName xsd:string  Location description encoded in QR Code 
locationID xsd:string  Location code encoded in QR Code 
tracingDate xsd:dateTime  Date and time that the Contact Tracing QR code was scanned 
campusId xsd:string  Campus ID code encoded in QR Code 
params1 xsd:string  Params string encoded in QR Code 
params2 xsd:string  Params string encoded in QR Code 
productInstanceId xsd:int Product Integration Instance code used to identify the Product Integration instance used to capture the QR code 

Response XSD

 

<?xml version="1.0" encoding="UTF-8"?>
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
  xmlns="http://campusm.gw.com/campusm" attributeFormDefault="unqualified"
  elementFormDefault="qualified" targetNamespace="http://campusm.gw.com/campusm">

  <xsd:include schemaLocation="returnStatus.xsd" />

  <xsd:element name="ContactTracingReportRequest">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="orgCode" type="xsd:int" minOccurs="1" maxOccurs="1"/>
        <xsd:element name="startDate" type="xsd:dateTime" minOccurs="1" maxOccurs="1" />
        <xsd:element name="endDate" type="xsd:dateTime" minOccurs="1" maxOccurs="1" />
        <xsd:element name="emailAddress" type="xsd:string" minOccurs="0" maxOccurs="1"/>
        <xsd:element name="locationId" type="xsd:string" minOccurs="0" maxOccurs="1"/>
        <xsd:element name="resumptionToken" type="xsd:string" minOccurs="0" maxOccurs="1"/>
        <xsd:element name="apiKey" type="xsd:string" minOccurs="0" maxOccurs="1"/>
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>
  
  <xsd:element name="ContactTracingReportResponse">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="ContactTracingEntry" type="ContactTracingReportItem" minOccurs="0" maxOccurs="unbounded" />
        <xsd:element name="resumptionToken" type="xsd:string" minOccurs="0" maxOccurs="1"/>
        <xsd:element name="isFinished" type="xsd:boolean" minOccurs="0" maxOccurs="1"/>
      </xsd:sequence>
    </xsd:complexType>
  </xsd:element>

  <xsd:complexType name="ContactTracingReportItem">
    <xsd:sequence>
      <xsd:element name="contactTracingid" type="xsd:string" minOccurs="0" maxOccurs="1" />
      <xsd:element name="orgCode" type="xsd:string" minOccurs="1" maxOccurs="1" />
      <xsd:element name="personId" type="xsd:string" minOccurs="0" maxOccurs="1"/>
      <xsd:element name="locationName" type="xsd:string" minOccurs="0" maxOccurs="1" />
      <xsd:element name="locationId" type="xsd:string" minOccurs="0" maxOccurs="1" />
      <xsd:element name="tracingDate" type="xsd:dateTime" minOccurs="0" maxOccurs="1" />
      <xsd:element name="campusId" type="xsd:string" minOccurs="0" maxOccurs="1" />
      <xsd:element name="params1" type="xsd:string" minOccurs="0" maxOccurs="1" />
      <xsd:element name="params2" type="xsd:string" minOccurs="0" maxOccurs="1" />
      <xsd:element name="productInstanceId" type="xsd:int" minOccurs="0" maxOccurs="1" />
    </xsd:sequence>
  </xsd:complexType>
  
</xsd:schema>

 

Samples  Response

XML  

<ns1:ContactTracingReportResponse xmlns:ns1="http://campusm.gw.com/campusm"> 
    <ns1:ContactTracingEntry> 
        <ns1:contactTracingid>361</ns1:contactTracingid> 
        <ns1:orgCode>212</ns1:orgCode> 
        <ns1:personId>50371</ns1:personId> 
        <ns1:locationName>Main Library</ns1:locationName> 
        <ns1:locationId>12345</ns1:locationId> 
        <ns1:tracingDate>2020-09-01T11:33:27.000+00:00</ns1:tracingDate> 
        <ns1:campusId>Main Library</ns1:campusId> 
        <ns1:params1>Parameter1</ns1:params1> 
        <ns1:params2>Parameter2</ns1:params2> 
        <ns1:productInstanceId>0</ns1:productInstanceId> 
    </ns1:ContactTracingEntry> 
    <ns1:ContactTracingEntry> 
        <ns1:contactTracingid>362</ns1:contactTracingid> 
        <ns1:orgCode>212</ns1:orgCode> 
        <ns1:personId>50371</ns1:personId> 
        <ns1:locationName>Main Library</ns1:locationName> 
        <ns1:locationId>12345</ns1:locationId> 
        <ns1:tracingDate>2020-09-01T11:33:34.000+00:00</ns1:tracingDate> 
        <ns1:campusId>Main Library</ns1:campusId> 
        <ns1:params1>Parameter1</ns1:params1> 
        <ns1:params2>Parameter2</ns1:params2> 
        <ns1:productInstanceId>0</ns1:productInstanceId> 
    </ns1:ContactTracingEntry> 
    <ns1:ContactTracingEntry> 
        <ns1:contactTracingid>363</ns1:contactTracingid> 
        <ns1:orgCode>212</ns1:orgCode> 
        <ns1:personId>50371</ns1:personId> 
        <ns1:locationName>Cafe Central</ns1:locationName> 
        <ns1:locationId>54321</ns1:locationId> 
        <ns1:tracingDate>2020-09-01T11:33:37.000+00:00</ns1:tracingDate> 
        <ns1:campusId>Cafe Central</ns1:campusId> 
        <ns1:params1>Parameter1</ns1:params1> 
        <ns1:params2>Parameter2</ns1:params2> 
        <ns1:productInstanceId>0</ns1:productInstanceId> 
    </ns1:ContactTracingEntry> 
    <ns1:ContactTracingEntry> 
        <ns1:contactTracingid>364</ns1:contactTracingid> 
        <ns1:orgCode>212</ns1:orgCode> 
        <ns1:personId>50371</ns1:personId> 
        <ns1:locationName>Main Library</ns1:locationName> 
        <ns1:locationId>12345</ns1:locationId> 
        <ns1:tracingDate>2020-09-01T11:33:40.000+00:00</ns1:tracingDate> 
        <ns1:campusId>Main Library</ns1:campusId> 
        <ns1:params1>Parameter1</ns1:params1> 
        <ns1:params2>Parameter2</ns1:params2> 
        <ns1:productInstanceId>0</ns1:productInstanceId> 
    </ns1:ContactTracingEntry> 
    <ns1:ContactTracingEntry> 
        <ns1:contactTracingid>365</ns1:contactTracingid> 
        <ns1:orgCode>212</ns1:orgCode> 
        <ns1:personId>50371</ns1:personId> 
        <ns1:locationName>Cafe Central</ns1:locationName> 
        <ns1:locationId>54321</ns1:locationId> 
        <ns1:tracingDate>2020-09-01T11:33:44.000+00:00</ns1:tracingDate> 
        <ns1:campusId>Cafe Central</ns1:campusId> 
        <ns1:params1>Parameter1</ns1:params1> 
        <ns1:params2>Parameter2</ns1:params2> 
        <ns1:productInstanceId>0</ns1:productInstanceId> 
    </ns1:ContactTracingEntry> 
    <ns1:ContactTracingEntry> 
        <ns1:contactTracingid>368</ns1:contactTracingid> 
        <ns1:orgCode>212</ns1:orgCode> 
        <ns1:personId>50371</ns1:personId> 
        <ns1:locationName>Cafe Central</ns1:locationName> 
        <ns1:locationId>54321</ns1:locationId> 
        <ns1:tracingDate>2020-09-01T11:34:16.000+00:00</ns1:tracingDate>
        <ns1:campusId>Cafe Central</ns1:campusId> 
        <ns1:params1>Parameter1</ns1:params1> 
        <ns1:params2>Parameter2</ns1:params2> 
        <ns1:productInstanceId>0</ns1:productInstanceId> 
    </ns1:ContactTracingEntry> 
    <ns1:isFinished>true</ns1:isFinished> 
</ns1:ContactTracingReportResponse>