The Danish National Library Authoritys logo - Go to www.bs.dkempty spaceLogo background
 
 
 
 


7. D Ordering and Interlibrary Loans

This profile addresses the ordering of items between parties acting as either borrowers (ISO ILL Requester) or lenders (ISO ILL Responder). Other ISO ILL Transaction modes and roles, e.g. Intermediary parties are outside the scope of this profile.

DanZIG Profile 2 is intended to support communications between two ISO ILL conformant systems.

The content of ISO ILL messages supported by ONE-2 ILL Level-2 conforms to the corresponding IPIG Profile specifications.

Encoding of ILL messages conforms to a revised version of the ILL XML Schema produced as part of the ONE-2 project.

The normative specification of the current ILL XML Schema called illv5.xsd is available here:

http://www.loc.gov/z3950/agency/defns/illv5.xsd  

(Actuel here http://www.bs.dk/standards/illv5.xsd waiting for update by Z39.50 MA – you can find illv4.xsd on the MA website: http://www.loc.gov/z3950/agency/defns/illv4.xsd )

The corresponding data element tables in the text below are for information purposes only.

The use of Z39.50 Item Order transport is guided by the Z39.50/ILL Profile 1 for the Use of Z39.50 Item Order Extended service to Transport ILL Protocol APDUs. Z39.50/ILL Profile 1 is available from the National Library of Canada: http://www.collectionscanada.ca/iso/ill/document/standard/z-ill-1a.pdf

It is assumed, that a ILL-Request is immediately preceded by a corresponding check of Holdings information within the same (Z39.50) Session in order to verify, that the intended lending institution does indeed hold the bibliographic item in question.

The requested item is identified by the following elements:

Bibliographic record

TargetLocation Id

Sub-record from danMARC2 field 247 or 248

TargetBibPartId

Serial issue number

TargetBibPartId

Copy of periodical *)

TargetPieceId

 *) not required by the current version of the danZIG Profile.

The ISO ILL Services used by the current level of the danZIG Z39.50 Profile for Client and Server are listed in the following table.

Role

Service

Function

Requester

ILL-REQUEST

Client

Requester

STATUS-QUERY

Client

Responder

ILL-ANSWER

Server

Responder

STATUS-OR-ERROR-REPORT

Server

Requester

CANCEL

Client

Responder

CANCEL-REPLY

Server

Requester

RECALL

Server

Requester

OVERDUE

Server

Requester

RENEW

Client

Responder

RENEW-ANSWER

Server

Requester

SHIPPING

Server

The ILL-Answer transaction includes a data element to return information about the expected delivery date of a requested item. But the ILL Status-or-Error-Report transaction does not include such a data element.

In order to return the expected delivery date, an ILL Responder system is therefore required to return both an ILL Status-or-Error-Report plus and ILL-Answer transaction in response to a single ILL Status-Query request.

The supplemental ILL-Answer is only necessary, when the ILL Status-or-Error-Report contains a Provider-Status-Report data element with the code value In-Process. Otherwise there is no need to return any expected delivery date.

Both of the two ILL transactions (Status-or-Error-Report plus ILL-Answer) must be returned as XML documents carried within a single Z39.50 Item-Order response.

7.1 ILL Transaction Structures

This section includes an informal overview of the relevant ILL Transaction data elements referenced by the danZIG Profile.

7.1.1 ILL-Request

Parameter

Mandatory

Comments and values

transaction-id

M

Unique serial number assigned by the library who request. Are used as ID for following transactions

service-date-time

   

- date-time-of-this-service

   

- - date

M

ISO-date: YYYY-MM-DD

- - time

 

ISO-time: hh:mm:ss

requester-id

M

Identification of the library which dispatch the request: ISIL, e.g.: DK-810010 for Royal Library

responder-id

M

Identification of the library which receive the request: ISIL, e.g.: DK-810010 for Royal Library

iLL-service-type

M

It is mandatory to support service type 1 and 2.

loan (1)

copy-non-returnable (2)

locations (3)

estimate (4)

responder-specific (5)

search-type

   

- need-before-date

   

