Past Masters

Harvesting Usage Statistics Using a SUSHI/COUNTER SOAP Client

InteLex provides usage statistics to our institutional customers via the COUNTER initiative and the SUSHI protocol. Currently, we only support Book Report 1 (BR1), Release 1 report type.

Requirements

  • An institutional account for Past Masters access
  • Credentials: Requestor and Customer IDs
  • A SOAP client

Our SOAP server address is http://sushi-stats.nlx.com/soap.

If you need your institution's credentials, please contact us.

If you would like to test your connection with a simple tool like curl, use the XML as a guide and substitute your credentials and date range:

<?xml version="1.0" encoding="utf-8" ?>
    <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" 
             xmlns:coun="http://www.niso.org/schemas/sushi/counter"       
             xmlns:sus="http://www.niso.org/schemas/sushi">
      <soapenv:Header/>
      <soapenv:Body>
        <coun:ReportRequest Created="YYYY-MM-DD" ID="XXXX">
          <sus:Requestor>
            <sus:ID>XXXXXX</sus:ID>
            <sus:Name>NAME</sus:Name>
          </sus:Requestor>
          <sus:CustomerReference>
            <sus:ID>XXXXXX</sus:ID>
            <sus:Name>NAME</sus:Name>
          </sus:CustomerReference>
          <sus:ReportDefinition Name="BR1" Release="1">
            <sus:Filters>
              <sus:UsageDateRange>
                <sus:Begin>YYYY-MM-DD</sus:Begin>
                <sus:End>YYYY-MM-DD</sus:End>
              </sus:UsageDateRange>
            </sus:Filters>
          </sus:ReportDefinition>
        </coun:ReportRequest>
      </soapenv:Body>
    </soapenv:Envelope>

Then you would just use curl with your XML:

      curl -d '<your xml>' http://sushi-stats.nlx.com/soap
    

Please see SUSHI for details on how to build a SUSHI/COUNTER SOAP client.