{"id":3116,"date":"2014-01-23T17:03:14","date_gmt":"2014-01-24T01:03:14","guid":{"rendered":"http:\/\/107.21.221.225\/ning3help\/?page_id=3116"},"modified":"2019-10-21T08:17:58","modified_gmt":"2019-10-21T15:17:58","slug":"ning-3-0-api-responses","status":"publish","type":"page","link":"https:\/\/www.ning.com\/ning3help\/ning-3-0-api-responses\/","title":{"rendered":"Ning 3.0 API Response Overview"},"content":{"rendered":"
\n

Response Structure<\/a><\/h2>\n

Responses from resources are formatted as JSON<\/a> objects. The exact structure of the
\nresponse object will vary depending on the resource, parameters, and request
\ntype. Additional details on the exact structure of a response can be found in
\nthe sections below and on the Request Types<\/em><\/a> page.<\/p>\n<\/div>\n

\n

Caching<\/a><\/h2>\n

The data returned by queries is not cached, metadata used for determining
\naccess rights and site properties is cached for less than ten seconds.<\/p>\n

This means that if a photo has it\u2019s visibility changed from me<\/span><\/tt> to all<\/span><\/tt>,
\nit is possible that a request made by another member within ten seconds of the
\nchange will not include the photo in the response.<\/p>\n

On the other hand, an update to a blog post\u2019s title will be seen immediately by
\nthe next request.<\/p>\n<\/div>\n

\n

Successful Response<\/a><\/h2>\n
\n

Read responses<\/a><\/h3>\n

There are 3 types of responses you can get from a successful READ request:
\nsingle item<\/strong>, multi-item<\/strong>, and list<\/strong><\/p>\n

\n

Single Item Response<\/a><\/h4>\n

Single item requests are requests for a specific content item by it\u2019s ID. The
\nresponse contains two properties: success and entry. Success will be true and
\nentry will contain a JSON representation of the requested item. If the requested
\nitem cannot be found the server will respond with a 404 error.<\/p>\n

Example: If you made a request for a blog post on a site:<\/p>\n

\n
GET http:\/\/external.ningapis.com\/xn\/rest\/apiexample\/2.0\/BlogPost?id=2570916:BlogPost:322<\/pre>\n<\/div>\n
Your response would be structured like the following:<\/p>\n
\n
\n
{<\/span>\n    \"success\"<\/span>:<\/span> true<\/span>,<\/span>\n    \"entry\"<\/span>:<\/span> [{<\/span>\n        \"id\"<\/span>:<\/span> \"2570916:BlogPost:322\"<\/span>,<\/span>\n        \"author\"<\/span>:<\/span> \"3ixs6bzjxfkv6\"<\/span>,<\/span>\n        \"title\"<\/span>:<\/span> \"Cycling Las Vegas\"<\/span>,<\/span>\n        \"description\"<\/span>:<\/span> \"Cycling in Las Vegas is better than you would think\"<\/span>\n    }],<\/span>\n}<\/span>\n<\/pre>\n<\/div>\n<\/div>\n<\/div>\n
\n
Multi-Item Response<\/a><\/h4>\n
The request is made for multiple content items using multiple id<\/span><\/tt> parameters.
\nThe resulting entry<\/span><\/tt> resource will be an array of JSON representations or an
\nempty array if none of the items could be found.<\/p>\n
Example: If you made a request for 2 photos on a site:<\/p>\n
\n
GET http:\/\/external.ningapis.com\/xn\/rest\/examplenetwork\/2.0\/Photo?id=1220999:Photo:5605&id=1220999:Photo:5591<\/pre>\n<\/div>\n
Your response would be structured like the following:<\/p>\n
\n
\n
{<\/span>\n  \"success\"<\/span> :<\/span> true<\/span>,<\/span>\n  \"entry\"<\/span> :<\/span> [<\/span> {<\/span>\n    \"id\"<\/span> :<\/span> \"1220999:Photo:5591\"<\/span>,<\/span>\n    \"author\"<\/span> :<\/span> \"exampleuser\"<\/span>,<\/span>\n    \"createdDate\"<\/span> :<\/span> \"2014-01-26T23:20:13.591Z\"<\/span>\n  },<\/span> {<\/span>\n    \"id\"<\/span> :<\/span> \"1220999:Photo:5605\"<\/span>,<\/span>\n    \"author\"<\/span> :<\/span> \"qrwc2g2iqjhi\"<\/span>,<\/span>\n    \"createdDate\"<\/span> :<\/span> \"2014-01-26T20:49:06.605Z\"<\/span>\n  }<\/span> ],<\/span>\n  \"resources\"<\/span> :<\/span> {<\/span>\n  }<\/span>\n}<\/span>\n<\/pre>\n<\/div>\n<\/div>\n<\/div>\n
\n
List Response<\/a><\/h4>\n
Requests for lists of items (such as \/BlogPost\/recent) will return an array of
\nJSON representations or an empty array. It will also contain information for
\npaginating through the result set.<\/p>\n
\n
anchor<\/strong><\/dt>\n
A token used to identify the current page of results relative to the entire
\nset<\/dd>\n
firstPage<\/strong><\/dt>\n
If true, this is the first page of the result set<\/dd>\n
lastPage<\/strong><\/dt>\n
If true, this is the last page of the result set<\/dd>\n<\/dl>\n
Example: If you made a request for the 5 most recent photos on a site:<\/p>\n
\n
GET http:\/\/external.ningapis.com\/xn\/rest\/examplenetwork\/2.0\/Photo\/recent?count=5<\/pre>\n<\/div>\n
Your response would be structured like the following:<\/p>\n
\n
\n
{<\/span>\n  \"success\"<\/span> :<\/span> true<\/span>,<\/span>\n  \"anchor\"<\/span> :<\/span> \"sBLHSuPH8xNPdBxyRHy3pw\"<\/span>,<\/span>\n  \"firstPage\"<\/span> :<\/span> true<\/span>,<\/span>\n  \"lastPage\"<\/span> :<\/span> false<\/span>,<\/span>\n  \"entry\"<\/span> :<\/span> [<\/span> {<\/span>\n    \"id\"<\/span> :<\/span> \"1220999:Photo:5868\"<\/span>,<\/span>\n    \"author\"<\/span> :<\/span> \"exampleuser\"<\/span>,<\/span>\n    \"createdDate\"<\/span> :<\/span> \"2013-06-02T10:54:41.868Z\"<\/span>\n  },<\/span> {<\/span>\n    \"id\"<\/span> :<\/span> \"1220999:Photo:5605\"<\/span>,<\/span>\n    \"author\"<\/span> :<\/span> \"qrwc2g2iqjhi\"<\/span>,<\/span>\n    \"createdDate\"<\/span> :<\/span> \"2013-02-26T20:49:06.605Z\"<\/span>\n  },<\/span> {<\/span>\n    \"id\"<\/span> :<\/span> \"1220999:Photo:5591\"<\/span>,<\/span>\n    \"author\"<\/span> :<\/span> \"exampleuser\"<\/span>,<\/span>\n    \"createdDate\"<\/span> :<\/span> \"2013-01-26T23:20:13.591Z\"<\/span>\n  },<\/span> {<\/span>\n    \"id\"<\/span> :<\/span> \"1220999:Photo:5590\"<\/span>,<\/span>\n    \"author\"<\/span> :<\/span> \"exampleuser\"<\/span>,<\/span>\n    \"createdDate\"<\/span> :<\/span> \"2013-01-26T23:09:02.590Z\"<\/span>\n  },<\/span> {<\/span>\n    \"id\"<\/span> :<\/span> \"1220999:Photo:5589\"<\/span>,<\/span>\n    \"author\"<\/span> :<\/span> \"exampleuser\"<\/span>,<\/span>\n    \"createdDate\"<\/span> :<\/span> \"2013-01-26T21:32:44.589Z\"<\/span>\n  }<\/span> ],<\/span>\n  \"resources\"<\/span> :<\/span> {<\/span>\n  }<\/span>\n}<\/span>\n<\/pre>\n<\/div>\n<\/div>\n<\/div>\n
\n
Count Response<\/a><\/h4>\n
Count requests return the number of items created after a user specified date.
\nFor a successful count request, your response will contain two properties:
\nsuccess<\/span><\/tt> and count<\/span><\/tt>. success<\/span><\/tt> will be true<\/span><\/tt> and count<\/span><\/tt> will be
\nthe number of items in the result set.<\/p>\n
\n
\n
{<\/span>\n    \"success\"<\/span>:<\/span> true<\/span>,<\/span>\n    \"count\"<\/span>:<\/span> 23<\/span>\n}<\/span>\n<\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
Create responses<\/a><\/h3>\n
For a successful CREATE request, your response will contain two properties:
\nsuccess<\/span><\/tt> and id<\/span><\/tt>. success<\/span><\/tt> will be true<\/span><\/tt> and id<\/span><\/tt> will be the ID
\nof the item you just created.<\/p>\n
Example: If you made a request to create a blog post:<\/p>\n
\n
POST \/xn\/rest\/apiexample\/2.0\/BlogPost?fields=title HTTP\/1.1\nHost: external.ningapis.com\nAuthorization: oauth_signature_method=\"PLAINTEXT\",oauth_consumer_key=\"0d716e57-5ada-4b29-a33c-2f4af1b26837\",oauth_token=\"a2f85402-f16c-4677-91e2-a334d362ad47\",oauth_signature=\"f0963fa5-1259-434f-86fc-8a17d14b16ca%26b42a0833-e1e2-4b02-a906-258a157bc702\"\nContent-Length: 47\nContent-Type: application\/x-www-form-urlencoded\ntitle=BlogPost&description=BlogPost description<\/pre>\n<\/div>\n
The response would look like:<\/p>\n
\n
\n
{<\/span>\n    \"success\"<\/span>:<\/span> true<\/span>,<\/span>\n    \"id\"<\/span>:<\/span> \"123:BlogPost:456\"<\/span>\n}<\/span>\n<\/pre>\n<\/div>\n<\/div>\n<\/div>\n
\n
Update responses<\/a><\/h3>\n
For a successful UPDATE request, your response will contain 1 property:
\nsuccess<\/span><\/tt> and it\u2019s value will be true<\/span><\/tt><\/p>\n
Example: if you made a request to update a photo:<\/p>\n
\n
PUT \/xn\/rest\/apiexample\/2.0\/Photo?id=3011345:Photo:1077 HTTP\/1.1\nHost: external.ningapis.com\nAuthorization: oauth_signature_method=\"PLAINTEXT\",oauth_consumer_key=\"0d716e57-5ada-4b29-a33c-2f4af1b26837\",oauth_token=\"a2f85402-f16c-4677-91e2-a334d362ad47\",oauth_signature=\"f0963fa5-1259-434f-86fc-8a17d14b16ca%26b42a0833-e1e2-4b02-a906-258a157bc702\"\nContent-Length: 85\nContent-Type: application\/x-www-form-urlencoded\n\ntitle=Updated Photo Title&description=Updated Photo Description<\/pre>\n<\/div>\n
The response would look like:<\/p>\n
\n
\n
{<\/span>\n    \"success\"<\/span>:<\/span> true<\/span>\n}<\/span>\n<\/pre>\n<\/div>\n<\/div>\n<\/div>\n
\n
Delete responses<\/a><\/h3>\n
For a successful DELETE request, your response will contain 1 property:
\nsuccess<\/span><\/tt> and it\u2019s value will be true<\/span><\/tt><\/p>\n
Example: if you made a request to delete a photo:<\/p>\n
\n
DELETE http:\/\/external.ningapis.com\/xn\/rest\/examplenetwork\/2.0\/Photo?id=1220998:Photo:5581<\/pre>\n<\/div>\n
The response would look like:<\/p>\n
\n
\n
{<\/span>\n    \"success\"<\/span>:<\/span> true<\/span>\n}<\/span>\n<\/pre>\n<\/div>\n<\/div>\n<\/div>\n<\/div>\n
\n
Failed Response<\/a><\/h2>\n
If a request fails, there are several pieces of info that will help clue you
\ninto what\u2019s going on:<\/p>\n
\n
success<\/strong><\/dt>\n
For failed requests, this will always be false<\/dd>\n
reason<\/strong><\/dt>\n
A human readable reason for the failure<\/dd>\n
status<\/strong><\/dt>\n
The HTTP status code for the request<\/dd>\n
code<\/strong><\/dt>\n
A numeric value indicating the category this error belongs to. This is meant
\nto be consumed programmatically.<\/dd>\n
subcode<\/strong><\/dt>\n
A numeric value that indicates the specific error that was triggered. This
\nis meant to be consumed programmatically.<\/dd>\n
trace<\/strong><\/dt>\n
An identifier that is used by Ning to debug issues. Include this number in
\nany bug reports.<\/dd>\n<\/dl>\n
Here is an example of a failed response:<\/p>\n
\n
\n
{<\/span>\n    \"success\"<\/span>:<\/span> false<\/span>,<\/span>\n    \"reason\"<\/span>:<\/span> \"Count must be less than 100, but got: 500\"<\/span>,<\/span>\n    \"status\"<\/span>:<\/span> 400<\/span>,<\/span>\n    \"code\"<\/span>:<\/span> 1<\/span>,<\/span>\n    \"subcode\"<\/span>:<\/span> 7<\/span>,<\/span>\n    \"trace\"<\/span>:<\/span> \"4a076440-f132-4fbf-81bf-8f4d2eefa4c7\"<\/span>\n}<\/span>\n<\/pre>\n<\/div>\n<\/div>\n<\/div>\n","protected":false},"excerpt":{"rendered":"
Response Structure<\/a>
\nResponses from resources are formatted as JSON<\/a> objects. The exact structure of the
\nresponse object will vary depending on the resource, parameters, and request
\ntype. Additional details on the exact structure of a response can be found in
\nthe sections below and on the Request Types<\/a> page.<\/p>\n
Caching<\/a>
\nThe data returned by queries is not cached, metadata used for determining
\naccess rights and site properties is cached for less than ten seconds.
\nThis means that if a photo has it\u2019s visibility changed from me to all,
\nit is possible that a request made by another member within ten seconds of the
\nchange will not include the photo in the response.
\nOn the other hand, an update to a blog post\u2019s title will be seen immediately by
\nthe next request.<\/p>\n
Successful Response<\/a><\/p>\n
Read responses<\/a>
\nThere are 3 types of responses you can get from a successful READ request:
\nsingle item, multi-item, and list<\/p>\n
Single Item Response<\/a>
\nSingle item requests are requests for a specific content item by it\u2019s ID. The
\nresponse contains two properties: success and entry. Success will be true and
\nentry will contain …<\/p>\n","protected":false},"author":20,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":[],"yoast_head":"\n\n\n\n\n\n\n\n\n\n\n\n\t\n