- expiry-flag

 

need-Before-Date (1)

other-Date (2)

no-Expiry (3)

- expiry-date

 

If expiry-flag is 1, this is date of latest interest

place-on-hold

 

Place-On-Hold-Type :

yes (1)

no (2)

according-to-responder-policy (3)

item-id

   

- system-no

M

Unique identification from Z39.50 Holdings Schema: TargetLocationId, TargetBibPartId or TargetPieceId

- author-of-article

   

- title-of-article

   

- pagination

   

7.1.2 ILL-Answer

Parameter

Mandatory

Comments and values

transaction-id

M

Unique identification defined in the original ILL-Request

service-date-time

   

- date-time-of-this-service

   

- - date

M

ISO-date: CCYY-MM-DD

- - time

 

ISO-time: hh:mm:ss

requester-id

M

Identification of the library which dispatch the request: ISIL, e.g.: DK-810010 for Royal Library

responder-id

M

Identification of the library which receive the request: ISIL, e.g.: DK-810010 for Royal Library

transaction-results

M

It is mandatory to support transaction-results type 3, 5 and 6

conditional (1)

retry (2)

unfilled (3)

locations-provided (4)

will-supply (5)

hold-placed (6)

estimate (7)

results-explanation

   

- unfilled-results

   

- - reason-unfilled

M

Translation to Danish, see following section.

in-use-on-loan (1)

in-process (2)

lost (3)

non-circulating (4)

not-owned (5)

on-order (6)

volume-issue-not-yet-available (7)

at-bindery (8)

lacking (9)

not-on-shelf (10)

on-reserve (11)

poor-condition (12)

cost-exceeds-limit (13)

charges (14)

prepayment-required (15)

lacks-copyright-compliance (16)

not-found-as-cited (17)

locations-not-found (18)

on-hold (19)

policy-problem (20)

mandatory-messaging-not-supported (21)

expiry-not-supported (22)

requested-delivery-services-not-supported (23)

preferred-delivery-time-not-possible (24)

other (27)

responder-specific (28)

- will-supply-results

   

- - reason-will-supply

M

Translation to Danish, see following section

in-use-on-loan (1)

in-process (2)

on-order (6)

at-bindery (8)

on-hold (19)

being-processed-for-supply (26)

other (27)

responder-specific (28)

electronic-delivery (30)

- - supply-date

   

- hold-placed-results

   

- - estimated-date-available

   

7.1.3 Status-Query

Parameter

Mandatory

Comments and values

transaction-id

M

Unique identification defined in the original ILL-Request

service-date-time

   

- date-time-of-this-service

   

- - date

M

ISO-date: CCYY-MM-DD

- - time

 

ISO-time: hh:mm:ss

requester-id

M

Identification of the library which dispatch the Status-query: ISIL, e.g.: DK-810010 for Royal Library

responder-id

M

Identification of the library which receive the Status-query: ISIL, e.g.: DK-810010 for Royal Library

7.1.4 Status-or-Error-Report

Parameter

Mandatory

Comments and values

transaction-id

M

Unique identification defined in the original ILL-Request

service-date-time

   

- date-time-of-this-service

   

- - date

M

ISO-date: CCYY-MM-DD

- - time

 

ISO-time: hh:mm:ss

requester-id

M

Identification of the library which dispatch the Status-or-Error-Report: ISIL, e.g.: DK-810010 for Royal Library

responder-id

M

Identification of the library which receive the Status-or-Error-Report: ISIL, e.g.: DK-810010 for Royal Library

reason-no-report

 

If status-report or error-report  is empty, is reason-no-report mandatory:

temporary (1)

permanent (2)

status-report

   

- user-status-report

   

- - date-of-last-transition

 

Date for last change of status – also if the change was not result of an ILL-transaction

- - most-recent-service

 

The last ILL-transaction:

iLL-REQUEST (1)

fORWARD (21)

fORWARD-NOTIFICATION (2)

sHIPPED (3)

iLL-ANSWER (4)

cONDITIONAL-REPLY (5)

cANCEL (6)

cANCEL-REPLY (7)

