Simpy : API : REST : v1 : GetLinks

Home / APIs / REST / GetLinks

GetLinks

Description:

Depending on your input parameters, this call returns your most recent links, links added on or between given dates, or links matching a given query, or links with a given tag. You can use the limit parameter to specify the maximum number of links to return.

Required Parameters:

none

Optional Parameters:

q: A query string that forces the API call to return only the matching links. You can use the usual Simpy search syntax and search fields.
limit: Limits the number of links returned. Use -1 to remove the limit.
date: This parameter should not be used in combination with the afterDate and beforeDate parameters. It limits the links returned to links added on the given date.
afterDate: This parameter should be used in combination with the beforeDate parameter. It limits the links returned to links added after the given date, excluding the date specified.
beforeDate: This parameter should be used in combination with the afterDate parameter. It limits the links returned to links added before the given date, excluding the date specified.

Example Requests

http://www.simpy.com/simpy/api/rest/GetLinks.do

http://www.simpy.com/simpy/api/rest/GetLinks.do?q=ecology

http://www.simpy.com/simpy/api/rest/GetLinks.do?date=2004-12-01

http://www.simpy.com/simpy/api/rest/GetLinks.do?afterDate=2004-12-01&beforeDate=2005-01-01

http://www.simpy.com/simpy/api/rest/GetLinks.do?afterDate=2005-01-01&beforeDate=2005-06-01&q=monkeys

Example Response

<?xml version="1.0" encoding="UTF-8"?>

<links>
  <link accessType="public">
    <url>http://www.foobar.com</url>
    <modDate>2005-03-15</modDate>
    <addDate>2005-03-15</addDate>
    <title>FooBar</title>
    <nickname>Foo Bar Site</nickname>
    <tags>
      <tag>tag1</tag>
      <tag>tag2</tag>
    </tags>
    <note>note here</note>
  </link>
  <link accessType="private">
    <url>
      http://www.ontopia.net/topicmaps/materials/tm-vs-thesauri.html
    </url>
    <modDate>2005-03-15</modDate>
    <addDate>2005-03-15</addDate>
    <title>Metadata? Thesauri? Taxonomies? Topic Maps!</title>
    <nickname/>
    <tags>
      <tag>topics</tag>
      <tag>tags</tag>
      <tag>taxonomies</tag>
    </tags>
    <note/>
  </link>
</links>

Status Codes

300: Transient data retrieval error

Overview

· Base URL: ...simpy.com/simpy/api/rest