### AcceptItemResponse Example Source: https://developer.api.oclc.org/docs/ncip-resource-sharing/openapi.yaml An example of a successful AcceptItem response message. ```APIDOC ## AcceptItemResponse ### Description This is an example of a successful AcceptItem response. ### Response Example ```xml WMS Circ 91475 SHAREit 91475 ILL Request Id 123 91475 Barcode SomeExampleItemBarcode ``` ``` -------------------------------- ### Accept Item Response Example Source: https://developer.api.oclc.org/docs/ncip-resource-sharing/openapi.yaml An example of a successful Accept Item response message in NCIP format. ```xml WMS Circ 91475 SHAREit 91475 ILL Request Id 123 91475 Barcode SomeExampleItemBarcode ``` -------------------------------- ### Item Routing Examples Source: https://developer.api.oclc.org/docs/wms-circulation/openapi.yaml Examples demonstrating how to route items using the WMS Circulation API, covering successful operations and various error scenarios. ```APIDOC ## POST /circ/items/route ### Description Routes an item within the WMS circulation system. This endpoint can be used to process various item states, including scheduled holds and returns. ### Method POST ### Endpoint /circ/items/route ### Request Body - **itemId** (string) - Required - The unique identifier of the item to be routed. ### Response #### Success Response (200) - **reason** (object) - Contains information about the routing reason, such as SCHEDULED. - **reasonCode** (string) - The code indicating the reason for routing. - **dateRouted** (string) - The date and time the item was routed. - **item** (object) - Details of the routed item. - **ref** (string) - Reference URL to the item record. - **ownerInstitution** (object) - Information about the owning institution. - **institutionId** (integer) - The ID of the institution. - **institutionName** (string) - The name of the institution. - **pieceDesignation** (string) - Designation of the item piece. - **callNumber** (string) - The call number of the item. - **itemRecordType** (string) - The type of the item record (e.g., SINGLE_PART). - **numberOfPieces** (integer) - The number of pieces for this item. - **homeLocation** (object) - Information about the item's home location. - **shelvingLocationCode** (string) - The shelving location code. - **holdingLocation** (object) - Information about the holding location. - **holdingLocationCode** (string) - The holding location code. - **location** (object) - Details about the physical location. - **ref** (string) - Reference URL to the location. - **branchId** (integer) - The ID of the branch. - **branchName** (string) - The name of the branch. - **institution** (object) - Information about the institution owning the branch. - **institutionId** (integer) - The ID of the institution. - **institutionName** (string) - The name of the institution. - **bibliographicSummary** (object) - Summary of the bibliographic information. - **oclcNumber** (string) - The OCLC number of the bibliographic record. - **title** (string) - The title of the work. - **materialType** (string) - The material type of the item. - **author** (string) - The author of the work. - **publisher** (string) - The publisher of the work. - **publicationYear** (string) - The year of publication. - **language** (string) - The language of the work. - **edition** (string) - The edition of the work. #### Response Example (Success - Scheduled Hold) { "reason": { "reasonCode": "SCHEDULED" }, "dateRouted": "2017-04-14T16:09:15Z", "item": { "ref": "https://circ.sd00.worldcat.org/circ/items/ad49f6f9-65a8-440f-b537-7b68ef99be02", "ownerInstitution": { "institutionId": 128807, "institutionName": "OCLC WorldShare Platform Sandbox Institution" }, "pieceDesignation": "jeff1031", "callNumber": "FIC SCH", "itemRecordType": "SINGLE_PART", "numberOfPieces": 1, "homeLocation": { "shelvingLocationCode": "MAIN-STACKS", "holdingLocation": { "holdingLocationCode": "MAIN", "location": { "ref": "https://circ.sd00.worldcat.org/circ/branches/129479", "branchId": 129479, "branchName": "COP Sandbox - Main Branch", "institution": { "institutionId": 128807, "institutionName": "OCLC WorldShare Platform Sandbox Institution" } } } }, "bibliographicSummary": { "oclcNumber": "64207971", "title": "Skippyjon Jones in mummy trouble /", "materialType": "Book", "author": "Schachner, Judith Byron.", "publisher": "New York : Dutton Children's Books,", "publicationYear": "2006", "language": "eng", "edition": "1st ed." } } } #### Response Example (Success - Hold Forwarded) null ### Error Handling #### Unauthorized (401) - **message** (string) - Unauthorized #### Forbidden (403) - **message** (string) - Forbidden #### Method Not Allowed (405) - **title** (string) - NOT_ALLOWED - **detail** (string) - POST method not allowed #### Not Acceptable (406) - **title** (string) - NOT_ACCEPTABLE - **detail** (string) - Media type application/xml not supported. Supported media types: application/json #### Acknowledgements Required (400) - **errorCode** (string) - ACKNOWLEDGEMENTS_REQUIRED - **message** (string) - There are outstanding issues that must be acknowledged for this operation - **detail** (object) - **missing** (object) - **staffNotes** (array of strings) - List of staff notes requiring acknowledgement. #### Missing Item (400) - **errorCode** (string) - BAD_STATUS - **message** (string) - Unable to check in item as it is not currently available - **detail** (object) - **status** (string) - The status of the item (e.g., MISSING). #### Withdrawn Item (400) - **errorCode** (string) - BAD_STATUS - **message** (string) - Unable to check in item as it is not currently available - **detail** (object) - **status** (string) - The status of the item (e.g., WITHDRAWN). #### Checked Out Item (400) - **errorCode** (string) - BAD_STATUS - **message** (string) - Unable to check in item as it is not currently available - **detail** (object) - **status** (string) - The status of the item (e.g., ON_LOAN). #### Lost Item (400) - **errorCode** (string) - BAD_STATUS - **message** (string) - Unable to check in item as it is not currently available - **detail** (object) - **status** (string) - The status of the item (e.g., LOST). #### Unknown Item (404) - **timestamp** (string) - The date and time of the error. - **status** (integer) - The HTTP status code (404). - **error** (string) - The error type (Not Found). ``` -------------------------------- ### Example Success Response - Monograph Source: https://developer.api.oclc.org/docs/wms_availability/openapi.yaml An example of a successful response when searching for a monograph, demonstrating the structure of the returned bibliographic data. ```APIDOC ## Example Success Response (Monograph) ### Response Body ```xml 1 default OPACXML xml cas a 15703846 870518c19899999wiuar s0 a0eng c 96655081 GZQ eng GZQ OCL DLC OCLCQ OCLCF OCLCO OCLCA 9611 AU@ 000012673379 pcc n-us-wi L216 .B36 subser. Z678.4.W6 027.0775 20 ``` ``` -------------------------------- ### Successful Request Example for Monograph Source: https://developer.api.oclc.org/docs/wms_availability/openapi.yaml An example of a successful XML response for a monograph search request, including record details and bibliographic information. ```xml 1 default OPACXML xml cas a 15703846 870518c19899999wiuar s0 a0eng c 96655081 GZQ eng GZQ OCL DLC OCLCQ OCLCF OCLCO OCLCA 9611 AU@ 000012673379 pcc n-us-wi L216 .B36 subser. Z678.4.W6 027.0775 20 ``` -------------------------------- ### Citations API Response Examples Source: https://developer.api.oclc.org/docs/citations-api/openapi-external-prod.yaml Examples of successful responses for retrieving citations in different styles. ```APIDOC ## GET /citations/{oclcNumber} ### Description Retrieves citation information for a given OCLC number. ### Method GET ### Endpoint /citations/{oclcNumber} ### Parameters #### Path Parameters - **oclcNumber** (string) - Required - The OCLC number of the citation to retrieve. ### Response #### Success Response (200) - **hasProblems** (boolean) - An indicator if problems are present in a Citations result. - **entries** (array) - An array of citation or problem entries. - **resultType** (string) - The type of result, e.g., 'citation' or 'problem'. - **oclcNumber** (string) - The OCLC number associated with the citation. - **isbn** (array of strings) - A list of ISBNs for the citation. - **style** (string) - The citation style used (e.g., 'apa', 'american-medical-association'). - **citationText** (string) - The formatted citation text. ### Response Example (APA Style) ```json { "hasProblems": false, "entries": [ { "resultType": "citation", "oclcNumber": "41266045", "isbn": [ "0439136350", "9780439136358", "0439136369", "9780439136365", "9781480614994", "1480614998", "9780439655484", "043965548X", "9780545582933", "0545582938", "9780606323475", "0606323473", "0758756623", "9780439827607", "0545044251", "9780545044257", "0439827604", "9780758756626", "9780756908973", "0756908973", "0439554926", "9780439554923", "9780605953208", "0605953201", "9781435238121", "1435238125", "9781484476253", "1484476255" ], "style": "apa", "citationText": "Rowling, J., & GrandPré, M. (1999). Harry potter and the prisoner of azkaban (1st American ed., Harry potter series, 3). New York: Arthur A. Levine Books." } ] } ``` ### Response Example (AMA Style) ```json { "hasProblems": false, "entries": [ { "resultType": "citation", "oclcNumber": "41266045", "isbn": [ "9780439136358", "0439136350", "9780439136365", "0439136369", "9780439554923", "0439554926", "9780605953208", "0605953201", "9780606323475", "0606323473", "9781435238121", "1435238125", "9781480614994", "1480614998", "9780756908973", "0756908973" ], "style": "american-medical-association", "citationText": "
\n
\n
1.
Rowling JK. Harry Potter and the Prisoner of Azkaban. First American edition. Arthur A. Levine Books; 1999.
\n
\n
" } ] } ``` ### Response Example (ASA Style) ```json { "hasProblems": false, "entries": [ { "resultType": "citation", "oclcNumber": "41266045", "isbn": [ "9780439136358", "0439136350", "9780439136365", "0439136369", "9780439554923", "0439554926", "9780605953208", "0605953201", "9780606323475", "0606323473", "9781435238121", "1435238125", "9781480614994", "1480614998" ] } ] } ``` ``` -------------------------------- ### NCIP Checkout to User Source: https://developer.api.oclc.org/docs/ncip-resource-sharing/openapi.yaml This example demonstrates how to perform an NCIP CheckOutItem operation to a user. ```APIDOC ## NCIP Checkout to User ### Description This endpoint allows for checking out an item to a user. ### Method POST ### Endpoint /ncip/checkout ### Request Body - **NCIPMessage** (xml) - The NCIP message containing the check-out details. ### Request Example ```xml ReShare 127923 WMS Circ 127923 Barcode ItemBarcode UserId UserIdentifier ``` ### Response #### Success Response (200) - **NCIPMessage** (xml) - The NCIP response message. #### Response Example (Response example not provided in source) ``` -------------------------------- ### LBD MARC Record Example Source: https://developer.api.oclc.org/docs/wc-metadata/openapi-external-prod.yaml Example of a new LBD MARC record in a compact, delimited format. This is an alternative to MARC XML for LBD records. ```text 00086n a2200061 4500004000600000935001000006940000800016316d0   ``` -------------------------------- ### NCIP CheckOutItem Request Example Source: https://developer.api.oclc.org/docs/ncip-staff/openapi.yaml This is an example of an NCIP message for checking out an item. It includes user and item identifiers, along with item element types. ```xml 128807 128807 Version 2011 128807 6147646220 128807 10176 2019-02-04T16:31:00+00:00 Bibliographic Description Circulation Status Item Description Location ``` -------------------------------- ### CheckOutItemResponse - Basic Success Source: https://developer.api.oclc.org/docs/ncip-staff/openapi.yaml Example of a basic successful CheckOutItemResponse. ```xml 128807 10176 ``` -------------------------------- ### CheckInItemResponse - Route for Hold Source: https://developer.api.oclc.org/docs/ncip-staff/openapi.yaml Example of a successful CheckInItemResponse where the item needs to be routed for a hold. ```xml 128807 SC123454 Request Current Location 1 EAST Hold 128807 smithk Karen Smith ``` -------------------------------- ### User Address Information Example Source: https://developer.api.oclc.org/docs/ncip-resource-sharing/openapi.yaml Demonstrates the structure for user address information, including physical and electronic addresses. ```xml 1200 Industrial Ave Long Beach CA United States 90803 Work mailto tony@starkindustries.com Work tel 212-970-4133 ``` -------------------------------- ### NCIP CheckOutItem Message Example Source: https://developer.api.oclc.org/docs/ncip-resource-sharing/openapi.yaml Example of an NCIP CheckOutItem message. This message is used to record the checkout of an item to a user. ```xml SHAREit 128807 WMS Circ 128807 2.00 Barcode schluete Barcode 30135 ILL Request Id 123456789 2019-02-04T16:31:00+00:00 ``` -------------------------------- ### Existing LBD MARC Record Example Source: https://developer.api.oclc.org/docs/wc-metadata/openapi-external-prod.yaml Example of an existing LBD MARC record in a compact, delimited format, including control fields. ```text 00136n a2200085 4500001001000000004000500010005001700015935001000032940000800042589046562316020210910120824.8   ``` -------------------------------- ### Check Out Item (General) Source: https://developer.api.oclc.org/docs/ncip-resource-sharing/openapi.yaml This example demonstrates a general NCIP CheckOutItem message. It includes essential elements for initiating a checkout process, such as user and item identifiers. ```APIDOC ## CheckOutItem ### Description This endpoint is used to check out an item for a user. ### Method POST ### Endpoint /ncip/checkout ### Request Body - **NCIPMessage** (XML) - The NCIP message containing the CheckOutItem request. ### Request Example ```xml 128807 91475 2.0 Relais WMS Circ OCLC Institution Registry Id 91475 OCPSB ILL Request Id 33874 ``` ### Response #### Success Response (200) - **NCIPMessage** (XML) - The NCIP response message indicating the status of the checkout operation. ``` -------------------------------- ### NCIP CheckOutItem to User Source: https://developer.api.oclc.org/docs/ncip-resource-sharing/openapi.yaml This example demonstrates how to check out an item to a user. Ensure the AgencyId is updated with the correct institution ID. ```xml ReShare 127923 WMS Circ 127923 ``` -------------------------------- ### Create a list Source: https://developer.api.oclc.org/docs/lists/openapi-external-prod.yaml Creates a new list for the authenticated user. Requires a request body containing the list details. ```APIDOC ## POST /worldcat-org-lists/my-lists ### Description Create a list Create a List ### Method POST ### Endpoint /worldcat-org-lists/my-lists ### Parameters #### Request Body - **CreateList** (object) - Required - Schema defining the structure for creating a new list. ``` -------------------------------- ### LHR MARC XML Record Example Source: https://developer.api.oclc.org/docs/wc-metadata/openapi-external-prod.yaml Example of a new LHR MARC XML record. This format is used for creating or updating LHR records. ```xml 00000nx a2200000zi 4500 312010 zu 1103280p 0 4001uueng0210908 OCWMS EAST EAST-STACKS 879456 ``` -------------------------------- ### NCIP Checkout Item Example Source: https://developer.api.oclc.org/docs/ncip-staff/openapi.yaml This XML demonstrates how to perform a check-out operation for an item. It includes user and item identifiers, along with requested item element types. ```xml 129479 129479 Version 2011 128807 2200998 128807 10176 Bibliographic Description Circulation Status Item Description Location ``` -------------------------------- ### Create Vendor Source: https://developer.api.oclc.org/vic Creates a new vendor in the system. ```APIDOC ## POST /vendors ### Description Create Vendor allows you to add a new vendor to the system. ### Method POST ### Endpoint /vendors ### Request Body - **vendor** (Vendor) - Required - The vendor object to create. ``` -------------------------------- ### LBD MARC XML Record Example Source: https://developer.api.oclc.org/docs/wc-metadata/openapi-external-prod.yaml Example of a new LBD MARC XML record. This format is used for creating or updating LBD records. ```xml 00000n a2200000 4500 3160 MyLSN OCWMS ``` -------------------------------- ### POST /sign-ons Source: https://developer.api.oclc.org/docs/authman-api/openapi.yaml Create or update a user's sign-on credentials at an Identity Provider (IdP). This endpoint supports migrating existing sign-ons to guest accounts. ```APIDOC ## POST /sign-ons ### Description Create or update a user's sign-on credentials at an Identity Provider (IdP). This endpoint supports migrating existing sign-ons to guest accounts. ### Method POST ### Endpoint /sign-ons ### Request Body - **sourceSystem** (string) - Required - URN identifying the source system where the identifier originates. - **urn:mace:oclc.org:eidm:schema:mus:20230101** (object) - Required - Contains user credentials. - **username** (string) - Required - The username for the sign-on. - **active** (boolean) - Required - Indicates if the sign-on is active. - **credential** (object) - Required - The credential details. - **expirationDate** (string) - Required - The expiration date of the credential in date-time format. ### Request Example ```json { "sourceSystem": "urn:mace:oclc:idm:ocwms", "urn:mace:oclc.org:eidm:schema:mus:20230101": { "username": "alice.cooper", "active": true, "credential": { "expirationDate": "2021-07-28T21:15:26.551Z" } } } ``` ### Response #### Success Response (200) - **schema** (object) - The schema for the response body. #### Success Response (201) - **Location** (string) - The URL of the created resource. #### Error Response (404) - **description** - Not Found ```