Atom Publishing Protocol (AtomPub)

Web-Based Publishing (INFO 290-19)

Erik Wilde, UC Berkeley School of Information
Creative Commons License

This work is licensed under a CC
Attribution 3.0 Unported License


Atom is a read-only format for publishing entries and entry metadata in a feed. The Atom Publishing Protocol (AtomPub) is built on top of Atom for providing a protocol for submitting new entries to feeds. AtomPub introduces the concept of a collection, which is the set of entries which are managed through AtomPub and can be published as an Atom feed. AtomPub clients can add new entries to a collection using HTTP interactions, and AtomPub supports entries which are based on some XML format, as well as any other type of entry (such as images).

Content Feeds

Outline (Atom Publishing Protocol)

  1. Atom Publishing Protocol [10]
  2. AtomPub Add-Ons [8]
    1. GData [2]
    2. LocAtomPub [3]
  3. Conclusions [1]

Syndication Format Protocols

RESTified Syndication

AtomPub Data Model

AtomPub Data Model

Workspaces, Collections, Resources

Creating Media Resources

POST /edit/ HTTP/1.1
Content-Type: image/png
Slug: The Beach
Content-Length: nnn

...binary data...
HTTP/1.1 201 Created
Date: Fri, 7 Oct 2005 17:17:11 GMT
Content-Length: nnn
Content-Type: application/atom+xml;type=entry;charset="utf-8"

<?xml version="1.0"?>
<entry xmlns="">
  <title>The Beach</title>
  <content type="image/png" src=""/>
  <link rel="edit-media" href="" />
  <link rel="edit" href="" />

Protocol Summary

Resource HTTP Method Representation Description
Introspection GET Atom Service Document Enumerates a set of collections and lists their URIs and other information about the collections
Collection GET Atom Feed A list of member of the collection (this may be a subset of all entries in the collection)
Collection POST Atom Entry Create a new entry in the collection
Member GET Atom Entry Get the Atom Entry
Member PUT Atom Entry Update the Atom Entry
Member DELETE n/a Delete the Atom Entry from the collection

Service Documents

Service Documents represent server-defined groups of Collections, and are used to initialize the process of creating and editing resources.

Service Document Example

<service xmlns="" xmlns:atom="">
  <atom:title>Main Site</atom:title>
  <collection href="">
   <atom:title>My Blog Entries</atom:title>
   <categories href=""/>
  <collection href="">
  <atom:title>Side Bar Blog</atom:title>
  <collection href="">
   <atom:title>Remaindered Links</atom:title>
   <categories fixed="yes">
    <atom:category scheme="" term="joke"/>
    <atom:category scheme="" term="serious"/>

Category Documents

Category Document Example

<app:categories xmlns:app="" xmlns="" fixed="yes" scheme="">
 <category term="animal"/>
 <category term="vegetable"/>
 <category term="mineral"/>

Outline (AtomPub Add-Ons)

  1. Atom Publishing Protocol [10]
  2. AtomPub Add-Ons [8]
    1. GData [2]
    2. LocAtomPub [3]
  3. Conclusions [1]


Atom Publishing Protocol Feature Discovery

Atom Syndication Format Tombstones

Outline (GData)

  1. Atom Publishing Protocol [10]
  2. AtomPub Add-Ons [8]
    1. GData [2]
    2. LocAtomPub [3]
  3. Conclusions [1]

GData & AtomPub

GData Contact entry

<entry xmlns:gd="">
 <category scheme="" term=""/>
 <category term="user-tag" label="Colleague"/>
 <title>Jo March</title>
 <gd:im protocol="AIM" address=""/>
 <gd:phoneNumber rel="">(206) 555-1212</gd:phoneNumber>
 <gd:phoneNumber rel="">(206) 555-1213</gd:phoneNumber>
 <gd:email rel="" address=""/>
 <gd:phoneNumber rel="">(650) 555-1212</gd:phoneNumber>
 <gd:phoneNumber rel="">(650) 555-1214</gd:phoneNumber>
 <gd:postalAddress rel="">1600 Amphitheatre Pkwy, Mountain View, CA 94043
 <gd:geoPt lat="37.423269" lon="-122.082667"/>
 <gd:email address="" rel=""/>
 <gd:phoneNumber rel="">(206) 555-1212</gd:phoneNumber>
 <gd:postalAddress rel="">800 Main Street, Mountain View, CA 94041

Outline (LocAtomPub)

  1. Atom Publishing Protocol [10]
  2. AtomPub Add-Ons [8]
    1. GData [2]
    2. LocAtomPub [3]
  3. Conclusions [1]

Location-Aware AtomPub

LocAtom Entry

 <entry xml:base="trees/2008/02/28/" xmlns="" xml:lang="en-us">
  <title>South Hall Dead Oak</title>
  <category scheme="" term="missingleaves"/>
  <category scheme="" term="blackbark"/>
  <category scheme="" term="nobranches"/>
  <location lat="37.87152" long="-122.257852"/>
  <location scheme="" term="ucb-campus"/>
  <content type="xhtml">
   <div xmlns="">


<placeml xml:lang="en">
 <name>UC Berkeley Campuses</name>
 <place id="ucb-campus">
  <name>UCB Main Campus</name>
  <description>The main campus has all important buildings and starts right in downtown Berkeley. It can be easily reached by BART from San Francisco and other bay area locations.</description>
    <point long="-122.266182" lat="37.874039"/>
    <point long="-122.265602" lat="37.869637"/>
    <point long="-122.266098" lat="37.868755"/>
    <point long="-122.265770" lat="37.867943"/>
    <point long="-122.252556" lat="37.869686"/>
    <point long="-122.252937" lat="37.871075"/>
    <point long="-122.252876" lat="37.871670"/>
    <point long="-122.253967" lat="37.872620"/>
    <point long="-122.255516" lat="37.873787"/>
    <point long="-122.256844" lat="37.875397"/>
    <point long="-122.266182" lat="37.874039"/>

Outline (Conclusions)

  1. Atom Publishing Protocol [10]
  2. AtomPub Add-Ons [8]
    1. GData [2]
    2. LocAtomPub [3]
  3. Conclusions [1]

Writeable Atom