11 OCLC Responses

Overview

ILL Direct Request sends a message in response to each ISO-10161 ILL-request it receives. The type of response depends on whether the request is:

  • Sent to the first lender
  • Put in your Review file
  • Rejected by ILL Direct Request

Suppliers Reference Extension

The OCLC response includes the Supplier-Reference extension when the request is:

  • Sent to the first lender ( ISO-10161 Status-Or-Error-Report containing statusReport)
  • Put in your Review File ( ISO-10161 ILL-Answer)

ASN.1 Definition for Extension Suppliers-Reference

Suppliers-Reference DEFINITIONS {1 0 10161 13 7} ::=
              --The object identifier for this definition, registered
              -- with Interlibrary Loan Application Standards
              -- Maintenance Agency, is 1.0.10161.13.17

BEGIN
IMPORTS ILL-String FROM ISO-10161-ILL-1;
Suppliers-Reference ::= SEQUENCE {
              supplier-authority [0]   ILL-String,
              -- identifier of the name of the supplier, e.g. BL
              supplier-reference [1]  ILL-String
              -- allocated by the supplier, semantics defined only in
              -- the domain of the supplier, e.g. for BL this is
              -- ART Request Number used as a billing reference.
    }
END

Request Sent to First Lender

If the request is sent to the first lender, then ILL Direct Request responds with an ISO-10161 Status-Or-Error-Report that contains statusReport.

ISO-10161 Field Notes
protocolVersionNum [0] Set to version-2(2).
transactionId [1]  
    initialRequesterId [0] Present if in ILL-Request.
    transactionGroupQualifier [1]  
    transactionQualifier [2]  
    subTransactionQualifier [3] Present if in ILL-Request.
servicedatetime [2]  
    dateTimeOfThisService [0]  
        date [0] Today’s date.
        time [1]  
requesterid [3] Present if in ILL-Request
responderid [4] Present if in ILL-Request
statusReport [44]  
    userStatusReport [0]  
        dateOfLastTransition [5] Today’s date.
        mostRecentService [6] Set to iLL-REQUEST(1).
        dateOfMostRecentService [7] Today’s date.
        initiatorOfMostRecentService[8] requesterId from ILL-Request if requesterId is in the ILL-Request; otherwise initialRequesterId from ILL-Request.
    providerStatusReport [1] Set to iN-PROCESS(3).
statusOrErrorReportExtensions [49]  
    SEQUENCE [UNIVERSAL 16]  
        identifier [0] Set to 1.
        critical [1] Set to 0.
        item [2]  
    EXTERNAL [UNIVERSAL 8]  
        OBJECT IDENTIFIER [UNIVERSAL 6] 1.0.10161.13.7
    singleASN1Type [0]  
        SEQUENCE [UNIVERSAL 16]  
                supplierAuthority [0] OCLC
                supplierReference [1] ILLNUM:n   or REVIEW:n

Request Put in Review File

If the request is put in the Review File, then ILL Direct Request responds with an ISO-10161 ILL-Answer.

ISO-10161 Field Notes
protocolVersionNum [0] Set to version-2(2).
transactionId [1]  
    initialRequesterId [0] Present if in ILL-Request.
    transactionGroupQualifier [1]  
    transactionQualifier [2]  
    subTransactionQualifier [3] Present if in ILL-Request.
servicedatetime [2]  
    dateTimeOfThisService [0]  
        date [0]  
        time [1]  
requesterid [3] Present if in ILL-Request
responderid [4] Present if in ILL-Request
transactionResults [31] Set to unfilled(3).
resultsExplanation [32]  
    unfilledresults [3]  
        SEQUENCE [UNIVERSAL 16]  
            reasonUnfilled [0] Set to responderSpecific(28).
responderSpecificResults [33] ASN.1 Definition Reports the OCLC status of the request and the reasons it was put in the Review File.
    EXTERNAL [UNIVERSAL 8]  
        OBJECT IDENTIFIER [UNIVERSAL 6] 1.0.10161.8.1000.2.1
        singleASN1Type [0]  
            SEQUENCE [UNIVERSAL 16]  
                oclcSpecificStatus [0] Set to review(1).
                reasonInReviewList [1]  
                    SEQUENCE [UNIVERSAL 16] Repeatable.
                        reasonInReview [0] See ReasonInReview in OCLCSpecificResults definitions for possible values.
                        reasonInReviewText [1] May be present.
iLLAnswerExtensions [49]   
    SEQUENCE [UNIVERSAL 16]  
        identifier [0] Set to 1.
        critical [1] Set to 0.
        item [2]  
    EXTERNAL [UNIVERSAL 8]  
        OBJECT IDENTIFIER [UNIVERSAL 6] 1.0.10161.13.7
    singleASN1Type [0]  
        SEQUENCE [UNIVERSAL 16]  
                supplierAuthority [0] OCLC
                supplierReference [1] ILLNUM:n   or REVIEW:n

Request rejected

If the request is rejected, then ILL Direct Request responds with an

ISO-10161 Status-Or-Error-Report
that contains errorReport. The content of errorReport depends on why the request was rejected.

ISO-10161 Field Notes
protocolVersionNum [0] Set to version-2(2).
transactionId [1]  
    initialRequesterId [0] Present if in ILL-Request.
    transactionGroupQualifier [1]  
    transactionQualifier [2]  
    subTransactionQualifier [3] Present if in ILL-Request.
servicedatetime [2]  
    dateTimeOfThisService [0]  
        date [0] Today’s date.
        time [1]  
requesterid [3] Present if in ILL-Request
responderid [4] Present if in ILL-Request
errorReport [45]  
    correlationInformation [0] Contains name of apdu to which this one is a response.
    reportSource [1] Set to user(1) or provider(2).
    userErrorReport [2] Present if reportSource set to user(1) ; followed by either securityProblem or unableToPerform.
        securityProblem [2]  
        unableToPerform [3] Set to other(3).
    providerErrorReport [3] Present if reportSource set to provider(2); followed by either generalProblem or transactionIdProblem.
        generalProblem [0] Set to mistypedAPDU(2), badlyStructuredAPDU(3), or other(5).
        transactionIdProblem [1] Set to duplicateTransactionId(1) or invalidTransactionId(2).
note [46] May be present.
statusOrErrorReportExtensions [49] May be present.
    SEQUENCE [UNIVERSAL 16]  
        identifier [0] Set to 1.
        critical [1] Set to 0.
        item [2]  
    EXTERNAL [UNIVERSAL 8]  
        OBJECT IDENTIFIER [UNIVERSAL 6] 1.0.10161.13.1000.2.2
    singleASN1Type [0]  
        SEQUENCE [UNIVERSAL 16]  
            SEQUENCE [UNIVERSAL 16] Repeatable.
                errorCode [0] See definition of OCLCILLErrorList for possible values.
                errorText [1] May be present.