Create Custom Packages

post

https://sandbox.ebsco.io/rm/rmaccounts/{custid}/vendors/{vendorid}/packages

This operation allows you to create custom packages.

Please Note: You will need an API key to gain access to the API through our interactive documentation. If you require an API key, please contact EBSCO customer support.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

custid

string

required

EBSCO Customer ID

vendorid

integer

required

Vendor ID

Body Params

JSON POST payload. Specify the packageName in the payload. Set contentType in the payload to 1 for Agregated Full Text, 2 for Abstract and Index, 3 for Ebook, 4 for E-Journal, 5 for Print, 6 for Unknown, 7 for Online Reference, 8 for Streaming Media or 9 for Mixed Content. Set the custom coverage dates. Set the proxy ID.

Custom Package Payload

packageName

string

Package Name

contentType

integer

Content Type. Valid values are 1 for aggregated full text, 2 for abstract and index, 3 for ebook, 4 for ejournal, 5 for print, 6 for unknown, 7 for online reference, 8 for streaming media or 9 for mixed content.

customCoverage

object

Dates of Coverage

proxy

object

Proxy

customDescription

string

A description of the custom package

customDisplayName

string

A display name for the custom package

url

string

A url for the custom the package

customAltNames

object

Alternate names and their corresponding ids for a package, can be managed or custom.

subjects

array of integers

List of subject Ids to associate with the package

subjects

packageFreeAccess

string

Indicates if the package is freely accessible.

Headers

x-api-key

string

required

Unique code assigned by EBSCO to grant you access to this API. The API key needs to be a header parameter for every operation in order to access this API. You will need an API key to use the interactive documentation. If you require an API key, please contact EBSCO customer support.

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Package ID

defaultUnexpected Error