Own Ex? Customize your docs with AI search, analytics, and more.

POST

Act on Lending Requests

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/task-lists/rs/lending-requests

This API preforms the requested action on a list (specified by given filters) of lending requests in Alma

Access Token Required: API Key

Query Params

librarystringDefault:

The resource sharing library from which lending requests should be retrieved. Mandatory. List of possible libraries can be retrieved using the [GET /almaws/v1/conf/libraries API](https://developers.exlibrisgroup.com/alma/apis/conf/GET/gwPcGly021p29HpB7XTI4Dp4I8TKv6CAxBlD4LyRaVE=/37088dc9-c685-4641-bc7f-60b5ca7cabed).

opstringDefault:

Operation to be preformed on the list of given requests. Currently the only supported action is 'mark_reported'. Mandatory.

statusstringDefault:

The status of lending requests to retrieve. Optional. List of possible statuses can be retrieved using the [GET almaws/v1/conf/code-tables/MandatoryLendingWorkflowSteps API](https://developers.exlibrisgroup.com/alma/apis/conf/GET/gwPcGly021p29HpB7XTI4K7cQ0vuYHLS4NSgDGmcRpRYqx5hIMRTng9SIKO5Vof+/37088dc9-c685-4641-bc7f-60b5ca7cabed).and the [GET almaws/v1/conf/code-tables/OptionalLendingWorkflowSteps API](https://developers.exlibrisgroup.com/alma/apis/conf/GET/gwPcGly021p29HpB7XTI4K7cQ0vuYHLS4NSgDGmcRpRYqx5hIMRTng9SIKO5Vof+/37088dc9-c685-4641-bc7f-60b5ca7cabed).

printedstringDefault:

The 'printed' value of lending requests to retrieve. Optional. Possible values: Y, N.

reportedstringDefault:

The 'reported' value of lending requests to retrieve. Optional. Possible values: Y, N.

partnerstringDefault:

The partner value. Only lending requests from this partner should be. Optional. List of possible partners can be retrieved using the [GET almaws/v1/partners API](https://developers.exlibrisgroup.com/alma/apis/partners/GET/gwPcGly021piAVNPLaef7suP1zfa6Lui/8883ef41-c3b8-4792-9ff8-cb6b729d6e07).

requested_formatstringDefault:

Requested format of the resource. Optional. List of possible formats can be retrieved using the [GET almaws/v1/conf/code-tables/RequestFormats API](https://developers.exlibrisgroup.com/alma/apis/conf/GET/gwPcGly021p29HpB7XTI4K7cQ0vuYHLS4NSgDGmcRpRYqx5hIMRTng9SIKO5Vof+/37088dc9-c685-4641-bc7f-60b5ca7cabed).

supplied_formatstringDefault:

Supplied Format of the resource. Optional. List of possible formats can be retrieved using the [GET almaws/v1/conf/code-tables/RequestFormats API](https://developers.exlibrisgroup.com/alma/apis/conf/GET/gwPcGly021p29HpB7XTI4K7cQ0vuYHLS4NSgDGmcRpRYqx5hIMRTng9SIKO5Vof+/37088dc9-c685-4641-bc7f-60b5ca7cabed).

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'https://api-eu.hosted.exlibrisgroup.com/almaws/v1/task-lists/rs/lending-requests' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Act on Lending Requests

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/task-lists/rs/lending-requests

This API preforms the requested action on a list (specified by given filters) of lending requests in Alma

Access Token Required: API Key

Query Params

librarystringDefault:

opstringDefault:

Operation to be preformed on the list of given requests. Currently the only supported action is 'mark_reported'. Mandatory.

statusstringDefault:

printedstringDefault:

The 'printed' value of lending requests to retrieve. Optional. Possible values: Y, N.

reportedstringDefault:

The 'reported' value of lending requests to retrieve. Optional. Possible values: Y, N.

partnerstringDefault:

requested_formatstringDefault:

supplied_formatstringDefault:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'https://api-eu.hosted.exlibrisgroup.com/almaws/v1/task-lists/rs/lending-requests' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Act on Lending Requests

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/task-lists/rs/lending-requests

This API preforms the requested action on a list (specified by given filters) of lending requests in Alma

Access Token Required: API Key

Query Params

librarystringDefault:

opstringDefault:

Operation to be preformed on the list of given requests. Currently the only supported action is 'mark_reported'. Mandatory.

statusstringDefault:

printedstringDefault:

The 'printed' value of lending requests to retrieve. Optional. Possible values: Y, N.

reportedstringDefault:

The 'reported' value of lending requests to retrieve. Optional. Possible values: Y, N.

partnerstringDefault:

requested_formatstringDefault:

supplied_formatstringDefault:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'https://api-eu.hosted.exlibrisgroup.com/almaws/v1/task-lists/rs/lending-requests' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

POST

Act on Lending Requests

https://api-eu.hosted.exlibrisgroup.com/almaws/v1/task-lists/rs/lending-requests

This API preforms the requested action on a list (specified by given filters) of lending requests in Alma

Access Token Required: API Key

Query Params

librarystringDefault:

opstringDefault:

Operation to be preformed on the list of given requests. Currently the only supported action is 'mark_reported'. Mandatory.

statusstringDefault:

printedstringDefault:

The 'printed' value of lending requests to retrieve. Optional. Possible values: Y, N.

reportedstringDefault:

The 'reported' value of lending requests to retrieve. Optional. Possible values: Y, N.

partnerstringDefault:

requested_formatstringDefault:

supplied_formatstringDefault:

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request POST \
2     --url 'https://api-eu.hosted.exlibrisgroup.com/almaws/v1/task-lists/rs/lending-requests' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}