TNS Internal:CollectionAPI/AtomPub/CollectionFeedWalkthrough

From NSDLWiki

Jump to: navigation, search
<?xml version="1.0" encoding='utf-8'?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:thr="http://purl.org/syndication/thread/1.0">
   <id>http://ndr.nsdl.org/collections/NSDL</id>
   <updated>2009-10-14T14:55:07.711Z</updated>
   <author>
       <name>NSDL.org</name>
   </author>

Not sure what is appropriate to use here...

    <logo>http://nsdl.org/images/brands/nsdl.nsdl.gif</logo>
    <title>NSDL collections</title>

    <link rel="self"
        href="http://ndrtest.nsdl.org/api/get/2200/test.20091013104354553T/content" />
    <link rel="service" type="application/atomsvc+xml"
        href="http://ndrtest.nsdl.org/api/get/2200/test.20091014154402647T/content" />

Each feed contains links to itself AND to the service document whence it came.


   <entry>
       <id>http://ndr.nsdl.org/collections/NSDL-COLLECTION-928276</id>
       <title>TeachEngineering: Resources for K-12</title>
       <updated>2009-10-13T14:55:07.711Z</updated>
       <content type="application/xml"
           src="http://ndr.nsdl.org/api/get/2200/20061002130326535T/format_ncs_collect" />

The content element contains a link to the primary catalog record (ncs_collect in this case)


       <summary>
           The TeachEngineering digital library provides teacher-tested,
           standards-based engineering content for K-12 teachers to use in
           science and math classrooms. Engineering lessons connect real-world
           experiences with curricular content already taught in K-12
           classrooms. Mapped to educational content standards,
           TeachEngineering's comprehensive curricula are hands-on, inexpensive,
           and relevant to children's daily lives.
       </summary>

Atom feeds that don't have human readable content must have a summary. This is just the record's description


       <category scheme="http://ns.nsdl.org/collections/type"
           term="collection" />
       <category scheme="http://ns.nsdl.org/collections/format"
           term="ncs_collect" />

This is a collection record whose primary format is ncs_collect


       <link rel="edit" type="application/atom+xml;type=entry"
           href="http://ndrtest.nsdl.org/api/get/2200/test.20091014152502577T/content" />
       <link rel="edit-media" type="application/xml"
           href="http://ndr.nsdl.org/api/get/2200/20061002130326535T/format_ncs_collect" />

Links prescribed by AtomPub for editing this atom entry, or the primary metadata record (the media)


       <link rel="related" type="application/atom+xml;type=feed" title="feed"
           href="http://ndrtest.nsdl.org/api/get/2200/test.20091013232544291T/content" />

A collection entry must contain an atom:link rel="related" tithe="feed" that points to a feed containing the items in the collection.


       <link rel="related" type="application/xml" title="dcs_data"
           href="http://ndr.nsdl.org/api/get/2200/20061002130326535T/format_dcs_data" />

This is an application-specific chunk of data. It's not considered to be public cataloging metadata. In this case, it is something used by the NCS.


       <link rel="enclosure" type="application/xml"
           href="http://ndr.nsdl.org/api/get/2200/20061002130326535T/format_ncs_collect" />
       <link rel="enclosure" type="application/xml" title="nsdl_dc"
           href="http://ndr.nsdl.org/api/get/2200/20061002130326535T/format_nsdl_dc" />

These are all the blobs that are considered to be cataloging metadata. In this case, there are two files here: The record in ncs_collect, and the record in nsdl_dc.


       <link rel="alternate" type="text/html" title="resource"
           href="http://www.teachengineering.com/" />

All records must contain exactly one rel="alternate" link containing the URL of the resource being cataloged. For collections, this is the collection URL.


   </entry>    
   <entry>
       <id>http://ndr.nsdl.org/collections/NSDL-COLLECTION-1007936</id>
       <title>Middle School Portal: Math and Science Pathways (MSP2)</title>
       <updated>2009-10-13T14:43:55.367Z</updated>
       <content type="application/xml"
           src="http://ndr.nsdl.org/api/get/2200/20061002130511770T/format_ncs_collect" />
       <summary>
           The Middle School Portal: Math and Science Pathways (MSP2)
           identifies digital resources that support reform-based middle school
           math and science teaching and learning. Its Mathematics Pathway and
           Science Pathway present standards-based publications that take an
           in-depth look at teachable concepts in math and science. All
           resources are examined with the following criteria in mind: content of
           the resource is accurate; it promotes student learning; it aligns with
           one or more national math and/or science education standards; it is
           grade-level appropriate; it promotes equity and access; and the
           resource is easily navigable. A blog called Connecting News to
           National Science Education Standards encourages science teachers to
           integrate current events into their instruction. Users can also
           search or browse by subject lists and register to be notified when new
           content is posted to the site.
       </summary>
       <category scheme="http://ns.nsdl.org/collections/type"
           term="collection" />
       <category scheme="http://ns.nsdl.org/collections/format"
           term="ncs_collect" />
       <link rel="edit" type="application/atom+xml;type=entry"
           href="http://ndrtest.nsdl.org/api/get/2200/test.20091013183756959T/content" />
       <link rel="edit-media" type="application/xml"
           href="http://ndr.nsdl.org/api/get/2200/20061002130511770T/format_ncs_collect" />
       <link rel="related" type="application/atom+xml;type=feed" title="feed"
           href="http://ndrtest.nsdl.org/api/get/2200/test.20091013181355926T/content" />
       <link rel="related" type="application/xml" title="dcs_data"
           href="http://ndr.nsdl.org/api/get/2200/20061002130511770T/format_dcs_data" />
       <link rel="enclosure" type="application/xml" title="format_ncs_collect"
           href="http://ndr.nsdl.org/api/get/2200/20061002130511770T/format_ncs_collect" />
       <link rel="enclosure" type="application/xml" title="format_nsdl_dc"
           href="http://ndr.nsdl.org/api/get/2200/20061002130511770T/format_nsdl_dc" />
       <link rel="alternate" type="text/html" title="resource"
           href="http://www.msteacher2.org/" />
   </entry>
</feed>
Personal tools