Get list of entities connected with BOND access zones

Returns list of entities connected with BOND access zones

Query Parameters

• limit integer

  Possible values: [10, 20, 30, 50]

  Number of items. Value by default is 10

• page_number integer

  Possible values: >= 1

  Page number

Responses

• 202
• 401
• 403

---

OK

application/json

• Schema
• Example (from schema)
• Example in decimal
• Example in hex

---

Schema

• list_option object

  This model provides the options can be used for pagination when getting list of entities attached with access zones

  pagination object

  Available pagination options for tables

  total_items integer

  The total number of items found and reflected across all pages

  items_limit integer

  Possible values: [10, 20, 30, 50]

  Limiting the display of the amount of data for one page

  total_pages integer

  The number of pages that hold the requested data

  current_page integer

  Possible values: >= 1

  Current page number

• list_items object[]

  List of entities, e.g. identifiers and call numbers attached with BOND lift access zones.

{
  "list_option": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    }
  },
  "list_items": [
    {
      "item_uid": 1,
      "access_zone": {},
      "entity": {
        "type": "call_number",
        "id": 1111
      }
    },
    {
      "item_uid": 1,
      "access_zone": {},
      "entity": {
        "type": "call_number",
        "id": 1,
        "identifier_info": {
          "owner_name": "Sherlock Holmes",
          "type": "ukey",
          "number": "12345678"
        }
      }
    }
  ]
}

{
  "list_options": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    }
  },
  "list_items": [
    {
      "item_uid": 1,
      "entity": {
        "type": "call_number",
        "id": 10
      },
      "access_zone": {
        "item_uid": 1,
        "name": "Lobby",
        "code": "100001"
      }
    },
    {
      "item_uid": 2,
      "entity": {
        "type": "identifier",
        "id": 1,
        "identifier_info": {
          "type": "card",
          "owner_name": "John Doe",
          "number": 12345678
        }
      },
      "access_zone": {
        "item_uid": 2,
        "name": "Penthouse",
        "code": "100002"
      }
    }
  ]
}

{
  "list_options": {
    "pagination": {
      "total_items": 18,
      "items_limit": 10,
      "total_pages": 2,
      "current_page": 1
    }
  },
  "list_items": [
    {
      "item_uid": 1,
      "entity": {
        "type": "call_number",
        "id": 10
      },
      "access_zone": {
        "item_uid": 1,
        "name": "Lobby",
        "code": "01-86-A1"
      }
    },
    {
      "item_uid": 2,
      "entity": {
        "type": "identifier",
        "id": 1,
        "identifier_info": {
          "type": "card",
          "owner_name": "John Doe",
          "number": "BC-61-4E"
        }
      },
      "access_zone": {
        "item_uid": 2,
        "name": "Penthouse",
        "code": "01-86-A2"
      }
    }
  ]
}

Unauthorized request. Log In

application/json

• Schema
• Example (from schema)
• Log In

---

Schema

• error string

  Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

• Schema
• Example (from schema)
• Admin Rights Required

---

Schema

• error string

  Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Loading...