Community articleGetting a feed of profiles codes using Administration API
Added by IBM contributorIBM on July 1, 2014
Rate this article 1 starsRate this article 2 starsRate this article 3 starsRate this article 4 starsRate this article 5 stars

No abstract provided.

Retrieve a feed that lists all of the entries of a particular code type stored on the profiles server. This data has been populated either via the API or via a TDI fill_* process.
This method returns a feed of profiles as opposed to retrieving the Atom entry of a single code entry. If you want to retrieve the Atom entry document for a single code, specify the codeId in the request URI However, the entry document returned by that request contains the same information that is already available in this feed.
 

Use the codeId input parameters to narrow the search.

Input

None.

Output

An Atom entry document containing a feed of profiles codes.

 

Input
Method URI Description
GET /profiles/admin/atom/codes/Country.do Retrieves all Country data. The feed includes the fields (including their current values) associated with each Country.
GET /profiles/admin/atom/codes/Department.do Retrieves all Department data. The feed includes the fields (including their current values) associated with each Department.
GET /profiles/admin/atom/codes/EmployeeType.do Retrieves all Employee Type data. The feed includes the fields (including their current values) associated with each Employee Type.
GET /profiles/admin/atom/codes/Organization.do Retrieves all Organization data. The feed includes the fields (including their current values) associated with each Organization.
GET /profiles/admin/atom/codes/WorkLocation.do Retrieves all Work Location data. The feed includes the fields (including their current values) associated with each Work Location.
Content Type: application/atom+xml
Name Type Optional Description
codeId
string Yes The codeId for the particular entry you wish to retrieve. Use the codeId input parameters to narrow the search.
Output
Content Type: application/atom+xml
Code Description
200
OK. Indicates that the request was received successfully.
Examples
> GET /profiles/admin/atom/codes/Department.do HTTP/1.1

> Authorization: xxx

> Host: enterprise.example.com

> Accept: */*

Response returned by the server
<feed xmlns:app="http://www.w3.org/2007/app" xmlns:thr="http://purl.org/syndication/thread/1.0"

xmlns:fh="http://purl.org/syndication/history/1.0" xmlns:snx="http://www.ibm.com/xmlns/prod/sn"

xmlns:opensearch="http://a9.com/-/spec/opensearch/1.1/" xmlns="http://www.w3.org/2005/Atom">

<id>tag:profiles.ibm.com,2006:com.ibm.snx_profiles.codes.departmentCode</id>

<generator version="4.5.0.0" uri="http://www.ibm.com/xmlns/prod/sn">

  IBM Connections - Profiles

</generator>

<title type="text">department information for code</title>

<author><name>IBM Connections - Profiles</name></author>

<updated>2013-01-25T16:25:07.292Z</updated>

<fh:complete></fh:complete>

<entry>

  <id>tag:profiles.ibm.com,2006:com.ibm.snx_profiles.codes.department:CS</id>

  <category term="profiles.codes" scheme="http://www.ibm.com/xmlns/prod/sn/type"></category>

  <title type="text">CS</title>

  <updated>2013-01-25T16:25:07.292Z</updated>

  <link 

    href="http://enterprise.example.com/profiles/admin/atom/codes/Department.do?codeId=CS" 

    rel="self">

  </link>

  <link 

    href="http://enterprise.example.com/profiles/admin/atom/codes/Department.do?codeId=CS" 

    rel="edit">

  </link>

  <content type="application/xml">

    <appData xmlns="http://ns.opensocial.org/2008/opensocial">

      <com.ibm.snx_profiles.codes.department.departmentTitle>

        Customer Services

      </com.ibm.snx_profiles.codes.department.departmentTitle>

      <com.ibm.snx_profiles.codes.department.departmentCode>

        CS

      </com.ibm.snx_profiles.codes.department.departmentCode>

    </appData>

  </content>

</entry>

<entry>

  <id>tag:profiles.ibm.com,2006:com.ibm.snx_profiles.codes.department:ENG</id>

  <category term="profiles.codes" scheme="http://www.ibm.com/xmlns/prod/sn/type"></category>

  <title type="text">ENG</title>

  <updated>2013-01-25T16:25:07.292Z</updated>

  <link 

    href="http://enterprise.example.com/profiles/admin/atom/codes/Department.do?codeId=ENG" 

    rel="self">

  </link>

  <link 

    href="http://enterprise.example.com/profiles/admin/atom/codes/Department.do?codeId=ENG 

    rel="edit">

  </link>

  <content type="application/xml">

    <appData xmlns="http://ns.opensocial.org/2008/opensocial">

      <com.ibm.snx_profiles.codes.department.departmentTitle>

        Engineering

      </com.ibm.snx_profiles.codes.department.departmentTitle>

      <com.ibm.snx_profiles.codes.department.departmentCode>

        ENG

      </com.ibm.snx_profiles.codes.department.departmentCode>

    </appData>

  </content>

</entry>

<entry>

  <id>tag:profiles.ibm.com,2006:com.ibm.snx_profiles.codes.department:SM</id>

  <category term="profiles.codes" scheme="http://www.ibm.com/xmlns/prod/sn/type"></category>

  <title type="text">SM</title>

  <updated>2013-01-25T16:25:07.292Z</updated>

  <link 

    href="http://enterprise.example.com/profiles/admin/atom/codes/Department.do?codeId=SM" 

    rel="self">

  </link>

  <link 

    href="http://enterprise.example.com/profiles/admin/atom/codes/Department.do?codeId=SM" 

    rel="edit">

  </link>

  <content type="application/xml">

    <appData xmlns="http://ns.opensocial.org/2008/opensocial">

      <com.ibm.snx_profiles.codes.department.departmentTitle>

        Sales and Marketing

      </com.ibm.snx_profiles.codes.department.departmentTitle>

      <com.ibm.snx_profiles.codes.department.departmentCode>

        SM

      </com.ibm.snx_profiles.codes.department.departmentCode>

    </appData>

  </content>

</entry>

</feed>