{ "uuid": "8b4b6d0a-cec1-4f34-bca0-0304fb239339", "lastMigration": 29, "name": "Ex Libris APIs", "endpointPrefix": "", "latency": 0, "port": 3000, "hostname": "", "routes": [ { "uuid": "0515eac7-7c4f-4559-8e84-124627ac3fe1", "documentation": "Retrieve Printouts", "method": "get", "endpoint": "almaws/v1/task-lists/printouts", "responses": [ { "uuid": "a5b9592f-0a26-4ae0-b485-da66cf4ceb6d", "body": "{\n \"printout\": [\n {\n \"date\": \"2019-11-07T08:08:38.614Z\",\n \"id\": \"129313760000121\",\n \"letter\": \"
Welcome to...
\",\n \"link\": \"\",\n \"printer\": {\n \"desc\": \"printer name\",\n \"value\": \"Printout Queue.\"\n },\n \"printout\": \"Testing\",\n \"size\": \"3.6kb\",\n \"source\": \"Implementor, Ex Libris\",\n \"status\": {\n \"desc\": \"Pending\",\n \"value\": \"Pending\"\n }\n }\n ],\n \"total_record_count\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "OK - This method returns an object based on rest_printouts.xsd. See [here](/alma/apis/docs/xsd/rest_printouts.xsd)", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Exl-Api-Remaining", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "7197d3f9-dc4b-4aa7-817d-29bad1a3027a", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request\n\n401666|40166410 - 'Invalid parameter.'", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "8ed06fab-d7b9-41c8-a6bc-be9de8d66962", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "c125bc80-aef8-464e-9779-f1417c54ed20", "documentation": "Act on Printouts", "method": "post", "endpoint": "almaws/v1/task-lists/printouts", "responses": [ { "uuid": "0370bfe8-9dea-4cc7-90e5-30c75d2fa844", "body": "{\n \"printout\": [\n {\n \"date\": \"2019-11-07T08:08:38.614Z\",\n \"id\": \"129313760000121\",\n \"letter\": \"
Welcome to...
\",\n \"link\": \"\",\n \"printer\": {\n \"desc\": \"printer name\",\n \"value\": \"Printout Queue.\"\n },\n \"printout\": \"Testing\",\n \"size\": \"3.6kb\",\n \"source\": \"Implementor, Ex Libris\",\n \"status\": {\n \"desc\": \"Pending\",\n \"value\": \"Pending\"\n }\n }\n ],\n \"total_record_count\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "OK - This method returns an object based on rest_printouts.xsd. See [here](/alma/apis/docs/xsd/rest_printouts.xsd)", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Exl-Api-Remaining", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "19a814ca-9036-4e10-8b47-766ecb469556", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request\n\n401666|40166410 - 'Invalid parameter.'", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "33bba65f-912d-412e-9c65-3478912811e8", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "bb593d0a-abf1-42e6-8975-6947f9061ec6", "documentation": "Retrieve a Printout", "method": "get", "endpoint": "almaws/v1/task-lists/printouts/:printout_id", "responses": [ { "uuid": "8b7cf7c8-eac1-4552-8a3a-3c1177aae808", "body": "{\n \"date\": \"2019-11-07T08:08:38.614Z\",\n \"id\": \"129313760000121\",\n \"letter\": \"
Welcome to...
\",\n \"link\": \"\",\n \"printer\": {\n \"desc\": \"printer name\",\n \"value\": \"Printout Queue.\"\n },\n \"printout\": \"Testing\",\n \"size\": \"3.6kb\",\n \"source\": \"Implementor, Ex Libris\",\n \"status\": {\n \"desc\": \"Pending\",\n \"value\": \"Pending\"\n }\n}", "latency": 0, "statusCode": 200, "label": "OK - This method returns an object based on rest_printout.xsd. See [here](/alma/apis/docs/xsd/rest_printout.xsd)", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Exl-Api-Remaining", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "3183c486-5660-4604-a099-6cc03afaf24e", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request\n\n402896 - 'Invalid printout ID.'", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "419e1e8a-00cc-409b-b611-3511315403fe", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "d1aa29c8-3061-4a8b-9b1a-5029237eddde", "documentation": "Printout Service", "method": "post", "endpoint": "almaws/v1/task-lists/printouts/:printout_id", "responses": [ { "uuid": "39822647-d620-41b5-bd4c-a80166a3dc3b", "body": "{\n \"date\": \"2019-11-07T08:08:38.614Z\",\n \"id\": \"129313760000121\",\n \"letter\": \"
Welcome to...
\",\n \"link\": \"\",\n \"printer\": {\n \"desc\": \"printer name\",\n \"value\": \"Printout Queue.\"\n },\n \"printout\": \"Testing\",\n \"size\": \"3.6kb\",\n \"source\": \"Implementor, Ex Libris\",\n \"status\": {\n \"desc\": \"Pending\",\n \"value\": \"Pending\"\n }\n}", "latency": 0, "statusCode": 200, "label": "OK - This method returns an object based on rest_printout.xsd. See [here](/alma/apis/docs/xsd/rest_printout.xsd)", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Exl-Api-Remaining", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "c5ce9bd7-2856-4d2a-ad1a-1c2fbefe1837", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request\n\n402896 - 'Invalid printout ID.'\n\n40166410 - 'Invalid parameter.'\n\n40166412 - 'Failed to perform action.'", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "a7678fe4-1166-45c1-98fd-f0551b737fd7", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9139d2dd-dc6d-4dc1-a778-4c67b5b13fab", "documentation": "Get Requested Resources", "method": "get", "endpoint": "almaws/v1/task-lists/requested-resources", "responses": [ { "uuid": "5387c33d-f75d-457f-94fc-3ab75e106419", "body": "{\n \"requested_resource\": [\n {\n \"location\": {\n \"call_number\": \"BD450 .T266 1989\",\n \"copy\": [\n {\n \"alternative_call_number\": \"\",\n \"barcode\": \"38751000062809\",\n \"base_status\": {\n \"desc\": \"\",\n \"value\": \"0\"\n },\n \"link\": \"\",\n \"pid\": \"23321797470001021\",\n \"storage_location_id\": \"159111000\"\n }\n ],\n \"holding_id\": {\n \"link\": \"\",\n \"value\": \"22321797490001021\"\n },\n \"library\": {\n \"desc\": \"\",\n \"value\": \"TML\"\n },\n \"shelving_location\": \"STACK\"\n },\n \"request\": [\n {\n \"comment\": \"your request is important to us\",\n \"destination\": {\n \"desc\": \"\",\n \"value\": \"\"\n },\n \"id\": \"1117421001021\",\n \"link\": \"\",\n \"printed\": \"true\",\n \"reported\": \"true\",\n \"request_date\": \"2015-05-05Z\",\n \"request_sub_type\": {\n \"desc\": \"\",\n \"value\": \"\"\n },\n \"request_time\": \"2013-11-12T14:59:59.000Z\",\n \"request_type\": \"{{oneOf (array 'BOOKING' 'DIGITIZATION' 'HOLD' 'MOVE' 'WORK_ORDER')}}\",\n \"requester\": {\n \"desc\": \"\",\n \"value\": \"John Smith\"\n }\n }\n ],\n \"resource_metadata\": {\n \"author\": \"Taylor, Charles, 1931-\",\n \"isbn\": \"0674824253 (alk. paper)\",\n \"issn\": \"\",\n \"mms_id\": {\n \"link\": \"\",\n \"value\": \"99102122810001021\"\n },\n \"publication_place\": \"Cambridge, Mass. :\",\n \"publication_year\": \"1989\",\n \"publisher\": \"Harvard University\",\n \"title\": \"Sources of the self : the making of the modern identity / Charles Taylor.\"\n }\n }\n ],\n \"total_record_count\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "OK - This method returns an object based on rest_requested_resources.xsd. See [here](/alma/apis/docs/xsd/rest_requested_resources.xsd)", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Exl-Api-Remaining", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "5338f4a7-f209-41a9-87d8-62fcc9babe6c", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request\n\n402119 - 'General error.'\n\n401664 - 'Mandatory field is missing: X.'\n\n40166414 - 'The parameter 'X' is mandatory. Valid options are: Y.'", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "06a4538d-e2ca-4309-9485-d68ba66dec34", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "be13d180-f1b9-49c1-8083-52e7763e995f", "documentation": "Act on Requested Resources", "method": "post", "endpoint": "almaws/v1/task-lists/requested-resources", "responses": [ { "uuid": "bc3498d7-b15b-4112-9d49-ea0bb1f2806c", "body": "{\n \"requested_resource\": [\n {\n \"location\": {\n \"call_number\": \"BD450 .T266 1989\",\n \"copy\": [\n {\n \"alternative_call_number\": \"\",\n \"barcode\": \"38751000062809\",\n \"base_status\": {\n \"desc\": \"\",\n \"value\": \"0\"\n },\n \"link\": \"\",\n \"pid\": \"23321797470001021\",\n \"storage_location_id\": \"159111000\"\n }\n ],\n \"holding_id\": {\n \"link\": \"\",\n \"value\": \"22321797490001021\"\n },\n \"library\": {\n \"desc\": \"\",\n \"value\": \"TML\"\n },\n \"shelving_location\": \"STACK\"\n },\n \"request\": [\n {\n \"comment\": \"your request is important to us\",\n \"destination\": {\n \"desc\": \"\",\n \"value\": \"\"\n },\n \"id\": \"1117421001021\",\n \"link\": \"\",\n \"printed\": \"true\",\n \"reported\": \"true\",\n \"request_date\": \"2015-05-05Z\",\n \"request_sub_type\": {\n \"desc\": \"\",\n \"value\": \"\"\n },\n \"request_time\": \"2013-11-12T14:59:59.000Z\",\n \"request_type\": \"{{oneOf (array 'BOOKING' 'DIGITIZATION' 'HOLD' 'MOVE' 'WORK_ORDER')}}\",\n \"requester\": {\n \"desc\": \"\",\n \"value\": \"John Smith\"\n }\n }\n ],\n \"resource_metadata\": {\n \"author\": \"Taylor, Charles, 1931-\",\n \"isbn\": \"0674824253 (alk. paper)\",\n \"issn\": \"\",\n \"mms_id\": {\n \"link\": \"\",\n \"value\": \"99102122810001021\"\n },\n \"publication_place\": \"Cambridge, Mass. :\",\n \"publication_year\": \"1989\",\n \"publisher\": \"Harvard University\",\n \"title\": \"Sources of the self : the making of the modern identity / Charles Taylor.\"\n }\n }\n ],\n \"total_record_count\": {{faker 'number.int' max=99999}}\n}", "latency": 0, "statusCode": 200, "label": "OK - This method returns an object based on rest_requested_resources.xsd. See [here](/alma/apis/docs/xsd/rest_requested_resources.xsd)", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Exl-Api-Remaining", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "89df1c63-4acd-4b52-8e93-91e0143ecae4", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request\n\n402119 - 'General error.'\n\n401664 - 'Mandatory field is missing: X.'\n\n40166414 - 'The parameter 'X' is mandatory. Valid options are: Y.'", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "1f1c6e43-387a-4ff1-8a95-123e7a7644d8", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "de48a6fb-9da1-40b7-8ebd-607b8d5ff15e", "documentation": "Get Lending Requests", "method": "get", "endpoint": "almaws/v1/task-lists/rs/lending-requests", "responses": [ { "uuid": "ddcbbbcb-6b43-4b1c-aab5-df8741d83779", "body": "{\n \"total_record_count\": {{faker 'number.int' max=99999}},\n \"user_resource_sharing_request\": [\n {\n \"additional_barcode\": [\n \"00023705571000021\"\n ],\n \"additional_person_name\": \"John Smith\",\n \"agree_to_copyright_terms\": \"true\",\n \"allow_other_formats\": \"true\",\n \"author\": \"John Smith\",\n \"author_initials\": \"J.S\",\n \"barcode\": \"00023705571000021\",\n \"bib_note\": \"\",\n \"call_number\": \"1\",\n \"chapter\": \"4\",\n \"chapter_author\": \"John Smith\",\n \"chapter_title\": \"Chapter title\",\n \"citation_type\": {\n \"desc\": \"\",\n \"value\": \"BK\"\n },\n \"copyright_status\": {\n \"desc\": \"\",\n \"value\": \"APPROVED\"\n },\n \"created_date\": \"2013-11-12Z\",\n \"created_time\": \"2019-12-18T14:36:48.659Z\",\n \"doi\": \"\",\n \"edition\": \"1\",\n \"editor\": \"John Smith\",\n \"end_page\": \"49\",\n \"external_id\": \"12013330000874120\",\n \"format\": {\n \"desc\": \"\",\n \"value\": \"PHYSICAL\"\n },\n \"fund\": {\n \"desc\": \"\",\n \"value\": \"\"\n },\n \"has_active_notes\": \"false\",\n \"isbn\": \"0674824253 (alk. paper)\",\n \"issn\": \"\",\n \"issue\": \"\",\n \"journal_title\": \"Journal title\",\n \"last_interest_date\": \"2013-12-13Z\",\n \"last_modified_date\": \"2015-10-11Z\",\n \"last_modified_time\": \"2019-12-18T14:36:48.659Z\",\n \"lcc_number\": \"102188800001\",\n \"level_of_service\": {\n \"desc\": \"\",\n \"value\": \"NORMAL_LOCAL\"\n },\n \"lost_damaged_fee\": {\n \"currency\": {\n \"desc\": \"\",\n \"value\": \"USD\"\n },\n \"sum\": \"0.00\"\n },\n \"maximum_fee\": \"2000.0\",\n \"mms_id\": \"9933745180101020\",\n \"need_patron_info\": \"true\",\n \"note\": \"\",\n \"oclc_number\": \"100100100\",\n \"other_standard_id\": \"100100100\",\n \"owner\": \"John Smith\",\n \"pages\": \"\",\n \"part\": \"\",\n \"partner\": {\n \"desc\": \"\",\n \"value\": \"10218885421021\"\n },\n \"pickup_location\": {\n \"desc\": \"\",\n \"value\": \"ONL\"\n },\n \"pickup_location_type\": \"LIBRARY\",\n \"place_of_publication\": \"Cambridge, Mass. :\",\n \"pmid\": \"1284442031021\",\n \"preferred_send_method\": {\n \"desc\": \"\",\n \"value\": \"ARIEL\"\n },\n \"printed\": \"true\",\n \"publisher\": \"John Smith\",\n \"reading_room\": {\n \"desc\": \"\",\n \"value\": \"\"\n },\n \"receive_cost\": {\n \"currency\": {\n \"desc\": \"\",\n \"value\": \"USD\"\n },\n \"sum\": \"0.00\"\n },\n \"remote_record_id\": \"100100100\",\n \"reported\": \"false\",\n \"request_cost\": {\n \"currency\": {\n \"desc\": \"\",\n \"value\": \"USD\"\n },\n \"sum\": \"0.00\"\n },\n \"request_id\": \"1001966830001021\",\n \"requested_language\": {\n \"desc\": \"\",\n \"value\": \"ml\"\n },\n \"requested_media\": \"1\",\n \"requester\": {\n \"desc\": \"\",\n \"value\": \"Jane doe\"\n },\n \"rs_note\": [\n {\n \"content\": \"\",\n \"created_by\": \"\",\n \"created_date\": \"2024-05-30Z\"\n }\n ],\n \"series_title_number\": \"100\",\n \"shipping_cost\": {\n \"currency\": {\n \"desc\": \"\",\n \"value\": \"USD\"\n },\n \"sum\": \"0.00\"\n },\n \"source\": \"\",\n \"specific_edition\": \"true\",\n \"start_page\": \"2\",\n \"status\": {\n \"desc\": \"\",\n \"value\": \"ACTIVE\"\n },\n \"supplied_format\": {\n \"desc\": \"\",\n \"value\": \"DIGITAL\"\n },\n \"text_email\": \"\",\n \"text_postal_1\": \"\",\n \"text_postal_2\": \"\",\n \"text_postal_3\": \"\",\n \"text_postal_4\": \"\",\n \"title\": \"Harry Potter\",\n \"use_alternative_address\": \"false\",\n \"user_request\": {\n \"link\": \"\",\n \"value\": \"\"\n },\n \"volume\": \"10\",\n \"willing_to_pay\": \"false\",\n \"year\": \"2010\"\n }\n ]\n}", "latency": 0, "statusCode": 200, "label": "OK - This method returns an object based on rest_user_resource_sharing_requests.xsd. See [here](/alma/apis/docs/xsd/rest_user_resource_sharing_requests.xsd)", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Exl-Api-Remaining", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "86b6715f-e939-4981-9ccd-76c157ddfa93", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request\n\n402119 - 'General error.'\n\n401664 - 'Mandatory field is missing: X.'\n\n40166414 - 'The parameter 'X' is mandatory. Valid options are: Y.'", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "228f2a0e-f561-4a6a-8bd1-b2357a58c55d", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "9cac22c0-9a48-4725-ba97-9e461cfe3860", "documentation": "Act on Lending Requests", "method": "post", "endpoint": "almaws/v1/task-lists/rs/lending-requests", "responses": [ { "uuid": "fd6db152-28b4-4016-9f23-d289e209dde2", "body": "{\n \"additional_barcode\": [\n \"00023705571000021\"\n ],\n \"additional_person_name\": \"John Smith\",\n \"agree_to_copyright_terms\": \"true\",\n \"allow_other_formats\": \"true\",\n \"author\": \"John Smith\",\n \"author_initials\": \"J.S\",\n \"barcode\": \"00023705571000021\",\n \"bib_note\": \"\",\n \"call_number\": \"1\",\n \"chapter\": \"4\",\n \"chapter_author\": \"John Smith\",\n \"chapter_title\": \"Chapter title\",\n \"citation_type\": {\n \"desc\": \"\",\n \"value\": \"BK\"\n },\n \"copyright_status\": {\n \"desc\": \"\",\n \"value\": \"APPROVED\"\n },\n \"created_date\": \"2013-11-12Z\",\n \"created_time\": \"2019-12-18T14:36:48.659Z\",\n \"doi\": \"\",\n \"edition\": \"1\",\n \"editor\": \"John Smith\",\n \"end_page\": \"49\",\n \"external_id\": \"12013330000874120\",\n \"format\": {\n \"desc\": \"\",\n \"value\": \"PHYSICAL\"\n },\n \"fund\": {\n \"desc\": \"\",\n \"value\": \"\"\n },\n \"has_active_notes\": \"false\",\n \"isbn\": \"0674824253 (alk. paper)\",\n \"issn\": \"\",\n \"issue\": \"\",\n \"journal_title\": \"Journal title\",\n \"last_interest_date\": \"2013-12-13Z\",\n \"last_modified_date\": \"2015-10-11Z\",\n \"last_modified_time\": \"2019-12-18T14:36:48.659Z\",\n \"lcc_number\": \"102188800001\",\n \"level_of_service\": {\n \"desc\": \"\",\n \"value\": \"NORMAL_LOCAL\"\n },\n \"lost_damaged_fee\": {\n \"currency\": {\n \"desc\": \"\",\n \"value\": \"USD\"\n },\n \"sum\": \"0.00\"\n },\n \"maximum_fee\": \"2000.0\",\n \"mms_id\": \"9933745180101020\",\n \"need_patron_info\": \"true\",\n \"note\": \"\",\n \"oclc_number\": \"100100100\",\n \"other_standard_id\": \"100100100\",\n \"owner\": \"John Smith\",\n \"pages\": \"\",\n \"part\": \"\",\n \"partner\": {\n \"desc\": \"\",\n \"value\": \"10218885421021\"\n },\n \"pickup_location\": {\n \"desc\": \"\",\n \"value\": \"ONL\"\n },\n \"pickup_location_type\": \"LIBRARY\",\n \"place_of_publication\": \"Cambridge, Mass. :\",\n \"pmid\": \"1284442031021\",\n \"preferred_send_method\": {\n \"desc\": \"\",\n \"value\": \"ARIEL\"\n },\n \"printed\": \"true\",\n \"publisher\": \"John Smith\",\n \"reading_room\": {\n \"desc\": \"\",\n \"value\": \"\"\n },\n \"receive_cost\": {\n \"currency\": {\n \"desc\": \"\",\n \"value\": \"USD\"\n },\n \"sum\": \"0.00\"\n },\n \"remote_record_id\": \"100100100\",\n \"reported\": \"false\",\n \"request_cost\": {\n \"currency\": {\n \"desc\": \"\",\n \"value\": \"USD\"\n },\n \"sum\": \"0.00\"\n },\n \"request_id\": \"1001966830001021\",\n \"requested_language\": {\n \"desc\": \"\",\n \"value\": \"ml\"\n },\n \"requested_media\": \"1\",\n \"requester\": {\n \"desc\": \"\",\n \"value\": \"Jane doe\"\n },\n \"rs_note\": [\n {\n \"content\": \"\",\n \"created_by\": \"\",\n \"created_date\": \"2024-05-30Z\"\n }\n ],\n \"series_title_number\": \"100\",\n \"shipping_cost\": {\n \"currency\": {\n \"desc\": \"\",\n \"value\": \"USD\"\n },\n \"sum\": \"0.00\"\n },\n \"source\": \"\",\n \"specific_edition\": \"true\",\n \"start_page\": \"2\",\n \"status\": {\n \"desc\": \"\",\n \"value\": \"ACTIVE\"\n },\n \"supplied_format\": {\n \"desc\": \"\",\n \"value\": \"DIGITAL\"\n },\n \"text_email\": \"\",\n \"text_postal_1\": \"\",\n \"text_postal_2\": \"\",\n \"text_postal_3\": \"\",\n \"text_postal_4\": \"\",\n \"title\": \"Harry Potter\",\n \"use_alternative_address\": \"false\",\n \"user_request\": {\n \"link\": \"\",\n \"value\": \"\"\n },\n \"volume\": \"10\",\n \"willing_to_pay\": \"false\",\n \"year\": \"2010\"\n}", "latency": 0, "statusCode": 200, "label": "OK - This method returns an object based on rest_user_resource_sharing_request.xsd. See [here](/alma/apis/docs/xsd/rest_user_resource_sharing_request.xsd)", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Exl-Api-Remaining", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "e792540e-8203-436c-963b-59b8d449dbf2", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request\n\n402119 - 'General error.'\n\n401666 - 'X parameter is not valid.'\n\n401664 - 'Mandatory field is missing: X.'\n\n40166414 - 'The parameter 'X' is mandatory. Valid options are: Y.'", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "9684c438-4482-45da-8095-a6b7c3b775ad", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "f95a0349-8ae2-42bc-9706-b66691d909de", "documentation": "GET Task-lists Test API", "method": "get", "endpoint": "almaws/v1/task-lists/test", "responses": [ { "uuid": "409ab294-662b-48f5-8248-f725cab8b2f2", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Exl-Api-Remaining", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "13581aef-559c-44ae-a52c-1ef01d8db97f", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request\n\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "69b7d6a4-0f9e-4223-801d-4bea7572412f", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" }, { "uuid": "a8f29200-1928-40b3-8782-3c4dd7fbbecb", "documentation": "POST Task-lists Test API", "method": "post", "endpoint": "almaws/v1/task-lists/test", "responses": [ { "uuid": "d62ec23a-9485-4dad-81e6-ec7e274f375d", "body": "{}", "latency": 0, "statusCode": 200, "label": "OK", "headers": [ { "key": "Content-Type", "value": "application/json" }, { "key": "X-Exl-Api-Remaining", "value": "" } ], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": true, "crudKey": "id" }, { "uuid": "ddb0e6d0-9172-4638-860a-9e79241b2f15", "body": "", "latency": 0, "statusCode": 400, "label": "Bad Request\n\n", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" }, { "uuid": "da1e22c8-644c-4bc5-bd0b-01ca0e261704", "body": "", "latency": 0, "statusCode": 500, "label": "Internal Server Error", "headers": [{ "key": "Content-Type", "value": "application/json" }], "bodyType": "INLINE", "filePath": "", "databucketID": "", "sendFileAsBody": false, "rules": [], "rulesOperator": "OR", "disableTemplating": false, "fallbackTo404": false, "default": false, "crudKey": "id" } ], "enabled": true, "responseMode": null, "type": "http" } ], "proxyMode": false, "proxyHost": "", "proxyRemovePrefix": false, "tlsOptions": { "enabled": false, "type": "CERT", "pfxPath": "", "certPath": "", "keyPath": "", "caPath": "", "passphrase": "" }, "cors": true, "headers": [], "proxyReqHeaders": [{ "key": "", "value": "" }], "proxyResHeaders": [{ "key": "", "value": "" }], "data": [], "folders": [], "rootChildren": [ { "type": "route", "uuid": "0515eac7-7c4f-4559-8e84-124627ac3fe1" }, { "type": "route", "uuid": "c125bc80-aef8-464e-9779-f1417c54ed20" }, { "type": "route", "uuid": "bb593d0a-abf1-42e6-8975-6947f9061ec6" }, { "type": "route", "uuid": "d1aa29c8-3061-4a8b-9b1a-5029237eddde" }, { "type": "route", "uuid": "9139d2dd-dc6d-4dc1-a778-4c67b5b13fab" }, { "type": "route", "uuid": "be13d180-f1b9-49c1-8083-52e7763e995f" }, { "type": "route", "uuid": "de48a6fb-9da1-40b7-8ebd-607b8d5ff15e" }, { "type": "route", "uuid": "9cac22c0-9a48-4725-ba97-9e461cfe3860" }, { "type": "route", "uuid": "f95a0349-8ae2-42bc-9706-b66691d909de" }, { "type": "route", "uuid": "a8f29200-1928-40b3-8782-3c4dd7fbbecb" } ] }