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.

FieldTypeDescription
user_primary_idstringThe primary identifier of the requesting user. Output parameter.
request_idstringThe identifier of the request in Alma. Output parameter.
Should be used in subsequent queries regarding the request.
additional_idstringAdditional ID of the request (relevant for hold shelf sorting). Output parameter.
request_typerequest_typesThe 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_typestring with attr. The sub type of the request. Output parameter.
mms_idstringBibliographic record identifier. Output parameter.
titlestringThe title of the requested resource. Output parameter.
authorstringThe author of the requested resource. Output parameter.
descriptionstringThe 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_descriptionstringThe manual description of the requested resource.
holding_idstringHolding id of the requested resource.
Required when creating a request using manual_description.
pickup_locationstringDescription of the pickup location (library or circulation desk) where the resource will be delivered.
Output parameter.
Not relevant when request_type = DIGITIZATION.
pickup_location_typepickup_location_typesThe 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_librarystringThe pickup location library code.
Relevant and mandatory when request_type = HOLD or BOOKING.
see Get libraries API.
pickup_location_circulation_deskstringThe pickup location circulation desk code.
Relevant when request_type = HOLD or BOOKING, if pickup_location_type = CIRCULATION_DESK.
pickup_location_institutionstringThe 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_librarystring
The library where the available inventory is located. Output parameter.
See Get libraries API.
managed_by_circulation_deskstring
The circulation desk where the available inventory is located. Output parameter.
managed_by_library_codestring
The code of the library where the available inventory is located. Output parameter.
See Get libraries API.
managed_by_circulation_desk_codestring
The code of the circulation desk where the available inventory is located. Output parameter.
target_destinationstring 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:
CodeDescription
material_typestring 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:
CodeDescription
last_interest_datedateThe last date for which the request is needed. Optional.
partial_digitizationbooleanIndication whether the digitization is partial or full.
Relevant and mandatory when request_type = DIGITIZATION.
chapter_or_article_titlestringThe title of the chapter or article.
volumestring The volume number. Relevant for partial digitization.
issuestring The issue number. Relevant for partial digitization.
partstring The part to digitize. Relevant for partial digitization.
date_of_publicationstringDate of publication. Relevant for partial digitization.
chapter_or_article_authorstringThe author of the chapter or article.
required_pagesrequired_pagesThe pages required for digitization.
full_chapterstringAn indication whether the full chapter is requested for digitization. Valid options are: true of false (lower case).
commentstringThe related note of the request.
Mandatory when request_type = DIGITIZATION and partial_digitization is true.
request_statusrequest_statusThe status of the request.
Possible values are: In Process, On Hold Shelf, Not Started. Output parameter.
place_in_queueintThe place in queue of the request.
Output parameter.
request_datedateDeprecated - use request_time instead. Output parameter.
request_timedateTimeThe creation date and exact time of the request. Output parameter.
task_namestringThe task name.
Output parameter.
expiry_datedateThe expiry date of the request.
Output parameter.
booking_start_datedateTimeThe start date in which the request is needed.
Relevant and mandatory when request_type = BOOKING.
booking_end_datedateTimeThe end date in which the request is needed.
Relevant and mandatory when request_type = BOOKING.
adjusted_booking_start_datedateTimeThe actual start date of the request, as calculated by the system.
Relevant when request_type = BOOKING.
Output parameter.
adjusted_booking_end_datedateTimeThe actual end date of the request, as calculated by the system.
Relevant when request_type = BOOKING.
Output parameter.
destination_locationstring with attr. The location in the library to which the item is to be moved.
Relevant when request_type = MOVE.
call_number_typestring 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:
CodeDescription
call_numberstringThe call number of the holding to which the item is to be moved.
Relevant when request_type = MOVE.
item_policystring 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:
CodeDescription
due_back_datedateThe date the item is due back.
Relevant when request_type = MOVE and request_sub_type = MOVE_TO_TEMPORARY.
item_idstringItem 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.
barcodestringBarcode 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_sharingresource_sharingThe related resource sharing request.
copyrights_declaration_signed_by_patronbooleanAn indication whether copyrights declaration was signed by patron.
Relevant for patron digitization requests only.

 

resource_sharing

Description: The resource sharing request information.

FieldTypeDescription
idstringThe identifier of the resource sharing request in Alma.
external_idstring
External identifier of the resource sharing request.
partnerstring with attr.
The code of the partner related to the RS request. See Get partners API.
statusstring 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.

FieldTypeDescription
required_pages_rangepage_rangeThe ranges of pages requested for digitization.

 

page_range

Description: A range of pages.

FieldTypeDescription
from_pagestring
to_pagestring

 

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
__