Entitlement Log Documentation
The Entitlement Log is a log of which resources (from the Agreements Local KB only) have been added to, updated within or removed from a library's collection of electronic resources based on their current active agreements. The purpose of the log is to give an external system (such as a discovery system) the ability to keep up to date with the resources available within a library collection by incrementally consuming events from the log over time. The current state of the collection can kept up to date by accessing all log entries sequentially, from the last time the log was accessed. If necessary the log can be "replayed" from the very start to the very latest entry to get the current representation of the library collection of electronic resources.
Updating the entitlement log
The Entitlement Log can be updated by:
GET /erm/admin/triggerEntitlementLogUpdate
- Access to this endpoint requires the `erm.admin.action` permission
- The request must include the headers:
- x-okapi-token (with a valid token)
- x-okapi-tenant (with a valid tenant name)
- It is planned that the entitlement log update will eventually be part of the general housekeeping tasks which are run regularly for mod-agreements
Retrieving the entitlement log
The current content of the Entitlement Log can be retrieved by:
GET /erm/entitlementLogEntry
- Access to this endpoint requires the `` permission
- The request must include the headers:
- x-okapi-token (with a valid token)
- x-okapi-tenant (with a valid tenant name)
- Valid parameters that can be used for the endpoint are:
filters
match
term
sort
stats
perPage (number of records per page of results, defaults to 10 and supports a maximum of 100)_
offset (number of records from start of results set to skip)
Using the parameter `stats=true` will wrap the entitlement log entries in a results array and include results stats
- totalRecords
- pageSize (i.e. number of records per page of results, controlled by the `perPage` parameter)
- totalPages
- page (i.e. current page)
It is possible to paginate through the results set by increasing the `offset` parameter appropriately
The `filter` parameter can be used to retrieve a subset of the entire log by applying search filters. The key filter field is `seqid` which is a sequential id for additions to the entitlements log. So given that (for example) the last seen log entry had a 'seqId' == 001628499207853-000000 then the following request can be used to retrieve only log entries after this in the sequence:
GET /erm/entitlementLogEntry?stats=true&filters=seqid%3E001628499207853-000000
Where "%3E" is the percent/url encoded Greater Than symbol '>'.
Entitlement log entries
The content of the a call such as
GET /erm/entitlementLogEntry?stats=true&filters=seqid%3E001628499207853-000000
Is a list of entitlement log entries which consists of the properties:
- seqId: a sequential id for additions to the entitlements log
- eventType: a property which contains "ADD" or "REMOVE". Sample JSON is provided here (where the `stats` parameter was set to `true` to wrap the entitlement log entries in a results array)
- resource_name: name of the resource including platform and package information
- title: title for the resource
- coverage: array of coverage statements for the resource
- identifiers: array of identifiers for the resource
- suppress: suppressFromDiscovery value from the resource
- type: resource type (serial or monograph)
- license: license for the resource (not currently populated)
{
"results": [
{
"seqid": "001628498498612-000000",
"resource_name": "'\"Institutions, industrial upgrading, and economic performance in Ja...' on Platform 'Elgaronline' in Package Edward Elgar:Edward Elgar E-Book Archive in Business & Management, ...",
"title": "\"Institutions, industrial upgrading, and economic performance in Japan: the 'flying-geese' paradigm of catch-up growth\"",
"coverage": [],
"identifiers": [
{
"type": "isbn",
"value": "9781845425678"
}
],
"suppress": false,
"type": "monograph",
"license": null,
"eventType": "ADD"
},
{
"seqid": "001628498544017-000000",
"resource_name": "'\"Institutions, industrial upgrading, and economic performance in Ja...' on Platform 'Elgaronline' in Package Edward Elgar:Edward Elgar E-Book Archive in Business & Management, ...",
"title": "\"Institutions, industrial upgrading, and economic performance in Japan: the 'flying-geese' paradigm of catch-up growth\"",
"coverage": [],
"identifiers": [
{
"type": "isbn",
"value": "9781845425678"
}
],
"suppress": false,
"type": "monograph",
"license": null,
"eventType": "REMOVE"
},
{
"seqid": "001628499207853-000000",
"resource_name": "'19th century music' on Platform 'JSTOR' in Package JSTOR : Arts & Sciences III Collection : NK",
"title": "19th century music",
"coverage": [
{
"startDate": "1977-01-01",
"endDate": null,
"startVolume": "1",
"startIssue": "1",
"endVolume": null,
"endIssue": null,
"summary": "v1/i1/1977-01-01 - v*/i*/*"
}
],
"identifiers": [
{
"type": "zdb",
"value": "2052442-0"
},
{
"type": "eissn",
"value": "1533-8606"
},
{
"type": "ezb",
"value": "38504"
}
],
"suppress": false,
"type": "serial",
"license": null,
"eventType": "ADD"
},
{
"seqid": "001628499372032-000000",
"resource_name": "'Journal of medicinal chemistry' on Platform 'ACS Publications' in Package American Chemical Society: ACS Legacy Archives: NL",
"title": "Journal of medicinal chemistry",
"coverage": [
{
"startDate": "1959-01-01",
"endDate": "1995-12-31",
"startVolume": "1",
"startIssue": null,
"endVolume": "38",
"endIssue": null,
"summary": "v1/i*/1959-01-01 - v38/i*/1995-12-31"
}
],
"identifiers": [
{
"type": "zdb",
"value": "1491411-6"
},
{
"type": "zdb_ppn",
"value": "019841949"
},
{
"type": "eissn",
"value": "1520-4804"
}
],
"suppress": false,
"type": "serial",
"license": null,
"eventType": "ADD"
},
{
"seqid": "001628499372032-000001",
"resource_name": "'Organometallics' on Platform 'ACS Publications' in Package American Chemical Society: ACS Legacy Archives: NL",
"title": "Organometallics",
"coverage": [
{
"startDate": "1982-01-01",
"endDate": "1995-12-31",
"startVolume": "1",
"startIssue": null,
"endVolume": "14",
"endIssue": null,
"summary": "v1/i*/1982-01-01 - v14/i*/1995-12-31"
}
],
"identifiers": [
{
"type": "eissn",
"value": "1520-6041"
},
{
"type": "zdb_ppn",
"value": "020175094"
},
{
"type": "zdb",
"value": "2006302-7"
}
],
"suppress": false,
"type": "serial",
"license": null,
"eventType": "ADD"
},
{
"seqid": "001628499372032-000002",
"resource_name": "'Industrial & engineering chemistry' on Platform 'ACS Publications' in Package American Chemical Society: ACS Legacy Archives: NL",
"title": "Industrial & engineering chemistry",
"coverage": [
{
"startDate": "1909-01-01",
"endDate": "1970-12-31",
"startVolume": "1",
"startIssue": null,
"endVolume": "62",
"endIssue": null,
"summary": "v1/i*/1909-01-01 - v62/i*/1970-12-31"
}
],
"identifiers": [
{
"type": "zdb_ppn",
"value": "024391301"
},
{
"type": "zdb",
"value": "2103816-8"
}
],
"suppress": false,
"type": "serial",
"license": null,
"eventType": "ADD"
},
{
"seqid": "001628499372032-000003",
"resource_name": "'Bioconjugate chemistry' on Platform 'ACS Publications' in Package American Chemical Society: ACS Legacy Archives: NL",
"title": "Bioconjugate chemistry",
"coverage": [
{
"startDate": "1990-01-01",
"endDate": "1995-12-31",
"startVolume": "1",
"startIssue": null,
"endVolume": "6",
"endIssue": null,
"summary": "v1/i*/1990-01-01 - v6/i*/1995-12-31"
}
],
"identifiers": [
{
"type": "zdb_ppn",
"value": "019927363"
},
{
"type": "eissn",
"value": "1520-4812"
},
{
"type": "zdb",
"value": "1500067-9"
}
],
"suppress": false,
"type": "serial",
"license": null,
"eventType": "ADD"
},
{
"seqid": "001628499372032-000004",
"resource_name": "'Macromolecules' on Platform 'ACS Publications' in Package American Chemical Society: ACS Legacy Archives: NL",
"title": "Macromolecules",
"coverage": [
{
"startDate": "1968-01-01",
"endDate": "1995-12-31",
"startVolume": "1",
"startIssue": null,
"endVolume": "28",
"endIssue": null,
"summary": "v1/i*/1968-01-01 - v28/i*/1995-12-31"
}
],
"identifiers": [
{
"type": "zdb",
"value": "1491942-4"
},
{
"type": "eissn",
"value": "1520-5835"
},
{
"type": "zdb_ppn",
"value": "019847157"
}
],
"suppress": false,
"type": "serial",
"license": null,
"eventType": "ADD"
},
{
"seqid": "001628499372032-000005",
"resource_name": "'Industrial and engineering chemistry / Process design and development' on Platform 'ACS Publications' in Package American Chemical Society: ACS Legacy Archives: NL",
"title": "Industrial and engineering chemistry / Process design and development",
"coverage": [
{
"startDate": "1962-01-01",
"endDate": "1986-12-31",
"startVolume": "1",
"startIssue": null,
"endVolume": "25",
"endIssue": null,
"summary": "v1/i*/1962-01-01 - v25/i*/1986-12-31"
}
],
"identifiers": [
{
"type": "zdb_ppn",
"value": "024154458"
},
{
"type": "zdb",
"value": "2096933-8"
}
],
"suppress": false,
"type": "serial",
"license": null,
"eventType": "ADD"
},
{
"seqid": "001628499372032-000006",
"resource_name": "'Environmental science & technology' on Platform 'ACS Publications' in Package American Chemical Society: ACS Legacy Archives: NL",
"title": "Environmental science & technology",
"coverage": [
{
"startDate": "1967-01-01",
"endDate": "1995-12-31",
"startVolume": "1",
"startIssue": null,
"endVolume": "29",
"endIssue": null,
"summary": "v1/i*/1967-01-01 - v29/i*/1995-12-31"
}
],
"identifiers": [
{
"type": "zdb_ppn",
"value": "019583990"
},
{
"type": "eissn",
"value": "1520-5851"
},
{
"type": "zdb",
"value": "1465132-4"
}
],
"suppress": false,
"type": "serial",
"license": null,
"eventType": "ADD"
}
],
"pageSize": 10,
"page": 1,
"totalPages": 4,
"meta": {},
"totalRecords": 33,
"total": 33
}