ApiService


Click here for a complete list of operations.

InsertRequest

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-dev.acns.colostate.edu
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://rapid2.library.colostate.edu/rapid5api/InsertRequest"

<?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>
    <InsertRequest xmlns="http://rapid2.library.colostate.edu/rapid5api/">
      <input>
        <SuggestedIsbns>
          <string>string</string>
          <string>string</string>
        </SuggestedIsbns>
        <SuggestedLccns>
          <string>string</string>
          <string>string</string>
        </SuggestedLccns>
        <Edition>string</Edition>
        <Publisher>string</Publisher>
        <RapidRequestType>Article or Book or BookChapter</RapidRequestType>
        <Function>string</Function>
        <XRefRequestId>string</XRefRequestId>
        <SuggestedIssns>
          <string>string</string>
          <string>string</string>
        </SuggestedIssns>
        <OclcNumber>string</OclcNumber>
        <ArticleTitle>string</ArticleTitle>
        <ArticleAuthor>string</ArticleAuthor>
        <ArticlePages>string</ArticlePages>
        <PatronJournalTitle>string</PatronJournalTitle>
        <PatronJournalYear>string</PatronJournalYear>
        <JournalVol>string</JournalVol>
        <JournalIssue>string</JournalIssue>
        <JournalMonth>string</JournalMonth>
        <PatronId>string</PatronId>
        <PatronName>string</PatronName>
        <PatronDepartment>string</PatronDepartment>
        <PatronEmail>string</PatronEmail>
        <PatronPhone>string</PatronPhone>
        <PatronFax>string</PatronFax>
        <PatronAddress>string</PatronAddress>
        <PatronStatus>string</PatronStatus>
        <PatronNotes>string</PatronNotes>
        <IsHoldingsCheckOnly>boolean</IsHoldingsCheckOnly>
        <DoInsertLocalHolding>boolean</DoInsertLocalHolding>
        <ClientAppName>string</ClientAppName>
        <ClientAppVersion>string</ClientAppVersion>
        <ClientAppPhysicalPath>string</ClientAppPhysicalPath>
        <ClientAppHost>string</ClientAppHost>
        <ClientAppUserAgent>string</ClientAppUserAgent>
        <DoBlockLocalOnly>boolean</DoBlockLocalOnly>
      </input>
    </InsertRequest>
  </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>
    <InsertRequestResponse xmlns="http://rapid2.library.colostate.edu/rapid5api/">
      <InsertRequestResult>
        <MatchingStandardNumber>string</MatchingStandardNumber>
        <MatchingStandardNumberType>string</MatchingStandardNumberType>
        <DuplicateRequestId>string</DuplicateRequestId>
        <FoundMatch>boolean</FoundMatch>
        <NumberOfAvailableHoldings>int</NumberOfAvailableHoldings>
        <RapidRequestId>int</RapidRequestId>
        <IsLocalHolding>boolean</IsLocalHolding>
        <LocalHoldings>
          <LocalHoldingItem>
            <BranchName>string</BranchName>
            <LibLocation>string</LibLocation>
            <CallNumber>string</CallNumber>
            <RapidRedirectUrl>string</RapidRedirectUrl>
          </LocalHoldingItem>
          <LocalHoldingItem>
            <BranchName>string</BranchName>
            <LibLocation>string</LibLocation>
            <CallNumber>string</CallNumber>
            <RapidRedirectUrl>string</RapidRedirectUrl>
          </LocalHoldingItem>
        </LocalHoldings>
      </InsertRequestResult>
    </InsertRequestResponse>
  </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-dev.acns.colostate.edu
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>
    <InsertRequest xmlns="http://rapid2.library.colostate.edu/rapid5api/">
      <input>
        <SuggestedIsbns>
          <string>string</string>
          <string>string</string>
        </SuggestedIsbns>
        <SuggestedLccns>
          <string>string</string>
          <string>string</string>
        </SuggestedLccns>
        <Edition>string</Edition>
        <Publisher>string</Publisher>
        <RapidRequestType>Article or Book or BookChapter</RapidRequestType>
        <Function>string</Function>
        <XRefRequestId>string</XRefRequestId>
        <SuggestedIssns>
          <string>string</string>
          <string>string</string>
        </SuggestedIssns>
        <OclcNumber>string</OclcNumber>
        <ArticleTitle>string</ArticleTitle>
        <ArticleAuthor>string</ArticleAuthor>
        <ArticlePages>string</ArticlePages>
        <PatronJournalTitle>string</PatronJournalTitle>
        <PatronJournalYear>string</PatronJournalYear>
        <JournalVol>string</JournalVol>
        <JournalIssue>string</JournalIssue>
        <JournalMonth>string</JournalMonth>
        <PatronId>string</PatronId>
        <PatronName>string</PatronName>
        <PatronDepartment>string</PatronDepartment>
        <PatronEmail>string</PatronEmail>
        <PatronPhone>string</PatronPhone>
        <PatronFax>string</PatronFax>
        <PatronAddress>string</PatronAddress>
        <PatronStatus>string</PatronStatus>
        <PatronNotes>string</PatronNotes>
        <IsHoldingsCheckOnly>boolean</IsHoldingsCheckOnly>
        <DoInsertLocalHolding>boolean</DoInsertLocalHolding>
        <ClientAppName>string</ClientAppName>
        <ClientAppVersion>string</ClientAppVersion>
        <ClientAppPhysicalPath>string</ClientAppPhysicalPath>
        <ClientAppHost>string</ClientAppHost>
        <ClientAppUserAgent>string</ClientAppUserAgent>
        <DoBlockLocalOnly>boolean</DoBlockLocalOnly>
      </input>
    </InsertRequest>
  </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>
    <InsertRequestResponse xmlns="http://rapid2.library.colostate.edu/rapid5api/">
      <InsertRequestResult>
        <MatchingStandardNumber>string</MatchingStandardNumber>
        <MatchingStandardNumberType>string</MatchingStandardNumberType>
        <DuplicateRequestId>string</DuplicateRequestId>
        <FoundMatch>boolean</FoundMatch>
        <NumberOfAvailableHoldings>int</NumberOfAvailableHoldings>
        <RapidRequestId>int</RapidRequestId>
        <IsLocalHolding>boolean</IsLocalHolding>
        <LocalHoldings>
          <LocalHoldingItem>
            <BranchName>string</BranchName>
            <LibLocation>string</LibLocation>
            <CallNumber>string</CallNumber>
            <RapidRedirectUrl>string</RapidRedirectUrl>
          </LocalHoldingItem>
          <LocalHoldingItem>
            <BranchName>string</BranchName>
            <LibLocation>string</LibLocation>
            <CallNumber>string</CallNumber>
            <RapidRedirectUrl>string</RapidRedirectUrl>
          </LocalHoldingItem>
        </LocalHoldings>
      </InsertRequestResult>
    </InsertRequestResponse>
  </soap12:Body>
</soap12:Envelope>