v1

latestOpenAPI 3.0.12026-07-1410045.5 KB
Requested Resources

Get Requested Resources

This API returns a list of requested resources to be picked from the shelf in Alma

get/almaws/v1/task-lists/requested-resources

Query parameters

librarystring required

The library of the given circulation desk or department where the resources are located. Mandatory.

circ_deskstring required

The circulation desk where the action is being performed. Mandatory.

locationstring

The location code. Optional.

order_bystring

The order in which to retrieve the results: location/call_number (default).

directionstring

The order direction in which to retrieve the results. Optional.

pickup_inststring

The pickup institution. Optional.

reportedstring

Show reported results: Y/N. Optional.

printedstring

Show printed results: Y/N. Optional.

limitinteger

Limits the number of results. Optional. Valid values are 0-100. Default value: 10.

offsetinteger

Offset of the results returned. Optional. Default value: 0, which means that the first results will be returned.

Response

OK - This method returns an object based on rest_requested_resources.xsd. See here

total_record_countinteger

The total number of requested resources.

Example response

{
  "requested_resource": [
    {
      "location": {
        "call_number": "BD450 .T266 1989",
        "copy": [
          {
            "barcode": "38751000062809",
            "base_status": {
              "value": "0"
            },
            "pid": "23321797470001021",
            "storage_location_id": "159111000"
          }
        ],
        "holding_id": {
          "value": "22321797490001021"
        },
        "library": {
          "value": "TML"
        },
        "shelving_location": "STACK"
      },
      "request": [
        {
          "comment": "your request is important to us",
          "id": "1117421001021",
          "request_date": "2015-05-05Z",
          "request_time": "2013-11-12T14:59:59.000Z",
          "requester": {
            "value": "John Smith"
          }
        }
      ],
      "resource_metadata": {
        "author": "Taylor, Charles, 1931-",
        "isbn": "0674824253 (alk. paper)",
        "mms_id": {
          "value": "99102122810001021"
        },
        "publication_place": "Cambridge, Mass. :",
        "publication_year": "1989",
        "publisher": "Harvard University",
        "title": "Sources of the self : the making of the modern identity / Charles Taylor."
      }
    }
  ]
}