v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB

Book Queries

Loan details from Book

This API retrieves the Encompass Loan GUID and related loan metadata using the Ocrolus <glossary:Book> UUID. It enables seamless mapping between an Ocrolus Book and its corresponding Encompass Loan, supporting accurate LOS integration, tracking, and synchronization between Ocrolus and Encompass systems.

get/v2/los-connect/book/{book_uuid}/loans

Path parameters

book_uuidstring uuid required

The unique identifier of the <glossary:Book> from which you want to retrieve loan details. Mutually exclusive with book_pk.

Response

Success

statusinteger

A numerical code that indicates the status of the request.

Example response

{
  "status": 200,
  "response": {
    "loan_details": {
      "loan_id": "c45d08b2-f123-4dff-82b0-11aa3f5c34d9",
      "loan_number": "TEST202512345",
      "client_instance_id": "TEBE98765432",
      "created_ts": "2025-10-27T17:47:18.955864+00:00"
    },
    "book_details": {
      "book_pk": 764839,
      "name": "Encompass TE Integration Testing-c45d08b2-f123-4dff-82b0-11aa3f5c34d9-001",
      "book_status": "ACTIVE",
      "created_ts": "2025-10-27T17:47:21.129183",
      "book_uuid": "abf37196-12e5-47ca-b33c-e12aa3c9de11"
    },
    "message": "OK"
  }
}