Ready to Learn?Ex Libris products all provide open APIs

Primo PNX REST API

General Purpose

This API is a REST implementation of Primo's search service.

The results returned are in the JSON format.

API

Resources

MethodDescription
GET /v1/pnxs Brief Search API
GET /v1/pnxs/{context}/{recordId}PNX record retrieval

 

GET /v1/pnxs Details

URL Parameters None
Query string Parameters
ParameterTypeRequiredDescription
instxs:stringSee descriptionThe Institution Code.
NOTE: This parameter is required for local Primo customers (not hosted).
Hosted customers should access this API using the apikey instead.
qxs:stringRequired

The query string. E.g. 'q=any,contains,book''

For multiple fields use:

q=<field1>,<operator1>,<value1>;<field2>,<operator2>,<value2>

i.e. q=any,contains,history;facet_frbrgroupid,exact,123

qIncludexs:stringOptional

Include facets
If more then 1 facet then need to split it by "|,|"
i.e. qInclude=facet_rtype,exact,books|,|facet_topic,exact,Law

Available from Aug-16 release

qExcludexs:stringOptional

Exclude facets
If more then 1 facet then need to split it by "|,|"
i.e. qExclude=facet_rtype,exact,books|,|facet_topic,exact,Law

Available from Aug-16 release

langxs:stringOptional. Default: engThe Language
offsetxs:intOptional. Default: 1Offset of results
limitxs:intOptional. Default: 50Number of results returned
sortxs:stringOptionalThe field name by which to sort
viewxs:stringOptional. Default: briefbrief or full
addfieldsxs:stringOptionalfields to be added in brief view
vidxs:stringOptionalThe vid (Needs to be toge
scopexs:stringOptionalThe scope (Needs to be together with vid)
Body Parameters None
Output
Possible Error Codes
CodeMessage

 

Example
EnvironmentURL Example
local http://<primo domain>:<port>/primo_library/libweb/webservices/rest/v1/pnxs?q=any,contains,book&inst=MY_INST
hosted https://api-na.hosted.exlibrisgroup.com/primo/v1/pnxs?q=any,contains,book&apikey=yourapikey

 

GET /v1/pnxs/{context}/{recordId} Details

URL Parameters
ParameterTypeDescription
recordIdxs:stringThe recId
contextxs:stringL or PC
Query string Parameters
ParameterTypeRequiredDescription
instxs:stringSee descriptionThe Institution Code.
NOTE: This parameter is required for local Primo customers (not hosted).
Hosted customers should access this API using the apikey instead.
langxs:stringOptional. Default: engThe language
Body Parameters None
Output
Possible Error Codes
CodeMessage
 
Example
EnvironmentURL Example
local http://<primo domain>:<port>/primo_library/libweb/webservices/rest/v1/pnxs/L/Blue_Bay_Aleph001887023?inst=VOLCANO
hosted https://<api-gateway-url>/primo/v1/pnxs/L/Blue_Bay_Aleph001887023?apikey=yourapikey