flickrex

{
  "stat": "ok",
  "method": {
    "requiredperms": "1",
    "needssigning": 1,
    "needslogin": 1,
    "name": "flickr.push.subscribe",
    "description": {
      "_content": "In ur pandas, tickling ur unicorn\n<br><br>\n<i>(this method is experimental and may change)</i>"
    }
  },
  "errors": {
    "error": [
      {
        "message": "Required parameter missing",
        "code": "1",
        "_content": "One of the required arguments for the method was not provided."
      },
      {
        "message": "Invalid parameter value",
        "code": "2",
        "_content": "One of the arguments was specified with an illegal value."
      },
      {
        "message": "Callback URL already in use for a different subscription",
        "code": "3",
        "_content": "A different subscription already exists that uses the same callback URL."
      },
      {
        "message": "Callback failed or invalid response",
        "code": "4",
        "_content": "The verification callback failed, or failed to return the expected response to confirm the subscription."
      },
      {
        "message": "Service currently available only to pro accounts",
        "code": "5",
        "_content": "PuSH subscriptions are currently restricted to Pro account holders."
      },
      {
        "message": "Subscription awaiting verification callback response - try again later",
        "code": "6",
        "_content": "A subscription with those details exists already, but it is in a pending (non-verified) state. Please wait a bit for the verification callback to complete before attempting to update the subscription."
      },
      {
        "message": "SSL is required",
        "code": 95,
        "_content": "SSL is required to access the Flickr API."
      },
      {
        "message": "Invalid signature",
        "code": 96,
        "_content": "The passed signature was invalid."
      },
      {
        "message": "Missing signature",
        "code": 97,
        "_content": "The call required signing but no signature was sent."
      },
      {
        "message": "Login failed / Invalid auth token",
        "code": 98,
        "_content": "The login details or auth token passed were invalid."
      },
      {
        "message": "User not logged in / Insufficient permissions",
        "code": 99,
        "_content": "The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions."
      },
      {
        "message": "Invalid API Key",
        "code": 100,
        "_content": "The API key passed was not valid or has expired."
      },
      {
        "message": "Service currently unavailable",
        "code": 105,
        "_content": "The requested service is temporarily unavailable."
      },
      {
        "message": "Write operation failed",
        "code": 106,
        "_content": "The requested operation failed due to a temporary issue."
      },
      {
        "message": "Format \"xxx\" not found",
        "code": 111,
        "_content": "The requested response format was not found."
      },
      {
        "message": "Method \"xxx\" not found",
        "code": 112,
        "_content": "The requested method was not found."
      },
      {
        "message": "Invalid SOAP envelope",
        "code": 114,
        "_content": "The SOAP envelope send in the request could not be parsed."
      },
      {
        "message": "Invalid XML-RPC Method Call",
        "code": 115,
        "_content": "The XML-RPC request document could not be parsed."
      },
      {
        "message": "Bad URL found",
        "code": 116,
        "_content": "One or more arguments contained a URL that has been used for abuse on Flickr."
      }
    ]
  },
  "arguments": {
    "argument": [
      {
        "optional": 0,
        "name": "api_key",
        "_content": "Your API application key. <a href=\"/services/api/misc.api_keys.html\">See here</a> for more details."
      },
      {
        "optional": "0",
        "name": "topic",
        "_content": "The type of subscription. See <a href=\"http://www.flickr.com/services/api/flickr.push.getTopics.htm\">flickr.push.getTopics</a>."
      },
      {
        "optional": "0",
        "name": "callback",
        "_content": "The url for the subscription endpoint. Limited to 255 bytes, and must be unique for this user, i.e. no two subscriptions for a given user may use the same callback url."
      },
      {
        "optional": "0",
        "name": "verify",
        "_content": "The verification mode, either <code>sync</code> or <code>async</code>. See the <a href=\"http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html#subscribingl\">Google PubSubHubbub spec</a> for details."
      },
      {
        "optional": "1",
        "name": "verify_token",
        "_content": "The verification token to be echoed back to the subscriber during the verification callback, as per the <a href=\"http://pubsubhubbub.googlecode.com/svn/trunk/pubsubhubbub-core-0.3.html#subscribing\">Google PubSubHubbub spec</a>. Limited to 200 bytes."
      },
      {
        "optional": "1",
        "name": "lease_seconds",
        "_content": "Number of seconds for which the subscription will be valid. Legal values are 60 to 86400 (1 minute to 1 day). If not present, the subscription will be auto-renewing."
      },
      {
        "optional": "1",
        "name": "woe_ids",
        "_content": "A 32-bit integer for a <a href=\"http://developer.yahoo.com/geo/geoplanet/\">Where on Earth ID</a>. Only valid if <code>topic</code> is <code>geo</code>.\n<br/><br/>\nThe order of precedence for geo subscriptions is : woe ids, place ids, radial i.e. the <code>lat, lon</code> parameters will be ignored if <code>place_ids</code> is present, which will be ignored if <code>woe_ids</code> is present."
      },
      {
        "optional": "1",
        "name": "place_ids",
        "_content": "A comma-separated list of Flickr place IDs. Only valid if <code>topic</code> is <code>geo</code>.\n<br/><br/>\nThe order of precedence for geo subscriptions is : woe ids, place ids, radial i.e. the <code>lat, lon</code> parameters will be ignored if <code>place_ids</code> is present, which will be ignored if <code>woe_ids</code> is present."
      },
      {
        "optional": "1",
        "name": "lat",
        "_content": "A latitude value, in decimal format. Only valid if <code>topic</code> is <code>geo</code>. Defines the latitude for a radial query centered around (lat, lon).\n<br/><br/>\nThe order of precedence for geo subscriptions is : woe ids, place ids, radial i.e. the <code>lat, lon</code> parameters will be ignored if <code>place_ids</code> is present, which will be ignored if <code>woe_ids</code> is present."
      },
      {
        "optional": "1",
        "name": "lon",
        "_content": "A longitude value, in decimal format. Only valid if <code>topic</code> is <code>geo</code>. Defines the longitude for a radial query centered around (lat, lon).\n<br/><br/>\nThe order of precedence for geo subscriptions is : woe ids, place ids, radial i.e. the <code>lat, lon</code> parameters will be ignored if <code>place_ids</code> is present, which will be ignored if <code>woe_ids</code> is present."
      },
      {
        "optional": "1",
        "name": "radius",
        "_content": "A radius value, in the units defined by radius_units. Only valid if <code>topic</code> is <code>geo</code>. Defines the radius of a circle for a radial query centered around (lat, lon). Default is 5 km.\n<br/><br/>\nThe order of precedence for geo subscriptions is : woe ids, place ids, radial i.e. the <code>lat, lon</code> parameters will be ignored if <code>place_ids</code> is present, which will be ignored if <code>woe_ids</code> is present."
      },
      {
        "optional": "1",
        "name": "radius_units",
        "_content": "Defines the units for the radius parameter. Only valid if <code>topic</code> is <code>geo</code>. Options are <code>mi</code> and <code>km</code>. Default is <code>km</code>.\n<br/><br/>\nThe order of precedence for geo subscriptions is : woe ids, place ids, radial i.e. the <code>lat, lon</code> parameters will be ignored if <code>place_ids</code> is present, which will be ignored if <code>woe_ids</code> is present."
      },
      {
        "optional": "1",
        "name": "accuracy",
        "_content": "Defines the minimum accuracy required for photos to be included in a subscription. Only valid if <code>topic</code> is <code>geo</code> Legal values are 1-16, default is 1 (i.e. any accuracy level).\n<ul>\n<li>World level is 1</li>\n<li>Country is ~3</li>\n<li>Region is ~6</li>\n<li>City is ~11</li>\n<li>Street is ~16</li>\n</ul>"
      },
      {
        "optional": "1",
        "name": "nsids",
        "_content": "A comma-separated list of nsids representing Flickr Commons institutions (see <a href=\"http://www.flickr.com/services/api/flickr.commons.getInstitutions.html\">flickr.commons.getInstitutions</a>). Only valid if <code>topic</code> is <code>commons</code>. If not present this argument defaults to all Flickr Commons institutions."
      },
      {
        "optional": "1",
        "name": "tags",
        "_content": "A comma-separated list of strings to be used for tag subscriptions. Photos with one or more of the tags listed will be included in the subscription. Only valid if the <code>topic</code> is <code>tags</code>."
      }
    ]
  }
}