ApiService Web Service

ApiService

Click here for a complete list of operations.

RetrieveRequests

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /rapid5api/apiservice.asmx HTTP/1.1
Host: rapid.exlibrisgroup.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://rapid2.library.colostate.edu/rapid5api/RetrieveRequests"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RetrieveRequests xmlns="http://rapid2.library.colostate.edu/rapid5api/">
      <input>
        <QueueType>LenderPending or LenderResend or BorrowerBadCitation or BorrowerNotAvailable or BorrowerPending or IllSoftwarePending or IllSoftwareResend or BorrowerRecentlyFilled or BorrowerRecentlyFilledRapidX or BorrowerRecentlyShipped or LenderRecentlyReceived or LenderRecentlyReturned or BorrowerRecentlyFinished or LenderRecentlyRenewalRequested</QueueType>
        <RapidRequestType>All or Article or Book or BookChapter</RapidRequestType>
        <DoRetrieveTransactionHistory>boolean</DoRetrieveTransactionHistory>
        <DoRetrievePatronInfo>boolean</DoRetrievePatronInfo>
        <HoursOld>int</HoursOld>
      </input>
    </RetrieveRequests>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RetrieveRequestsResponse xmlns="http://rapid2.library.colostate.edu/rapid5api/">
      <RetrieveRequestsResult>
        <Transactions>
          <Transaction>
            <RapidRequestId>int</RapidRequestId>
            <XRefRequestId>string</XRefRequestId>
            <StateType>Pending or Filled or Unfilled or Deleted or Cancelled or BadCitationBorrower or BadCitationLender or New or NewResend or NotAvailable or LocalHoldingIn or PendingBatchNotPrinted or PendingBatchPrinted or PendingLocal or Unknown or PendingExport or Shipped or Received or NotReceived or Returned or Lost or Finished or RenewalRequested or Renewed or NotRenewed</StateType>
            <RapidRequestType>Article or Book or BookChapter</RapidRequestType>
            <BorrowerRapidCode>string</BorrowerRapidCode>
            <BorrowerPreferredAddress>string</BorrowerPreferredAddress>
            <BorrowerBranchName>string</BorrowerBranchName>
            <BorrowerInstitution>string</BorrowerInstitution>
            <BorrowerCountryCode>string</BorrowerCountryCode>
            <UserJournalTitle>string</UserJournalTitle>
            <JournalTitle>string</JournalTitle>
            <ArticleTitle>string</ArticleTitle>
            <ArticleAuthor>string</ArticleAuthor>
            <JournalVol>string</JournalVol>
            <JournalIssue>string</JournalIssue>
            <JournalYear>string</JournalYear>
            <JournalPages>string</JournalPages>
            <Edition>string</Edition>
            <Publisher>string</Publisher>
            <Issn>string</Issn>
            <OclcNumber>string</OclcNumber>
            <Isbn>string</Isbn>
            <Lccn>string</Lccn>
            <LenderRapidCode>string</LenderRapidCode>
            <LenderBranch>string</LenderBranch>
            <CallNumber>string</CallNumber>
            <Location>string</Location>
            <AdditionalInfo>string</AdditionalInfo>
            <JournalMonth>string</JournalMonth>
            <Copyright>string</Copyright>
            <RapidRedirectUrl>string</RapidRedirectUrl>
            <ArticleExchangeAddress>string</ArticleExchangeAddress>
            <ArticleExchangePassword>string</ArticleExchangePassword>
            <PatronNotes>string</PatronNotes>
            <DueDate>dateTime</DueDate>
            <BorrowerMailingAddress>string</BorrowerMailingAddress>
            <LenderMailingAddress>string</LenderMailingAddress>
            <TrackingNumber>string</TrackingNumber>
            <TransactionHistory xsi:nil="true" />
            <PatronInfo xsi:nil="true" />
          </Transaction>
          <Transaction>
            <RapidRequestId>int</RapidRequestId>
            <XRefRequestId>string</XRefRequestId>
            <StateType>Pending or Filled or Unfilled or Deleted or Cancelled or BadCitationBorrower or BadCitationLender or New or NewResend or NotAvailable or LocalHoldingIn or PendingBatchNotPrinted or PendingBatchPrinted or PendingLocal or Unknown or PendingExport or Shipped or Received or NotReceived or Returned or Lost or Finished or RenewalRequested or Renewed or NotRenewed</StateType>
            <RapidRequestType>Article or Book or BookChapter</RapidRequestType>
            <BorrowerRapidCode>string</BorrowerRapidCode>
            <BorrowerPreferredAddress>string</BorrowerPreferredAddress>
            <BorrowerBranchName>string</BorrowerBranchName>
            <BorrowerInstitution>string</BorrowerInstitution>
            <BorrowerCountryCode>string</BorrowerCountryCode>
            <UserJournalTitle>string</UserJournalTitle>
            <JournalTitle>string</JournalTitle>
            <ArticleTitle>string</ArticleTitle>
            <ArticleAuthor>string</ArticleAuthor>
            <JournalVol>string</JournalVol>
            <JournalIssue>string</JournalIssue>
            <JournalYear>string</JournalYear>
            <JournalPages>string</JournalPages>
            <Edition>string</Edition>
            <Publisher>string</Publisher>
            <Issn>string</Issn>
            <OclcNumber>string</OclcNumber>
            <Isbn>string</Isbn>
            <Lccn>string</Lccn>
            <LenderRapidCode>string</LenderRapidCode>
            <LenderBranch>string</LenderBranch>
            <CallNumber>string</CallNumber>
            <Location>string</Location>
            <AdditionalInfo>string</AdditionalInfo>
            <JournalMonth>string</JournalMonth>
            <Copyright>string</Copyright>
            <RapidRedirectUrl>string</RapidRedirectUrl>
            <ArticleExchangeAddress>string</ArticleExchangeAddress>
            <ArticleExchangePassword>string</ArticleExchangePassword>
            <PatronNotes>string</PatronNotes>
            <DueDate>dateTime</DueDate>
            <BorrowerMailingAddress>string</BorrowerMailingAddress>
            <LenderMailingAddress>string</LenderMailingAddress>
            <TrackingNumber>string</TrackingNumber>
            <TransactionHistory xsi:nil="true" />
            <PatronInfo xsi:nil="true" />
          </Transaction>
        </Transactions>
      </RetrieveRequestsResult>
    </RetrieveRequestsResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /rapid5api/apiservice.asmx HTTP/1.1
