Current section

Files

Jump to
flickrex lib flickr getMethodInfo flickr.push.subscribe.json
Raw

lib/flickr/getMethodInfo/flickr.push.subscribe.json

{
"arguments": {
"argument": [
{
"_content": "Your API application key. <a href=\"/services/api/misc.api_keys.html\">See here</a> for more details.",
"name": "api_key",
"optional": 0
},
{
"_content": "The type of subscription. See <a href=\"http://www.flickr.com/services/api/flickr.push.getTopics.htm\">flickr.push.getTopics</a>.",
"name": "topic",
"optional": "0"
},
{
"_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.",
"name": "callback",
"optional": "0"
},
{
"_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.",
"name": "verify",
"optional": "0"
},
{
"_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.",
"name": "verify_token",
"optional": "1"
},
{
"_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.",
"name": "lease_seconds",
"optional": "1"
},
{
"_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.",
"name": "woe_ids",
"optional": "1"
},
{
"_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.",
"name": "place_ids",
"optional": "1"
},
{
"_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.",
"name": "lat",
"optional": "1"
},
{
"_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.",
"name": "lon",
"optional": "1"
},
{
"_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.",
"name": "radius",
"optional": "1"
},
{
"_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.",
"name": "radius_units",
"optional": "1"
},
{
"_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>",
"name": "accuracy",
"optional": "1"
},
{
"_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.",
"name": "nsids",
"optional": "1"
},
{
"_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>.",
"name": "tags",
"optional": "1"
}
]
},
"errors": {
"error": [
{
"_content": "One of the required arguments for the method was not provided.",
"code": "1",
"message": "Required parameter missing"
},
{
"_content": "One of the arguments was specified with an illegal value.",
"code": "2",
"message": "Invalid parameter value"
},
{
"_content": "A different subscription already exists that uses the same callback URL.",
"code": "3",
"message": "Callback URL already in use for a different subscription"
},
{
"_content": "The verification callback failed, or failed to return the expected response to confirm the subscription.",
"code": "4",
"message": "Callback failed or invalid response"
},
{
"_content": "PuSH subscriptions are currently restricted to Pro account holders.",
"code": "5",
"message": "Service currently available only to pro accounts"
},
{
"_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.",
"code": "6",
"message": "Subscription awaiting verification callback response - try again later"
},
{
"_content": "SSL is required to access the Flickr API.",
"code": 95,
"message": "SSL is required"
},
{
"_content": "The passed signature was invalid.",
"code": 96,
"message": "Invalid signature"
},
{
"_content": "The call required signing but no signature was sent.",
"code": 97,
"message": "Missing signature"
},
{
"_content": "The login details or auth token passed were invalid.",
"code": 98,
"message": "Login failed / Invalid auth token"
},
{
"_content": "The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.",
"code": 99,
"message": "User not logged in / Insufficient permissions"
},
{
"_content": "The API key passed was not valid or has expired.",
"code": 100,
"message": "Invalid API Key"
},
{
"_content": "The requested service is temporarily unavailable.",
"code": 105,
"message": "Service currently unavailable"
},
{
"_content": "The requested operation failed due to a temporary issue.",
"code": 106,
"message": "Write operation failed"
},
{
"_content": "The requested response format was not found.",
"code": 111,
"message": "Format \"xxx\" not found"
},
{
"_content": "The requested method was not found.",
"code": 112,
"message": "Method \"xxx\" not found"
},
{
"_content": "The SOAP envelope send in the request could not be parsed.",
"code": 114,
"message": "Invalid SOAP envelope"
},
{
"_content": "The XML-RPC request document could not be parsed.",
"code": 115,
"message": "Invalid XML-RPC Method Call"
},
{
"_content": "One or more arguments contained a URL that has been used for abuse on Flickr.",
"code": 116,
"message": "Bad URL found"
}
]
},
"method": {
"description": {
"_content": "In ur pandas, tickling ur unicorn\n<br><br>\n<i>(this method is experimental and may change)</i>"
},
"name": "flickr.push.subscribe",
"needslogin": 1,
"needssigning": 1,
"requiredperms": "1"
},
"stat": "ok"
}