action exlibrisgroup_get_almaws_v1_task_lists_requested_resources {
  label: "Get Requested Resources"
  description: "This API returns a list of requested resources to be picked from the shelf in Alma"
  provider: exlibrisgroup
  method: GET
  path: "/almaws/v1/task-lists/requested-resources"
  encoding: json
  input: {
    type: "object"
    properties: {
      circ_desk: {
        type: "string"
      }
      direction: {
        type: "string"
      }
      library: {
        type: "string"
      }
      limit: {
        type: "integer"
      }
      location: {
        type: "string"
      }
      offset: {
        type: "integer"
      }
      order_by: {
        type: "string"
      }
      pickup_inst: {
        type: "string"
      }
      printed: {
        type: "string"
      }
      reported: {
        type: "string"
      }
    }
    required: ["circ_desk", "library"]
    additionalProperties: false
  }
  output: {
    type: "object"
    description: "A list of requested resources."
    properties: {
      requested_resource: {
        type: "array"
        description: "Requested resource object."
        items: {
          type: "object"
          description: "Requested resource to be picked from the shelf."
          properties: {
            location: {
              type: "object"
              description: "Location of the requested resource."
              properties: {
                call_number: {
                  type: "string"
                  description: "Call number of the item."
                }
                copy: {
                  type: "array"
                  description: "Copies of resource in a specific location."
                  items: {
                    type: "object"
                    description: "Specific copy of resource in a specific location."
                    properties: {
                      alternative_call_number: {
                        type: "string"
                        description: "Alternative call number."
                      }
                      barcode: {
                        type: "string"
                        description: "The item's barcode."
                      }
                      base_status: {
                        type: "object"
                        properties: {
                          desc: {
                            type: "string"
                          }
                          value: {
                            type: "string"
                          }
                        }
                      }
                      link: {
                        type: "string"
                      }
                      pid: {
                        type: "string"
                        description: "The resource's pid."
                      }
                      storage_location_id: {
                        type: "string"
                        description: "The item's storage location id."
                      }
                    }
                  }
                }
                holding_id: {
                  type: "object"
                  description: "Holding pid, a unique holding id that the resource is associated with."
                  properties: {
                    link: {
                      type: "string"
                    }
                    value: {
                      type: "string"
                    }
                  }
                }
                library: {
                  type: "object"
                  description: "Library of the requested resource. See [Get libraries API](https://developers.exlibrisgroup.com/alma/apis/conf/GET/gwPcGly021p29HpB7XTI4Dp4I8TKv6CAxBlD4LyRaVE=/37088dc9-c685-4641-bc7f-60b5ca7cabed)."
                  properties: {
                    desc: {
                      type: "string"
                    }
                    value: {
                      type: "string"
                    }
                  }
                }
                shelving_location: {
                  type: "string"
                  description: "The location."
                }
              }
            }
            request: {
              type: "array"
              description: "Requests for resource."
              items: {
                type: "object"
                description: "Request object."
                required: ["request_type"]
                properties: {
                  comment: {
                    type: "string"
                    description: "The related note of the request."
                  }
                  destination: {
                    type: "object"
                    description: "The destination will be a library in most cases. However, it may at times be: A circulation desk (when the pickup location is a reading room) A Home/Office code, where the request is for personal delivery A Work Order department"
                    properties: {
                      desc: {
                        type: "string"
                      }
                      value: {
                        type: "string"
                      }
                    }
                  }
                  id: {
                    type: "string"
                    description: "The identifier of the request in Alma."
                  }
                  link: {
                    type: "string"
                  }
                  printed: {
                    type: "boolean"
                    description: "Indication whether the request is printed."
                  }
                  reported: {
                    type: "boolean"
                    description: "Indication whether the request is reported."
                  }
                  request_date: {
                    type: "string"
                    format: "date"
                    description: "Deprecated - use request_time instead. The request date."
                  }
                  request_sub_type: {
                    type: "object"
                    description: "The sub type of the request."
                    properties: {
                      desc: {
                        type: "string"
                      }
                      value: {
                        type: "string"
                      }
                    }
                  }
                  request_time: {
                    type: "string"
                    format: "date-time"
                    description: "The creation date and exact time of the request. Output parameter."
                  }
                  request_type: {
                    type: "string"
                    enum: ["BOOKING", "DIGITIZATION", "HOLD", "MOVE", "WORK_ORDER"]
                  }
                  requester: {
                    type: "object"
                    description: "A description of the requester."
                    properties: {
                      desc: {
                        type: "string"
                      }
                      value: {
                        type: "string"
                      }
                    }
                  }
                }
              }
            }
            resource_metadata: {
              type: "object"
              description: "Metadata about the requested resource."
              properties: {
                author: {
                  type: "string"
                  description: "An entity primarily responsible for making the resource."
                }
                isbn: {
                  type: "string"
                  description: "ISBN"
                }
                issn: {
                  type: "string"
                  description: "ISSN"
                }
                mms_id: {
                  type: "object"
                  description: "The MMS id of the resource. See [GET BIB API](https://developers.exlibrisgroup.com/alma/apis/bibs/GET/gwPcGly021om4RTvtjbPleCklCGxeYAf3JPdiJpJhUA=/af2fb69d-64f4-42bc-bb05-d8a0ae56936e)."
                  properties: {
                    link: {
                      type: "string"
                    }
                    value: {
                      type: "string"
                    }
                  }
                }
                publication_place: {
                  type: "string"
                  description: "Place of publication."
                }
                publication_year: {
                  type: "string"
                  description: "The year associated with the publication of the resource."
                }
                publisher: {
                  type: "string"
                  description: "An entity responsible for making the resource available."
                }
                title: {
                  type: "string"
                  description: "The resource title."
                }
              }
            }
          }
        }
      }
      total_record_count: {
        type: "integer"
        format: "int32"
        description: "The total number of requested resources."
      }
    }
  }
}