OCLC Developer Network

Response Details

Examples:

The following examples demonstrate the different operations that can be executed on purchase orders using HTTP methods. Please note that none of the examples include the principleID and principleIDNS parameters that are required to successfully complete the operation.

GET a collection of vendors where the status is active:

Request:

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

Response:

<?xml version='1.0' encoding='UTF-8'?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:os="http://a9.com/-/spec/opensearch/1.1/">
   <id>info:OCLC/Platform/Service</id>
   <title type="text">OCLC Platform Service Results</title>
   <updated>2012-01-19T13:12:00.690Z</updated>
   <os:totalResults>130</os:totalResults>
   <os:startIndex>0</os:startIndex>
   <os:itemsPerPage>10</os:itemsPerPage>
   <entry>
     <title type="text" />
     <updated>2012-01-19T13:12:00.692Z</updated>
     <content type="application/xml">
       <ns2:lookupVendor xmlns:ns2="http://worldcat.org/xmlschemas/Vendor-1.0" xmlns="http://worldcat.org/xmlschemas/LookupVendor-1.0" xmlns:ns3="http://worldcat.org/xmlschemas/VendorActivation-1.0">
         <vendorId>ce71cafb-be57-476f-8f48-83246b0dda63</vendorId>
         <link href="https://vic.sd00.worldcat.org//vendors/ce71cafb-be57-476f-8f48-83246b0dda63?inst=128807" />
         <name>Amazon.com, Inc.</name>
         <vendorNumber />
         <country>US</country>
         <place>Seattle</place>
         <location>Seattle, WA, US</location>
         <isActive>false</isActive>
         <isShared>true</isShared>
       </ns2:lookupVendor>
     </content>
   </entry>
   ...
   <entry>
     <title type="text" />
     <updated>2012-01-19T13:12:00.712Z</updated>
     <content type="application/xml">
       <ns2:lookupVendor xmlns:ns2="http://worldcat.org/xmlschemas/Vendor-1.0" xmlns="http://worldcat.org/xmlschemas/LookupVendor-1.0" xmlns:ns3="http://worldcat.org/xmlschemas/VendorActivation-1.0">
         <vendorId>006f0ea2-9a17-4b3f-b871-04eb885f2535</vendorId>
         <link href="https://vic.sd00.worldcat.org//vendors/006f0ea2-9a17-4b3f-b871-04eb885f2535?inst=128807" />
         <name>Ambassador</name>
         <vendorNumber />
         <country>US</country>
         <place>Melville</place>
         <location>Melville, NY, US</location>
         <isActive>false</isActive>
         <isShared>true</isShared>
       </ns2:lookupVendor>
     </content>
   </entry>
</feed>

POST XML to create a new vendor

Request:

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

XML Payload:

<vendor xmlns="http://worldcat.org/xmlschemas/Vendor-1.2"
    xmlns:ns2="http://worldcat.org/xmlschemas/VendorActivation-1.2" 
    xmlns:ns3="http://worldcat.org/xmlschemas/LookupVendor-1.2" 
    isPrivate="true" isActive="true" visibleVendorId="">
    <basicData>
        <vendorName>ACQ Mock Platform Vendor 193</vendorName>
        <country>US</country>
        <roles>provider</roles>
        <matchCodes>ebs</matchCodes>
        <language>de</language>
        <currency>USD</currency>
        <relationship>
            <relationshipId>egcslrfk-e4e6-11e0-9572-0800200c1234</relationshipId>
            <relationshipType>hosting vendor</relationshipType>
            <relatedVendor visibleVendorId="dc889b60-7722-4e5f-9cbb-355583b66d5c"/>
        </relationship>
    </basicData>
    <address isDefault="true" isPrivate="false" isActive="true">
        <addressId>91475address name 1</addressId>
        <addressName>address name 1</addressName>
        <place>Columbus</place>
        <addressCountry>US</addressCountry>
    </address>
    <contact isDefault="true" isPrivate="false" isActive="true">
        <contactId>91475Robin Harlington</contactId>
        <contactShortName>Robin Harlington</contactShortName>
        <contactName>A Name</contactName>
        <emailAddress>abc@xyz.com</emailAddress>
        <correspondenceLanguage>en</correspondenceLanguage>
        <contactRole>Access Support</contactRole>
        <allocatedAddress ref="91475address name 1" />
    </contact>
</vendor>

Response:

