Retrieving the Communities service document

Home

Retrieving the Communities service document

The first step perform if you plan to update resources made available through the Atom APIs is to retrieve the service document for the feature.

Atom API request details

Method Resource URI Description
GET Service Document /service/atom/service Retrieves a user's service document which contains the Communities Collections workspace.

Example
To retrieve the service document for the Communities feature, send the following HTTP request:
> GET /communities/service/atom/service HTTP/1.1
> Authorization: Basic am9lX2RvZUBhY21lLmNvbTpwYXNzdzByZA==
> Host: communities.enterprise.acme.com:9080
> Accept: */*
The service document for Communities is returned by the server. For example:
<?xml version="1.0" encoding="UTF-8" ?> 
<service 
 xml:lang="en" 
 xmlns="http://www.w3.org/2007/app" 
 xmlns:atom="http://www.w3.org/2005/Atom">
  <workspace>
    <atom:title type="text">Communities Collections</atom:title> 
    <collection 
     href="https://communities.enterprise.acme.com:9443/communities/service/
      atom/communities/all">
      <atom:title type="text">All Communities</atom:title> 
      <accept /> 
      <categories 
       href="https://communities.enterprise.acme.com:9443/communities/service/
        atom/communities/all?outputType=categories" /> 
      <categories 
       href="https://communities.enterprise.acme.com:9443/communities/service/
        atom/communities/all?outputType=flags" /> 
    </collection>
    <collection 
     href="https://communities.enterprise.acme.com:9443/communities/service/
      atom/communities/my">
      <atom:title type="text">My Communities</atom:title> 
      <accept>entry</accept> 
      <categories 
       href="https://communities.enterprise.acme.com:9443/communities/service/
        atom/communities/my?outputType=categories" /> 
      <categories 
       href="https://communities.enterprise.acme.com:9443/communities/service/
        atom/communities/my?outputType=flags" /> 
    </collection>
  </workspace>
  <atom:generator 
   uri="http://www.ibm.com/xmlns/prod/sn" 
   version="2.0">Lotus Connections - Communities</atom:generator> 
</service>
Communities service document content
When working with the Communities publishing APIs, first obtain the Communities service document. The service document provides access to all of the Communities resources that you can update.

Communities API

+
Search Tips | Advanced Search