rECEIVED (8)

rECALL (9)

rETURNED (10)

cHECKED-IN (11)

rENEW-ANSWER (14)

lOST (15)

dAMAGED (16)

mESSAGE (17)

sTATUS-QUERY (18)

sTATUS-OR-ERROR-REPORT (19)

eXPIRED (20)

- - date-of-most-recent-service

 

Date for last ILL-transaction

- - initiator-of-most-recent-service

 

Identification of the library which initiated the last ILL-transaction: ISIL, e.g.: DK-810010 for Royal Library

- - shipped-service-type

 

If SHIPPED or RECEIVED is used earlier, the newest service-type. Allowed are:

loan (1)

copy-non-returnable (2)

- - transaction-results

 

See ILL-Answer, transaction-results

- - most-recent-service-note

 

Text

- provider-status-report

 

Explenation of some status codes in X.Y.Z

nOT-SUPPLIED (1)

pENDING (2)

iN-PROCESS (3)

fORWARD (4)

cONDITIONAL (5)

cANCEL-PENDING (6) cANCELLED (7)

sHIPPED (8)

rECEIVED (9)

rENEW-PENDING (10) )

nOT-RECEIVED-OVERDUE (11)

rENEW-OVERDUE (12)

oVERDUE (13)

rETURNED (14)

cHECKED-IN (15)

rECALL (16)

lOST (17)

uNKNOWN (18)

error-report

   

- correlation-information

 

This parameter includes information that permits correlation of the error-report with the ILL service to which it applies.

- report-source

 

Values:

user: user-error-report is filled in

provider: provider-error-report is filled in

- user-error-report

   

- - already-forwarded

   

- - - responder-id

 

See ILL-Request, responder-id

- - security-problem

 

Text

- - unable-to-perform

 

not-available (1)

resource-limitation (2)

other (3)

- provider-error-report

   

- - general-problem

 

unrecognized-APDU (1)

mistyped-APDU (2)

badly-structured-APDU (3)

protocol-version-not-supported (4)

other (5)

- - transaction-id-problem

 

duplicate-transaction-id (1)

invalid-transaction-id (2)

unknown-transaction-id (3)

- - state-transition-prohibited

   

- - - aPDU-type

 

iLL-REQUEST (1)

fORWARD-NOTIFICATION (2)

sHIPPED (3)

iLL-ANSWER (4)

cONDITIONAL-REPLY (5)

cANCEL (6)

cANCEL-REPLY (7)

rECEIVED (8)

rECALL (9)

rETURNED (10)

cHECKED-IN (11)

rENEW-ANSWER (14)

lOST (15)

dAMAGED (16)

mESSAGE (17)

sTATUS-QUERY (18)

sTATUS-OR-ERROR-REPORT (19)

eXPIRED (20)

- - - current-state

 

nOT-SUPPLIED (1)

pENDING (2)

iN-PROCESS (3)

fORWARD (4)

cONDITIONAL (5)

cANCEL-PENDING (6)

cANCELLED (7)

sHIPPED (8)

rECEIVED (9)

rENEW-PENDING (10)

nOT-RECEIVED-OVERDUE (11)

rENEW-OVERDUE (12)

oVERDUE (13)

rETURNED (14)

cHECKED-IN (15)

rECALL (16)

lOST (17)

uNKNOWN (18)

note

 

Text

7.1.5 Cancel

Parameter

Mandatory

Comments and values

transaction-id

M

Unique identification defined in the original ILL-Request

service-date-time

   

- date-time-of-this-service

   

- - date

M

ISO-date: CCYY-MM-DD

- - time

 

ISO-time: hh:mm:ss

requester-id

M

Identification of the library which dispatch the Status-or-Error-Report: ISIL, e.g.: DK-810010 for Royal Library

Responder-id

M

Identification of the library which receive the Status-or-Error-Report: ISIL, e.g.: DK-810010 for Royal Library

Requester-mote

 

Not used

7.1.6 Cancel-reply

Parameter

Mandatory

Comments and values

Transaction-id

M

Unique identification defined in the original ILL-Request

service-date-time

   