<entry xmlns="http://www.w3.org/2005/Atom" xmlns:gd="http://schemas.google.com/g/2005">
    <title type="text" />
    <updated>2011-11-07T09:36:58.179Z</updated>
    <gd:etag>2011-11-07T09:36:58.139+01:00</gd:etag>
    <content type="application/xml">
        <vendor xmlns="http://worldcat.org/xmlschemas/Vendor-1.2"
            xmlns:ns2="http://worldcat.org/xmlschemas/VendorActivation-1.2" 
            xmlns:ns3="http://worldcat.org/xmlschemas/LookupVendor-1.2" 
            isPrivate="true" isActive="true" visibleVendorId="66f15fc0-f303-429e-9554-67af0d198374">
            <basicData>
                <vendorNumber>LVN-136</vendorNumber>
                <vendorName>ACQ Mock Platform Vendor 193</vendorName>
                <country>US</country>
                <roles>provider</roles>
                <matchCodes>ebs</matchCodes>
                <language>de</language>
                <currency>USD</currency>
                <relationship>
                    <relationshipId>egcslrfk-e4e6-11e0-9572-0800200c1234</relationshipId>
                    <relationshipType>hosting vendor</relationshipType>
                    <relatedVendor visibleVendorId="dc889b60-7722-4e5f-9cbb-355583b66d5c" externalVendorId="">
                        <link href="https://%BASEPATH%/vendors/dc889b60-7722-4e5f-9cbb-355583b66d5c?inst=91475" />
                    </relatedVendor>
                </relationship>
            </basicData>
            <address isDefault="true" isPrivate="false" isActive="true">
                <addressId>91475address name 1</addressId>
                <addressName>address name 1</addressName>
                <place>Columbus</place>
                <addressCountry>US</addressCountry>
            </address>
            <contact isDefault="true" isPrivate="false" isActive="true">
                <contactId>91475Robin Harlington</contactId>
                <contactShortName>Robin Harlington</contactShortName>
                <contactName>A Name</contactName>
                <emailAddress>abc@xyz.com</emailAddress>
                <correspondenceLanguage>en</correspondenceLanguage>
                <contactRole>Access Support</contactRole>
                <allocatedAddress ref="91475address name 1" />
            </contact>
            <lastUpdateTime>2011-11-07T09:36:58.139+01:00</lastUpdateTime>
            <insertTime>2011-11-07T09:36:58.139+01:00</insertTime>
        </vendor>

  </content>
</entry>

PUT XML to update an existing vendor

Request:

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

XML Payload:

<vendor xmlns="http://worldcat.org/xmlschemas/Vendor-1.2" 
    xmlns:ns2="http://worldcat.org/xmlschemas/VendorActivation-1.2" 
    xmlns:ns3="http://worldcat.org/xmlschemas/LookupVendor-1.2" isPrivate="true" isActive="true" visibleVendorId="66f15fc0-f303-429e-9554-67af0d198374">
    <basicData>
        <vendorNumber>LVN-137</vendorNumber>
        <vendorName>ACQ Mock Platform Vendor 193</vendorName>
        <country>DE</country>
        <roles>provider</roles>
        <matchCodes>ebs</matchCodes>
        <language>de</language>
        <currency>EUR</currency>
        <relationship>
            <relationshipId>egcslrfk-e4e6-11e0-9572-0800200c1234</relationshipId>
            <relationshipType>hosting vendor</relationshipType>
            <relatedVendor visibleVendorId="dc889b60-7722-4e5f-9cbb-355583b66d5c" externalVendorId="">
                <link href="https://%BASEPATH%/vendors/dc889b60-7722-4e5f-9cbb-355583b66d5c?inst=91475" />
            </relatedVendor>
        </relationship>
    </basicData>
    <address isDefault="true" isPrivate="false" isActive="true">
        <addressId>91475address name 1</addressId>
        <addressName>address name 1</addressName>
        <place>Columbus</place>
        <addressCountry>US</addressCountry>
    </address>
    <contact isDefault="true" isPrivate="false" isActive="true">
        <contactId>91475Robin Harlington</contactId>
        <contactShortName>Robin Harlington</contactShortName>
        <contactName>A Name</contactName>
        <emailAddress>abc@xyz.com</emailAddress>
        <correspondenceLanguage>en</correspondenceLanguage>
        <contactRole>Access Support</contactRole>
        <allocatedAddress ref="91475address name 1" />
    </contact>
    <lastUpdateTime>2011-11-07T09:36:58.139+01:00</lastUpdateTime>
    <insertTime>2011-11-07T09:36:58.139+01:00</insertTime>
</vendor>

Response:

<entry xmlns="http://www.w3.org/2005/Atom" xmlns:gd="http://schemas.google.com/g/2005">
    <title type="text" />
    <updated>2011-11-07T09:53:37.276Z</updated>
    <gd:etag>2011-11-07T09:36:59.139+01:00</gd:etag>
    <content type="application/xml">
        <vendor xmlns="http://worldcat.org/xmlschemas/Vendor-1.2" 
            xmlns:ns2="http://worldcat.org/xmlschemas/VendorActivation-1.2" 
            xmlns:ns3="http://worldcat.org/xmlschemas/LookupVendor-1.2" isPrivate="true" isActive="true" visibleVendorId="66f15fc0-f303-429e-9554-67af0d198374">
            <basicData>
                <vendorNumber>LVN-137</vendorNumber>
                <vendorName>ACQ Mock Platform Vendor 193</vendorName>
                <country>DE</country>
                <roles>provider</roles>
                <matchCodes>ebs</matchCodes>
                <language>de</language>
                <currency>EUR</currency>
                <relationship>
                    <relationshipId>egcslrfk-e4e6-11e0-9572-0800200c1234</relationshipId>
                    <relationshipType>hosting vendor</relationshipType>
                    <relatedVendor visibleVendorId="dc889b60-7722-4e5f-9cbb-355583b66d5c" externalVendorId="">
                        <link href="https://%BASEPATH%/vendors/dc889b60-7722-4e5f-9cbb-355583b66d5c?inst=91475" />
                    </relatedVendor>
                </relationship>
                <relationshipId>dddd51ce-05e0-484b-be22-35512b93abec</relationshipId>
                <relationshipType>hosting vendor</relationshipType>
                <relatedVendor visibleVendorId="dc889b60-7722-4e5f-9cbb-355583b66d5c" externalVendorId="">
                    <link href="https://%BASEPATH%/vendors/dc889b60-7722-4e5f-9cbb-355583b66d5c?inst=91475" />
                </relatedVendor>
            </relationship>
            </basicData>
            <address isDefault="true" isPrivate="false" isActive="true">
                <addressId>91475address name 1</addressId>
                <addressName>address name 1</addressName>
                <place>Columbus</place>
                <addressCountry>US</addressCountry>
            </address>
            <contact isDefault="true" isPrivate="false" isActive="true">
                <contactId>91475Robin Harlington</contactId>
                <contactShortName>Robin Harlington</contactShortName>
                <contactName>A Name</contactName>
                <emailAddress>abc@xyz.com</emailAddress>
                <correspondenceLanguage>en</correspondenceLanguage>
                <contactRole>Access Support</contactRole>
                <allocatedAddress ref="91475address name 1" />
            </contact>
            <lastUpdateTime>2011-11-07T09:36:59.139+01:00</lastUpdateTime>
            <insertTime>2011-11-07T09:36:58.139+01:00</insertTime>
        </vendor>
    </content>
</entry>

Activate a vendor:

Request:

https://vic.sd00.worldcat.org/vendoractivations

XML Payload:

<entry xmlns="http://www.w3.org/2005/Atom">
  <content type="application/xml">
    <vendorActivation xmlns="http://worldcat.org/xmlschemas/VendorActivation-1.2">
      <vendorId>bc056cec-7977-4df2-82c4-77305a02be0d</vendorId>
    </vendorActivation>
  </content>
</entry>

Response:

<entry xmlns="http://www.w3.org/2005/Atom" xmlns:gd="http://schemas.google.com/g/2005">
  <title type="text" />
  <updated>2012-03-16T15:04:51.696Z</updated>
  <gd:etag>2012-03-15T09:50:18.000-04:00</gd:etag>
  <content type="application/xml">
    <ns2:vendorActivation xmlns:ns2="http://worldcat.org/xmlschemas/VendorActivation-1.2" xmlns="http://worldcat.org/xmlschemas/Vendor-1.1" xmlns:ns3="http://worldcat.org/xmlschemas/LookupVendor-1.1">
      <ns2:vendorId>bc056cec-7977-4df2-82c4-77305a02be0d</ns2:vendorId>
      <ns2:link href="https://vic.sd00.worldcat.org//vendors/bc056cec-7977-4df2-82c4-77305a02be0d?inst=128807" />
      <ns2:name>Baker & Taylor</ns2:name>
      <ns2:lastUpdateTime>2012-03-15T09:50:18.000-04:00</ns2:lastUpdateTime>
    </ns2:vendorActivation>
  </content>
</entry>

Submitted by maxneuvians on Fri, 01/20/2012 - 8:17am

Follow the OCLC Developer Network:

The OCLC Developer Network supports the use of OCLC Web Services—a set of tools and APIs that expose data and services for WorldCat and our member libraries and partner institutions or companies. learn more »

© 2010 OCLC Domestic and international trademarks and/or service marks of OCLC Online Computer Library Center, Inc. and its affiliates


Powered by Drupal, an open source content management system