Host: rapid.exlibrisgroup.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RetrieveRequests xmlns="http://rapid2.library.colostate.edu/rapid5api/">
      <input>
        <QueueType>LenderPending or LenderResend or BorrowerBadCitation or BorrowerNotAvailable or BorrowerPending or IllSoftwarePending or IllSoftwareResend or BorrowerRecentlyFilled or BorrowerRecentlyFilledRapidX or BorrowerRecentlyShipped or LenderRecentlyReceived or LenderRecentlyReturned or BorrowerRecentlyFinished or LenderRecentlyRenewalRequested</QueueType>
        <RapidRequestType>All or Article or Book or BookChapter</RapidRequestType>
        <DoRetrieveTransactionHistory>boolean</DoRetrieveTransactionHistory>
        <DoRetrievePatronInfo>boolean</DoRetrievePatronInfo>
        <HoursOld>int</HoursOld>
      </input>
    </RetrieveRequests>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <RetrieveRequestsResponse xmlns="http://rapid2.library.colostate.edu/rapid5api/">
      <RetrieveRequestsResult>
        <Transactions>
          <Transaction>
            <RapidRequestId>int</RapidRequestId>
            <XRefRequestId>string</XRefRequestId>
            <StateType>Pending or Filled or Unfilled or Deleted or Cancelled or BadCitationBorrower or BadCitationLender or New or NewResend or NotAvailable or LocalHoldingIn or PendingBatchNotPrinted or PendingBatchPrinted or PendingLocal or Unknown or PendingExport or Shipped or Received or NotReceived or Returned or Lost or Finished or RenewalRequested or Renewed or NotRenewed</StateType>
            <RapidRequestType>Article or Book or BookChapter</RapidRequestType>
            <BorrowerRapidCode>string</BorrowerRapidCode>
            <BorrowerPreferredAddress>string</BorrowerPreferredAddress>
            <BorrowerBranchName>string</BorrowerBranchName>
            <BorrowerInstitution>string</BorrowerInstitution>
            <BorrowerCountryCode>string</BorrowerCountryCode>
            <UserJournalTitle>string</UserJournalTitle>
            <JournalTitle>string</JournalTitle>
            <ArticleTitle>string</ArticleTitle>
            <ArticleAuthor>string</ArticleAuthor>
            <JournalVol>string</JournalVol>
            <JournalIssue>string</JournalIssue>
            <JournalYear>string</JournalYear>
            <JournalPages>string</JournalPages>
            <Edition>string</Edition>
            <Publisher>string</Publisher>
            <Issn>string</Issn>
            <OclcNumber>string</OclcNumber>
            <Isbn>string</Isbn>
            <Lccn>string</Lccn>
            <LenderRapidCode>string</LenderRapidCode>
            <LenderBranch>string</LenderBranch>
            <CallNumber>string</CallNumber>
            <Location>string</Location>
            <AdditionalInfo>string</AdditionalInfo>
            <JournalMonth>string</JournalMonth>
            <Copyright>string</Copyright>
            <RapidRedirectUrl>string</RapidRedirectUrl>
            <ArticleExchangeAddress>string</ArticleExchangeAddress>
            <ArticleExchangePassword>string</ArticleExchangePassword>
            <PatronNotes>string</PatronNotes>
            <DueDate>dateTime</DueDate>
            <BorrowerMailingAddress>string</BorrowerMailingAddress>
            <LenderMailingAddress>string</LenderMailingAddress>
            <TrackingNumber>string</TrackingNumber>
            <TransactionHistory xsi:nil="true" />
            <PatronInfo xsi:nil="true" />
          </Transaction>
          <Transaction>
            <RapidRequestId>int</RapidRequestId>
            <XRefRequestId>string</XRefRequestId>
            <StateType>Pending or Filled or Unfilled or Deleted or Cancelled or BadCitationBorrower or BadCitationLender or New or NewResend or NotAvailable or LocalHoldingIn or PendingBatchNotPrinted or PendingBatchPrinted or PendingLocal or Unknown or PendingExport or Shipped or Received or NotReceived or Returned or Lost or Finished or RenewalRequested or Renewed or NotRenewed</StateType>
            <RapidRequestType>Article or Book or BookChapter</RapidRequestType>
            <BorrowerRapidCode>string</BorrowerRapidCode>
            <BorrowerPreferredAddress>string</BorrowerPreferredAddress>
            <BorrowerBranchName>string</BorrowerBranchName>
            <BorrowerInstitution>string</BorrowerInstitution>
            <BorrowerCountryCode>string</BorrowerCountryCode>
            <UserJournalTitle>string</UserJournalTitle>
            <JournalTitle>string</JournalTitle>
            <ArticleTitle>string</ArticleTitle>
            <ArticleAuthor>string</ArticleAuthor>
            <JournalVol>string</JournalVol>
            <JournalIssue>string</JournalIssue>
            <JournalYear>string</JournalYear>
            <JournalPages>string</JournalPages>
            <Edition>string</Edition>
            <Publisher>string</Publisher>
            <Issn>string</Issn>
            <OclcNumber>string</OclcNumber>
            <Isbn>string</Isbn>
            <Lccn>string</Lccn>
            <LenderRapidCode>string</LenderRapidCode>
            <LenderBranch>string</LenderBranch>
            <CallNumber>string</CallNumber>
            <Location>string</Location>
            <AdditionalInfo>string</AdditionalInfo>
            <JournalMonth>string</JournalMonth>
            <Copyright>string</Copyright>
            <RapidRedirectUrl>string</RapidRedirectUrl>
            <ArticleExchangeAddress>string</ArticleExchangeAddress>
            <ArticleExchangePassword>string</ArticleExchangePassword>
            <PatronNotes>string</PatronNotes>
            <DueDate>dateTime</DueDate>
            <BorrowerMailingAddress>string</BorrowerMailingAddress>
            <LenderMailingAddress>string</LenderMailingAddress>
            <TrackingNumber>string</TrackingNumber>
            <TransactionHistory xsi:nil="true" />
            <PatronInfo xsi:nil="true" />
          </Transaction>
        </Transactions>
      </RetrieveRequestsResult>
    </RetrieveRequestsResponse>
  </soap12:Body>
</soap12:Envelope>