Resource Collections

Resource Collections

Most resources are divided into collections. Collections contain instances of resources and have fixed URI names. The specific resource can be viewed with its unique resourceId at the end of the URI path.

Below is a skeletal JSON representation of a collection of account items:

{
  "nextPage_url": "https://api.apiture.com/bankingAccounts/accounts?start=641f62296ecbf1882c84?limit=100?allows=view=true",
  "items": [
    {
      "id": "bf23bc970b78d27691e8",
      "title": "Max Pike",
      "nickname": "Payroll Checking",
      "label": "Payroll Checking *1008",
      "product": {
        "type": "checking",
        "code": "DDA",
        "label": "Business Checking",
        "description": "Basic business checking accounts"
      },
      "maskedNumber": "*1008",
      "location": "internal",
      "allows": {
        "transferFrom": false,
        "transferTo": true,
        "billPay": false,
        "mobileCheckDeposit": true,
        "view": true,
        "viewCards": true,
        "manageCards": false
      }
    },
    {
      "id": "b78d27691e8bf23bc970",
      "title": "Max Pike",
      "nickname": "College CD",
      "label": "College CD *2017",
      "product": {
        "type": "cd",
        "code": "CDA",
        "label": "24 Month CD",
        "description": "24 Month certificate of deposit"
      },
      "maskedNumber": "*2017",
      "location": "internal",
      "allows": {
        "transferFrom": false,
        "transferTo": false,
        "billPay": false,
        "mobileCheckDeposit": false,
        "view": true,
        "viewCards": true,
        "manageCards": false
      },
      "electronicStatements": true
    }
  ]
}

Each of the items in a collection is a concise summary representation of the complete resource. The summary representation includes an item’s key properties

The API reference shows that collections have an items array containing a summary representation of the items in that collection. For example:

• The accounts collection contains accountItem items
• The transactions collection contains summary transactionItem items

In addition to the items array, every collection extends the base abstractPagedBody schema and includes these properties:

• The pagination start and limit.
• The nextPage_url URL of the next page of a paginated collection, if there are more items to fetch in the collection.