API Docs

Rest User Request

Overview

A resource request.
This can be a request for delivering a physical item to a patron (request types: HOLD,BOOKING),
a request for digitizing a file for a patron (DIGITIZATION),
a move request (MOVE) or work order (WORK_ORDER).
A request object can be retrieved, created and updated.
Currently only HOLD, DIGITIZATION and BOOKING can be created by API.
Note that the request object includes fields which are relevant only for specific request type(s).

Data Dictionary

Click here to download rest_user_request.xsd

user_request

Description: Request object.

Field	Type	Description
user_primary_id	string	The primary identifier of the requesting user. Output parameter.
request_id	string	The identifier of the request in Alma. Output parameter. Should be used in subsequent queries regarding the request.
additional_id	string	Additional ID of the request (relevant for hold shelf sorting). Output parameter.
request_type	request_types	The type of the request. Mandatory. GET action: Possible values are: HOLD, DIGITIZATION, BOOKING, MOVE, WORK_ORDER. POST action: Possible values are: HOLD, DIGITIZATION, BOOKING. Note that it is currently NOT possible to create GENERAL_DIGITIZATION, MOVE or WORK_ORDER request. PUT action: This field cannot be updated.
request_sub_type	string with attr.	The sub type of the request. Output parameter.
mms_id	string	Bibliographic record identifier. Output parameter.
title	string	The title of the requested resource. Output parameter.
author	string	The author of the requested resource. Output parameter.
description	string	The description of the requested resource when dealing with multi volume/issue resource. For item level requests this is an output parameter. When creating or updating a request for a specific periodical resource, the request is title level, but the specific volume/issue requested is input using this description field (e.g. "v.30, #4 Dec, 1966"). Please note that this field is sensitive to case and white spaces.
manual_description	string	The manual description of the requested resource.
holding_id	string	Holding id of the requested resource. Required when creating a request using manual_description.
pickup_location	string	Description of the pickup location (library or circulation desk) where the resource will be delivered. Output parameter. Not relevant when request_type = DIGITIZATION.
pickup_location_type	pickup_location_types	The pickup location type. The pickup location type. Possible values are: LIBRARY, CIRCULATION_DESK, INSTITUTION, USER_HOME_ADDRESS, USER_WORK_ADDRESS. Relevant and mandatory when request_type = HOLD or BOOKING.
pickup_location_library	string	The pickup location library code. Relevant and mandatory when request_type = HOLD or BOOKING. see Get libraries API.
pickup_location_circulation_desk	string	The pickup location circulation desk code. Relevant when request_type = HOLD or BOOKING, if pickup_location_type = CIRCULATION_DESK.
pickup_location_institution	string	The pickup location institution code. Relevant when request_type = HOLD or BOOKING, if the request is to be picked up in a different institution.
managed_by_library	string	The library where the available inventory is located. Output parameter. See Get libraries API.
managed_by_circulation_desk	string	The circulation desk where the available inventory is located. Output parameter.
managed_by_library_code	string	The code of the library where the available inventory is located. Output parameter. See Get libraries API.
managed_by_circulation_desk_code	string	The code of the circulation desk where the available inventory is located. Output parameter.
target_destination	string with attr.	The code of the department chosen to fulfill the digitization or work order request. A list of relevant departments can be retrieved using GET /almaws/v1/conf/departments?Type=DIGI The valid values for this parameter are controlled by the code-table: digi_departments. These are the currently defined values for your institution: Code Description
material_type	string with attr.	The requested material type code. Optional. Possible codes are listed in 'Physical Material Type' code table. This field is output parameter when the request is in item level, and input parameter when the request is in title level. The valid values for this parameter are controlled by the code-table: PhysicalMaterialType. These are the currently defined values for your institution: Code Description
last_interest_date	date	The last date for which the request is needed. Optional.
partial_digitization	boolean	Indication whether the digitization is partial or full. Relevant and mandatory when request_type = DIGITIZATION.
chapter_or_article_title	string	The title of the chapter or article.
volume	string	The volume number. Relevant for partial digitization.
issue	string	The issue number. Relevant for partial digitization.
part	string	The part to digitize. Relevant for partial digitization.
date_of_publication	string	Date of publication. Relevant for partial digitization.
chapter_or_article_author	string	The author of the chapter or article.
required_pages	required_pages	The pages required for digitization.
full_chapter	string	An indication whether the full chapter is requested for digitization. Valid options are: true of false (lower case).
comment	string	The related note of the request. Mandatory when request_type = DIGITIZATION and partial_digitization is true.
request_status	request_status	The status of the request. Possible values are: In Process, On Hold Shelf, Not Started. Output parameter. Note: When using the API with JSON the request_status are retrieved as codes: IN_PROCESS, ON_HOLD_SHELF etc.
place_in_queue	int	The place in queue of the request. Output parameter.
request_date	date	Deprecated - use request_time instead. Output parameter.
request_time	dateTime	The creation date and exact time of the request. Output parameter.
task_name	string	The task name. Output parameter.
expiry_date	date	The expiry date of the request. Output parameter.
booking_start_date	dateTime	The start date in which the request is needed. Relevant and mandatory when request_type = BOOKING.
booking_end_date	dateTime	The end date in which the request is needed. Relevant and mandatory when request_type = BOOKING.
adjusted_booking_start_date	dateTime	The actual start date of the request, as calculated by the system. Relevant when request_type = BOOKING. Output parameter.
adjusted_booking_end_date	dateTime	The actual end date of the request, as calculated by the system. Relevant when request_type = BOOKING. Output parameter.
destination_location	string with attr.	The location in the library to which the item is to be moved. Relevant when request_type = MOVE.
call_number_type	string with attr.	The call number type of the holding to which the item is to be moved. Relevant when request_type = MOVE. The valid values for this parameter are controlled by the code-table: CallNumberType. These are the currently defined values for your institution: Code Description
call_number	string	The call number of the holding to which the item is to be moved. Relevant when request_type = MOVE.
item_policy	string with attr.	The item policy to be applied in the new location. Relevant when request_type = MOVE. The valid values for this parameter are controlled by the code-table: ItemPolicy. These are the currently defined values for your institution: Code Description
due_back_date	date	The date the item is due back. Relevant when request_type = MOVE and request_sub_type = MOVE_TO_TEMPORARY.
item_id	string	Item pid of the request's related item. Output parameter. Relevant only when the request is in item level or is bound to a single item.
barcode	string	Barcode of the request's related item. Output parameter. Relevant only when the request is in item level or is bound to a single item.
resource_sharing	resource_sharing	The related resource sharing request.
copyrights_declaration_signed_by_patron	boolean	An indication whether copyrights declaration was signed by patron. Relevant for patron digitization requests only.

 

resource_sharing

Description: The resource sharing request information.

Field	Type	Description
id	string	The identifier of the resource sharing request in Alma.
external_id	string	External identifier of the resource sharing request.
partner	string with attr.	The code of the partner related to the RS request. See Get partners API.
status	string with attr.	The code of the resource sharing request status. Comes from the MandatoryBorrowingWorkflowSteps or OptionalBorrowingWorkflowSteps code tables.

 

required_pages

Description: The pages required for the digitization.

Field	Type	Description
required_pages_range	page_range	The ranges of pages requested for digitization.

 

page_range

Description: A range of pages.

Field	Type	Description
from_page	string
to_page	string

 

request_types

request_types is a xs:string with xs:restriction - see XSD for details.

pickup_location_types

pickup_location_types is a xs:string with xs:restriction - see XSD for details.

request_status

request_status is a xs:string with xs:restriction - see XSD for details.

Samples

XML

JSON

__