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.
Resources
| Method | Description |
|---|---|
| GET /v1/pnxs | Brief Search API |
| GET /v1/pnxs/{context}/{recordId} | PNX record retrieval |
GET /v1/pnxs Details
URL Parameters None
Query string Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| inst | xs:string | See description | The Institution Code. NOTE: This parameter is required for local Primo customers (not hosted). Hosted customers should access this API using the apikey instead. |
| q | xs:string | Required | 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 |
| qInclude | xs:string | Optional | Include facets If more then 1 facet then need to split it by “|,|” i.e. qInclude=facet_rtype,exact,books|,|facet_topic,exact,LawAvailable from Aug-16 release |
| qExclude | xs:string | Optional | Exclude facets If more then 1 facet then need to split it by “|,|” i.e. qExclude=facet_rtype,exact,books|,|facet_topic,exact,LawAvailable from Aug-16 release |
| lang | xs:string | Optional. Default: eng | The Language |
| offset | xs:int | Optional. Default: 1 | Offset of results |
| limit | xs:int | Optional. Default: 50 | Number of results returned |
| sort | xs:string | Optional | The field name by which to sort |
| view | xs:string | Optional. Default: brief | brief or full |
| addfields | xs:string | Optional | fields to be added in brief view |
| vid | xs:string | Optional | The vid (Needs to be toge |
| scope | xs:string | Optional | The scope (Needs to be together with vid) |
Body Parameters None
Output
| Code | Message |
|---|
Example
| Environment | URL 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
| Parameter | Type | Description |
|---|---|---|
| recordId | xs:string | The recId |
| context | xs:string | L or PC |
Query string Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| inst | xs:string | See description | The Institution Code. NOTE: This parameter is required for local Primo customers (not hosted). Hosted customers should access this API using the apikey instead. |
| lang | xs:string | Optional. Default: eng | The language |
Body Parameters None
Output
| Code | Message |
|---|
Example
| Environment | URL 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 |