- date-time-of-this-service

   

- - date

M

ISO-date: CCYY-MM-DD

- - time

 

ISO-time: hh:mm:ss

requester-id

M

Identification of the library which dispatch the Status-or-Error-Report: ISIL, e.g.: DK-810010 for Royal Library

responder-id

M

Identification of the library which receive the Status-or-Error-Report: ISIL, e.g.: DK-810010 for Royal Library

answer

M

Values:

YES

NO

responder-note

 

Only used is answer is NO

7.1.7 Recall

Parameter

Mandatory

Comments and values

transaction-id

M

Unique identification defined in the original ILL-Request

service-date-time

   

- date-time-of-this-service

   

- - date

M

ISO-date: CCYY-MM-DD

- - time

 

ISO-time: hh:mm:ss

requester-id

M

Identification of the library which dispatch the Status-or-Error-Report: ISIL, e.g.: DK-810010 for Royal Library

responder-id

M

Identification of the library which receive the Status-or-Error-Report: ISIL, e.g.: DK-810010 for Royal Library

responder-note

 

Not used

7.1.8 Overdue

Parameter

Mandatory

Comments and values

transaction-id

M

Unique identification defined in the original ILL-Request

service-date-time

   

- date-time-of-this-service

   

- - date

M

ISO-date: CCYY-MM-DD

- - time

 

ISO-time: hh:mm:ss

requester-id

M

Identification of the library which dispatch the Status-or-Error-Report: ISIL, e.g.: DK-810010 for Royal Library

responder-id

M

Identification of the library which receive the Status-or-Error-Report: ISIL, e.g.: DK-810010 for Royal Library

date-due

 

New return date

responder-note

 

Not used

7.1.9 Renew

Parameter

Mandatory

Comments and values

transaction-id

M

Unique identification defined in the original ILL-Request

service-date-time

   

- date-time-of-this-service

   

- - date

M

ISO-date: CCYY-MM-DD

- - time

 

ISO-time: hh:mm:ss

requester-id

M

Identification of the library which dispatch the Status-or-Error-Report: ISIL, e.g.: DK-810010 for Royal Library

responder-id

M

Identification of the library which receive the Status-or-Error-Report: ISIL, e.g.: DK-810010 for Royal Library

Desired-due-date

M

Expected new return date

Responder-note

 

Not used

7.1.10 Renew-answer

Parameter

Mandatory

Comments and values

transaction-id

M

Unique identification defined in the original ILL-Request

service-date-time

   

- date-time-of-this-service

   

- - date

M

ISO-date: CCYY-MM-DD

- - time

 

ISO-time: hh:mm:ss

requester-id

M

Identification of the library which dispatch the Status-or-Error-Report: ISIL, e.g.: DK-810010 for Royal Library

responder-id

M

Identification of the library which receive the Status-or-Error-Report: ISIL, e.g.: DK-810010 for Royal Library

date-due

M

If answer is YES: New return date

If answer is NO: The unchanged return date

answer

M

Values:

YES

NO

responder-note

 

Only used if answer is NO

7.1.11 Shipped

Parameter

Mandatory

Comments and values

transaction-id

M

Unique serial number assigned by the library who request. Are used as ID for following transactions

service-date-time

   

- date-time-of-this-service

   

- - date

M

ISO-date: CCYY-MM-DD

- - time

 

ISO-time: hh:mm:ss

requester-id

M

Identification of the library which dispatch the request: ISIL, e.g.: DK-810010 for Royal Library

responder-id

M

Identification of the library which receive the request: ISIL, e.g.: DK-810010 for Royal Library

supply-details

   

date-shipped   

M

ISO-date: CCYY-MM-DD

supplemental-item-description

 

External defined: code for item identification (barcode/RFIDitemcode)

7.2 ILL Codes in Danish

This section defines Danish language translations corresponding to selected code-values within relevant ILL data elements.

7.2.1 Reason-unfilled (ILL-Answer)

Code

Value

Danish translation

Note

1

in-use-on-loan

udlånt

 

2

in-process

i proces

 

3

lost

bortkommet

 

4

