This API is a REST implementation of Primo's eshelf service.
The results returned are in the JSON format.
Method | Description |
---|---|
GET /v1/eshelf/{userid}/{path : .+} | |
POST /v1/eshelf/{userid}/{path : .+} | |
PUT /v1/eshelf/{userid}/{path : .+} | |
DELETE /v1/eshelf/{userid}/{path : .+} |
Method | Description |
---|---|
GET /v1/eshelf/{userid} | |
PUT /v1/eshelf/{userid} | |
POST /v1/eshelf/{userid} |
Parameter | Type | Description |
---|---|---|
path | xs:string | Path |
userid | xs:string | User ID |
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. |
Code | Message |
---|
Environment | URL Example |
---|---|
local | http://<primo_domain>:<port>/primo_library/libweb/webservices/rest/v1/eshelf/{userid}/Basket/{folder}?inst=MY_INST |
hosted | https://<api-gateway-url>/primo/v1/eshelf/{userid}/Basket/{folder}?inst=MY_INST |
Parameter | Type | Description |
---|---|---|
path | xs:string | Path |
userid | xs:string | User ID |
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. |
Code | Message |
---|
Parameter | Type | Description |
---|---|---|
path | xs:string | Path |
userid | xs:string | User ID |
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. |
Code | Message |
---|
Parameter | Type | Description |
---|---|---|
path | xs:string | Path |
userid | xs:string | User ID |
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. |
Code | Message |
---|
Parameter | Type | Description |
---|---|---|
userid | xs:string |
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. |
Code | Message |
---|
Parameter | Type | Description |
---|---|---|
userid | xs:string |
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. |
Code | Message |
---|
Environment | URL Example |
---|---|
local |
http://<primo_domain>:<port>/primo_library/libweb/webservices/rest/v1/eshelf/{userid}?inst=MY_INST
|
hosted | https://<api-gateway-url>/primo/v1/eshelf/{userid}?inst=MY_INST |
Parameter | Type | Description |
---|---|---|
userid | xs:string |
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. |
Code | Message |
---|