Vendor Resource

URLs and Supported Requests

The Vendor Information Resource supports four operations.

Operation Resource URL HTTP METHOD
Create https://vic.{datacenter}.worldcat.org/vendors?inst={WorldCat_Registry_ID} POST
Read https://vic.{datacenter}.worldcat.org/vendors/{Vendor_ID}?inst={WorldCat_Registry_ID} GET
Update https://vic.{datacenter}.worldcat.org/vendors/{Vendor_ID}?inst={WorldCat_Registry_ID} PUT
Delete https://vic.{datacenter}.worldcat.org/vendoractivations/{Vendor_ID}?inst={WorldCat_Registry_ID} DELETE
Search https://vic.{datacenter}.worldcat.org/vendors?q={query}&inst={WorldCat_Registry_ID} GET
Activate https://vic.{datacenter}.worldcat.org/vendoractivations?inst={WorldCat_Registry_ID} POST
Deactivate https://vic.{datacenter}.worldcat.org/vendoractivations?inst={WorldCat_Registry_ID} DELETE

HTTP Accept Types

HTTP Request Content Types

Vendor Resource

Vendor Activation

application/atom+xml

Schema

More information about the proper structure of XML made as part of POST and PUT requests can be found here:

Parameters

PARAMETER Required DESCRIPTION
principalID Yes An identifier that represents the user making the request
principalIDNS Yes The namespace for the principalID
inst Yes The WorldCat Institution Registry ID associated with institution associated with a vendor record.
q No Query string that can be used to do a text search on the result set.
vendor_name No Limit results by vendor name.
location No Limit results by location.
contact_name No Limit results by contact name.
status No Limit results by status. Values are:  all | active | inactive.
orderBy No Allows you to to specify an orderBy value. Currently only vendor_name is supported.

Example Requests

To search and retrieve all vendors that contain a test string that starts with the letter A, are located in Munich, and with a status set to active:

GET https://vic.sd00.worldcat.org/vendors?q=A*&location=munich&status=active

To search and retrieve all vendors located in Munich with their statuses set to either active or inactive.

GET https://vic.sd00.worldcat.org/vendors?location=munich&status=ALL

To update an existing vendor:

PUT XML https://vic.sd00.worldcat.org/vendors/66f15fc0-f303-429e-9554-67af0d198374

XML Payload

To create a new vendor:

POST XML https://vic.sd00.worldcat.org/vendors

XML Payload

To view a collection of vendors where the status is active:

GET https://vic.sd00.worldcat.org/vendors/vendors?status=ACTIVE

 

We are a worldwide library cooperative, owned, governed and sustained by members since 1967. Our public purpose is a statement of commitment to each other—that we will work together to improve access to the information held in libraries around the globe, and find ways to reduce costs for libraries through collaboration. Learn more »