Act on Lending Requests

{
  "type": "object",
  "description": "Resource sharing request Object.",
  "properties": {
    "additional_barcode": {
      "type": "array",
      "description": "List of additional barcodes. Note that the first one appears in the main barcode field.",
      "items": {
        "type": "string"
      }
    },
    "additional_person_name": {
      "type": "string",
      "description": "The name of an additional contact."
    },
    "agree_to_copyright_terms": {
      "type": "boolean",
      "description": "Indication whether the requester has agreed to the copyright terms. Mandatory for borrowing requests. Currently not relevant for lending requests."
    },
    "allow_other_formats": {
      "type": "boolean",
      "description": "Indication whether other formats besides the value in format field are acceptable. Default is false."
    },
    "author": {
      "type": "string",
      "description": "Author of the requested resource."
    },
    "author_initials": {
      "type": "string",
      "description": "Author initials of the requested resource."
    },
    "barcode": {
      "type": "string",
      "description": "Barcode of the requested resource."
    },
    "bib_note": {
      "type": "string",
      "description": "The note of the bibliographic record."
    },
    "call_number": {
      "type": "string",
      "description": "The call number of the book. Indicates the library shelf on which the books are located."
    },
    "chapter": {
      "type": "string",
      "description": "The chapter number in the journal that contains the article."
    },
    "chapter_author": {
      "type": "string",
      "description": "For a book chapter, the author of this chapter."
    },
    "chapter_title": {
      "type": "string",
      "description": "For a book chapter, the title of this chapter."
    },
    "citation_type": {
      "type": "object",
      "description": "Type of the requested resource. For example, book or article. Mandatory for borrowing requests. Mandatory when creating a lending request unless mms_id is supplied. For borrowing requests, possible codes are listed in 'PhysicalReadingListCitationTypes' [code table](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API): BK / CR. For lending requests, possible codes are listed in PR_CitationType [code table](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API): BOOK / JOURNAL.",
      "properties": {
        "desc": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "copyright_status": {
      "type": "object",
      "description": "The copyright status of the request. Relevant if requested format is Digital, and 'rs_borrower_copyright_management' in customer parameters is true. Possible options are listed in 'ResourceSharingCopyrightsStatus' [code table](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API), default is generated per request. Relevant for GET, POST and PUT of borrowing requests, and GET of lending requests.",
      "properties": {
        "desc": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "created_date": {
      "type": "string",
      "format": "date",
      "description": "The request creation date."
    },
    "created_time": {
      "type": "string",
      "format": "date-time",
      "description": "The request creation time."
    },
    "doi": {
      "type": "string",
      "description": "The doi of the requested resource."
    },
    "edition": {
      "type": "string",
      "description": "The edition of the requested resource."
    },
    "editor": {
      "type": "string",
      "description": "The editor of the book (typically used for books where chapters have different authors)."
    },
    "end_page": {
      "type": "string",
      "description": "The end page of the requested resource."
    },
    "external_id": {
      "type": "string",
      "description": "External identifier of the resource sharing request. Mandatory when creating a lending request."
    },
    "format": {
      "type": "object",
      "description": "Format of the resource requested. For example, physical or digital. Mandatory. Possible codes are listed in RequestFormats [code tables](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API).",
      "properties": {
        "desc": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "fund": {
      "type": "object",
      "description": "The code of the fund. Not relevant for lending requests.",
      "properties": {
        "desc": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "has_active_notes": {
      "type": "boolean",
      "description": "Indication whether the request has active notes. Output parameter."
    },
    "isbn": {
      "type": "string",
      "description": "ISBN of the requested resource."
    },
    "issn": {
      "type": "string",
      "description": "ISSN of the requested resource."
    },
    "issue": {
      "type": "string",
      "description": "The issue of the requested resource."
    },
    "journal_title": {
      "type": "string",
      "description": "The title of the journal. Relevant when an article is requested."
    },
    "last_interest_date": {
      "type": "string",
      "format": "date",
      "description": "Last date the request is needed. Optional."
    },
    "last_modified_date": {
      "type": "string",
      "format": "date",
      "description": "Date by which the last change to the request was made."
    },
    "last_modified_time": {
      "type": "string",
      "format": "date-time",
      "description": "Time by which the last change to the request was made."
    },
    "lcc_number": {
      "type": "string",
      "description": "The library of congress number of the book."
    },
    "level_of_service": {
      "type": "object",
      "description": "The code of the resource sharing request Level of Service. Possible options are listed in 'LevelOfService' [code table](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API), default is generated per request.",
      "properties": {
        "desc": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "lost_damaged_fee": {
      "type": "object",
      "required": [
        "currency",
        "sum"
      ],
      "properties": {
        "currency": {
          "type": "object",
          "description": "The currency. Possible values are listed in 'Currency_CT' [code table](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API).",
          "properties": {
            "desc": {
              "type": "string"
            },
            "value": {
              "type": "string"
            }
          }
        },
        "sum": {
          "type": "number",
          "format": "double",
          "description": "The total sum."
        }
      }
    },
    "maximum_fee": {
      "type": "number",
      "format": "float",
      "description": "Maximum fee the user is willing to pay for the request. Currently not relevant for lending requests."
    },
    "mms_id": {
      "type": "string",
      "description": "MMS ID of the requested resource. Borrowing request: this is relevant after physical material has arrived. Lending request: if supplied when creating a request, the request will be attached to this bib record. See [GET BIB API](https://developers.exlibrisgroup.com/alma/apis/bibs/GET/gwPcGly021om4RTvtjbPleCklCGxeYAf3JPdiJpJhUA=/af2fb69d-64f4-42bc-bb05-d8a0ae56936e)."
    },
    "need_patron_info": {
      "type": "boolean",
      "description": "Indication whether patron information is needed. Not relevant for lending requests."
    },
    "note": {
      "type": "string",
      "description": "General note."
    },
    "oclc_number": {
      "type": "string",
      "description": "The oclc number of the book."
    },
    "other_standard_id": {
      "type": "string",
      "description": "The other standard id of the requested resource."
    },
    "owner": {
      "type": "string",
      "description": "The resource sharing library code. See [Get libraries API](https://developers.exlibrisgroup.com/alma/apis/conf/GET/gwPcGly021p29HpB7XTI4Dp4I8TKv6CAxBlD4LyRaVE=/37088dc9-c685-4641-bc7f-60b5ca7cabed). Borrowing request: Optional. Used only when there are more than one resource sharing library defined for the user. Lending request: Mandatory."
    },
    "pages": {
      "type": "string",
      "description": "The relevant pages of the requested resource."
    },
    "part": {
      "type": "string",
      "description": "The part of the requested resource."
    },
    "partner": {
      "type": "object",
      "description": "The code of the partner related to this request. See [Get partners API](https://developers.exlibrisgroup.com/alma/apis/partners/GET/gwPcGly021piAVNPLaef7suP1zfa6Lui/8883ef41-c3b8-4792-9ff8-cb6b729d6e07). Mandatory when creating a lending request.",
      "properties": {
        "desc": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "pickup_location": {
      "type": "object",
      "description": "The pickup library code where the resource will be delivered. Relevant and mandatory for physical format delivery Borrowing request. Optional for digital format. Not relevant for lending requests.",
      "properties": {
        "desc": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "pickup_location_type": {
      "type": "string",
      "description": "The pickup location type. The pickup location type. Possible values are: LIBRARY, CIRCULATION_DESK."
    },
    "place_of_publication": {
      "type": "string",
      "description": "The publication place of the requested resource."
    },
    "pmid": {
      "type": "string",
      "description": "The pmid of the requested resource."
    },
    "preferred_send_method": {
      "type": "object",
      "description": "Preferred send method. Possible options are listed in 'ResourceSharingRequestSendMethod' [code table](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API). Currently not relevant for lending requests.",
      "properties": {
        "desc": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "printed": {
      "type": "boolean",
      "description": "Indication whether the request is printed. Output parameter. Relevant for lending requests."
    },
    "publisher": {
      "type": "string",
      "description": "Publisher of the requested resource."
    },
    "reading_room": {
      "type": "object",
      "description": "The code of the reading room where the item will be picked up. Mandatory when for_reading_room_only is true. Not relevant for lending requests.",
      "properties": {
        "desc": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "receive_cost": {
      "type": "object",
      "required": [
        "currency",
        "sum"
      ],
      "properties": {
        "currency": {
          "type": "object",
          "description": "The currency. Possible values are listed in 'Currency_CT' [code table](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API).",
          "properties": {
            "desc": {
              "type": "string"
            },
            "value": {
              "type": "string"
            }
          }
        },
        "sum": {
          "type": "number",
          "format": "double",
          "description": "The total sum."
        }
      }
    },
    "remote_record_id": {
      "type": "string",
      "description": "The remote record id of the requested resource."
    },
    "reported": {
      "type": "boolean",
      "description": "Indication whether the request is reported. Output parameter. Relevant for lending requests."
    },
    "request_cost": {
      "type": "object",
      "required": [
        "currency",
        "sum"
      ],
      "properties": {
        "currency": {
          "type": "object",
          "description": "The currency. Possible values are listed in 'Currency_CT' [code table](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API).",
          "properties": {
            "desc": {
              "type": "string"
            },
            "value": {
              "type": "string"
            }
          }
        },
        "sum": {
          "type": "number",
          "format": "double",
          "description": "The total sum."
        }
      }
    },
    "request_id": {
      "type": "string",
      "description": "Internal identifier of the resource sharing request in Alma, generated by Alma. Should be used in subsequent queries regarding the request."
    },
    "requested_language": {
      "type": "object",
      "description": "The requested language for the resource sharing request. Possible codes are the enabled fields in ResourceSharingLanguages [code table](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API). Default is null.",
      "properties": {
        "desc": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "requested_media": {
      "type": "string",
      "description": "A description of the requested media. possible values are 1-7 (codes from request media code table), and the codes from 'AdditionalRequestedMedia' [code table](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API). The valid values are according to the Requested media definition mapping table."
    },
    "requester": {
      "type": "object",
      "description": "The primary identifier and full name of the requesting user. Relevant for borrowing requests. Not relevant for lending requests.",
      "properties": {
        "desc": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "rs_note": {
      "type": "array",
      "description": "List of related notes that appear in the Notes tab in the UI..",
      "items": {
        "type": "object",
        "description": "Specific related note.",
        "properties": {
          "content": {
            "type": "string",
            "description": "The note's text. Mandatory."
          },
          "created_by": {
            "type": "string",
            "description": "The creator of the note."
          },
          "created_date": {
            "type": "string",
            "format": "date",
            "description": "The creation date of the note. Default is the current date."
          }
        }
      }
    },
    "series_title_number": {
      "type": "string",
      "description": "The series title number of the requested resource."
    },
    "shipping_cost": {
      "type": "object",
      "required": [
        "currency",
        "sum"
      ],
      "properties": {
        "currency": {
          "type": "object",
          "description": "The currency. Possible values are listed in 'Currency_CT' [code table](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API).",
          "properties": {
            "desc": {
              "type": "string"
            },
            "value": {
              "type": "string"
            }
          }
        },
        "sum": {
          "type": "number",
          "format": "double",
          "description": "The total sum."
        }
      }
    },
    "source": {
      "type": "string",
      "description": "The source of the requested resource."
    },
    "specific_edition": {
      "type": "boolean",
      "description": "Indication whether edition is used in ISO Protocol and in Locate process. Default is true. Relevant when a book is requested."
    },
    "start_page": {
      "type": "string",
      "description": "The relevant start page of the requested resource."
    },
    "status": {
      "type": "object",
      "description": "The resource sharing request status. Borrowing request: Possible codes are listed in MandatoryBorrowingWorkflowSteps or OptionalBorrowingWorkflowSteps [code tables](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API). Lending request: Possible codes are listed in MandatoryLendingWorkflowSteps or OptionalLendingWorkflowSteps [code tables](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API).",
      "properties": {
        "desc": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "supplied_format": {
      "type": "object",
      "description": "Format of the supplied item. For example, physical or digital. Possible codes are listed in RequestFormats [code table](https://developers.exlibrisgroup.com/blog/Working-with-the-code-tables-API). Relevant only after the request is supplied.",
      "properties": {
        "desc": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "text_email": {
      "type": "string",
      "description": "Borrowing request: In use with alternative_address only. In use when sending in digital format. Lending request: Requester's Email."
    },
    "text_postal_1": {
      "type": "string",
      "description": "In use with alternative_address only. Not relevant for lending requests."
    },
    "text_postal_2": {
      "type": "string",
      "description": "In use with alternative_address only. Not relevant for lending requests."
    },
    "text_postal_3": {
      "type": "string",
      "description": "In use with alternative_address only. Not relevant for lending requests."
    },
    "text_postal_4": {
      "type": "string",
      "description": "In use with alternative_address only. Not relevant for lending requests."
    },
    "title": {
      "type": "string",
      "description": "Title of the requested resource. Mandatory unless mms_id is supplied."
    },
    "use_alternative_address": {
      "type": "boolean",
      "description": "An indication of whether the delivery should be to an alternative address. Default is false. Not relevant for lending requests."
    },
    "user_request": {
      "type": "object",
      "description": "The request linked to the resource sharing request. Borrowing requests: this is the related user request. Lending requests: this is the move/digitization request (if exists). See [GET user's request API](https://developers.exlibrisgroup.com/alma/apis/users/GET/gwPcGly021r0XQMGAttqcPPFoLNxBoEZbQsUC/MWTX7aNWi0EYKYFUfYyI8KvpG73JPdiJpJhUA=/0aa8d36f-53d6-48ff-8996-485b90b103e4).",
      "properties": {
        "link": {
          "type": "string"
        },
        "value": {
          "type": "string"
        }
      }
    },
    "volume": {
      "type": "string",
      "description": "The volume number of the journal that contains the article."
    },
    "willing_to_pay": {
      "type": "boolean",
      "description": "Indication whether patron is willing to pay. Currently not relevant for lending requests."
    },
    "year": {
      "type": "string",
      "description": "Publication date of the requested resource."
    }
  }
}