evergreen-admin:sip_support
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
evergreen-admin:sip_support [2010/06/08 10:08] – jatzberger | evergreen-admin:sip_support [2012/11/08 13:42] – [Message Types] gmcharlton | ||
---|---|---|---|
Line 4: | Line 4: | ||
Installation instructions for SIP on Evergreen can be found [[sip|here]]. | Installation instructions for SIP on Evergreen can be found [[sip|here]]. | ||
- | A test SIP server | + | FIXME We need a new demonstration |
Where page numbers are cited, we are referring to the " | Where page numbers are cited, we are referring to the " | ||
- | |||
===== Background ===== | ===== Background ===== | ||
SIP, standing for Standard Interchange Protocol, was developed by the 3M corporation to be a common protocol for data transfer between ILS' (referred to in SIP as an " | SIP, standing for Standard Interchange Protocol, was developed by the 3M corporation to be a common protocol for data transfer between ILS' (referred to in SIP as an " | ||
Line 37: | Line 36: | ||
| 29/30 | Renew | NO (maybe?) | [[# | | 29/30 | Renew | NO (maybe?) | [[# | ||
| 35/36 | End Session | Yes | [[# | | 35/36 | End Session | Yes | [[# | ||
- | | 37/38 | Fee Paid | NO | [[# | + | | 37/38 | Fee Paid | Yes | [[# |
| 63/64 | Patron Information | Yes (no extensions) | [[# | | 63/64 | Patron Information | Yes (no extensions) | [[# | ||
| 65/66 | Renew All | NO | [[# | | 65/66 | Renew All | NO | [[# | ||
- | | 93/94 | Login | Yes | [[# | + | | 93/94 | Login | Yes | [[# |
| 97/96 | Resend last message | Yes | [[# | | 97/96 | Resend last message | Yes | [[# | ||
| 99/98 | SC/ACS Status | Yes | [[# | | 99/98 | SC/ACS Status | Yes | [[# | ||
Line 73: | Line 72: | ||
09<No block (Offline)>< | 09<No block (Offline)>< | ||
</ | </ | ||
- | | No Block (Offline) | + | | No Block (Offline) |
| xact date | an 18 character field for the date/time when the checkin occurred. | | xact date | an 18 character field for the date/time when the checkin occurred. | ||
| Fields | | Fields | ||
Line 79: | Line 78: | ||
The response is a 10 " | The response is a 10 " | ||
- | * | + | < |
+ | 10< | ||
+ | </ | ||
- | Example: | + | Example |
< | < | ||
- | 09N20100507 | + | 09N20100507 |
+ | 101YNY20100623 | ||
</ | </ | ||
+ | |||
+ | Here you can see a hold alert for patron (CY) 373827, named (DA) Nicholas Richard Woodard, to be picked up at (CT) BR3. Since the transaction is happening at (AO) BR1, the alert type (CV) is 02 for "hold at remote library" | ||
+ | |||
+ | * 00: unknown | ||
+ | * 01: local hold | ||
+ | * 02: remote hold | ||
+ | * 03: ILL transfer (not used by EG) | ||
+ | * 04: transfer | ||
+ | * 99: other | ||
+ | |||
+ | Notes: the logic for EG to determine the content is magnetic_media comes from either legacy circ scripts or search_config_circ_modifier. | ||
+ | |||
+ | Unlike the item_id (barcode), the title_id is actually a title string, unless the configuration forces the return of the bib ID. | ||
+ | |||
+ | Don't be confused by the different branches that can show up in the same response line. | ||
+ | * AO is where the transaction took place, | ||
+ | * AQ is the " | ||
+ | * CT is the " | ||
==== 11/12 Checkout ==== | ==== 11/12 Checkout ==== | ||
==== 15/16 Hold ==== | ==== 15/16 Hold ==== | ||
Not yet supported. | Not yet supported. | ||
- | |||
==== 17/18 Item Information ==== | ==== 17/18 Item Information ==== | ||
+ | |||
+ | < | ||
+ | 17< | ||
+ | </ | ||
+ | |||
+ | The request is very terse. | ||
+ | |||
+ | The following response structure is for SIP2. (Version 1 of the protocol had only 6 total fields.) | ||
+ | < | ||
+ | 18< | ||
+ | </ | ||
+ | |||
+ | Example: | ||
+ | |||
+ | < | ||
+ | 1720060110 | ||
+ | 1801010120100609 | ||
+ | 1720060110 | ||
+ | 1810020120100623 | ||
+ | </ | ||
+ | |||
+ | The first case is with a bogus barcode. | ||
+ | |||
+ | EXTENSIONS: The CT field for " | ||
==== 19/20 Item Status Update ==== | ==== 19/20 Item Status Update ==== | ||
Line 113: | Line 156: | ||
==== 29/30 Renew ==== | ==== 29/30 Renew ==== | ||
EG ACS status message indicates Renew is supported. | EG ACS status message indicates Renew is supported. | ||
- | |||
==== 35/36 End Session ==== | ==== 35/36 End Session ==== | ||
< | < | ||
3520100505 | 3520100505 | ||
- | 36Y20100507 | + | 36Y20100507 |
</ | </ | ||
The Y/N code immediately after the 36 indicates success/ | The Y/N code immediately after the 36 indicates success/ | ||
+ | |||
==== 37/38 Fee Paid ==== | ==== 37/38 Fee Paid ==== | ||
Not implemented. | Not implemented. | ||
- | |||
==== 63/64 Patron Information ==== | ==== 63/64 Patron Information ==== | ||
+ | Attempting to retrieve patron info with a bad barcode: | ||
+ | < | ||
+ | 6300020060329 | ||
+ | 64YYYY | ||
+ | </ | ||
+ | |||
+ | Attempting to retrieve patron info with a good barcode (but bad patron password): | ||
+ | < | ||
+ | 6300020060329 | ||
+ | 64 Y | ||
+ | </ | ||
+ | |||
+ | See 23/24 Patron Status for info on BL and CQ fields. | ||
+ | |||
==== 65/66 Renew All ==== | ==== 65/66 Renew All ==== | ||
Not yet supported. | Not yet supported. |
evergreen-admin/sip_support.txt · Last modified: 2022/02/10 13:34 by 127.0.0.1