non-circulating

udlånes ikke

 

5

not-owned

haves ikke

 

6

on-order

i bestilling

 

7

volume-issue-not-yet-available

Bind/hæfte endnu ikke tilgængeligt

 

8

at-bindery

hos bogbinder

 

9

lacking

bortkommet

 

10

not-on-shelf

pt. bortkommet

 

11

on-reserve

udlånes pt. ikke

 

12

poor-condition

skrøbelig

 

13

cost-exceeds-limit

gebyr overstiger maximum

*)

14

charges

gebyr

 

15

prepayment-required

forudbetaling krævet

*)

16

lacks-copyright-compliance

accept af ophavsretsbestemmelser mangler

*)

17

not-found-as-cited

kan ej findes på de foreliggende oplysninger

 

18

locations-not-found

kan ej lokaliseres

 

19

on-hold

reserveret

 

20

policy-problem

reglementært problem

 

21

mandatory-messaging-not-supported

obligatorisk besked ej understøttet

*)

22

expiry-not-supported

udløb ej understøttet

*)

23

requested-delivery-services-not-supported

ønsket leveringsform ej understøttet

*)

24

preferred-delivery-time-not-possible

foretrukket leveringstidspunkt ej muligt

*)

27

other

andet

*)

28

responder-specific

svargiver-afhængigt

*)

Note: *) Not used in Danish libraries.

7.2.2 Reason-will-supply (ILL-Answer)

Code

Value

Danish translation

Note

1

in-use-on-loan

Udlånt

 

2

in-proces

i proces

 

6

on-order

i bestilling

 

8

at-bindery

hos bogbinder

 

19

on-hold

reserveret

 

26

being-processed-for-supply

sendes

 

27

other

andet

*)

28

responder-specific

svargiver-afhængigt

*)

30

electronic-delivery

leveres elektronisk

*)

Note: *) Not used in Danish libraries.

7.2.3 Provider-status-report (Status-or-Error-Report)

Code

Value

Danish translation

Note

2

pENDING

modtaget og ligger og venter uden at der er sket noget endnu

 

3

iN-PROCESS

modtaget og der er sket noget - det kan f.eks. være at den ikke er fundet på hylden og efterfølgende aktion ikke er besluttet

 

6

cANCEL-PENDING

Sletning af bestilling modtaget, men ikke effektueret

*)

10

rENEW-PENDING

fornyelse af bestilling modtaget, men ikke effektueret

*)

11

nOT-RECEIVED-OVERDUE

lånene bibliotek har hjemkaldt hos slutlåner

 

Note: *) Not expected to be used in Danish libraries.

7.3  Packaging of ILL as XML document

The danZIG Profile prescribe XML encoding of the ISO ILL PDUs in Z39.50/ILL Profile 1 - instead of the customary BER encoding. The ILL XML document is packaged within itemRequest.

Request (e.g. ILL-Request) is packaged as follows:

ExtendedServicesRequest->
taskSpecificParameters (EXTERNAL) which contains...
ItemOrder->
esRequest->
notToKeep->
itemRequest (EXTERNAL)

The ILL XML record itself is placed within itemRequest EXTERNAL.

Response (e.g. ILL Answer) is packaged as follows:

ExtendedServicesResponse->
taskPackage (EXTERNAL) which contains:
TaskPackage->
taskSpecificParameters (EXTERNAL) which contains:
ItemOrder->
taskPackage->
targetPart->
itemRequest (EXTERNAL)

The itemRequest EXTERNAL contains the ILL XML record itself.

The datatype in the EXTERNAL is octet-aligned.





Print Print
This page forms part of the publication 'danZIG Profile Specification 2007' as chapter 7 of 12
Version 30. July 2007. 30-07-2007
Publication may be found at the address http://www.bs.dk/publikationer/andre/danzig/01/index.htm
© 2007
Danish Library Agency | H.C. Andersens Boulevard 2 | DK-1553 Copenhagen V | phone +45 33 73 33 73 (weekdays hrs. 9-16) | fax +45 33 73 33 72 | bs@bs.dk | CVR 56 79 81 10