{"id":892,"date":"2014-05-03T07:55:12","date_gmt":"2014-05-03T07:55:12","guid":{"rendered":"http:\/\/blog.soton.ac.uk\/orion\/?p=892"},"modified":"2015-04-03T07:57:07","modified_gmt":"2015-04-03T07:57:07","slug":"rest-api","status":"publish","type":"post","link":"https:\/\/blog.soton.ac.uk\/orion\/uncategorized\/rest-api\/","title":{"rendered":"REST API"},"content":{"rendered":"

LeapIn.it uses a REST endpoint for access to the database. This is a design pattern for hypermedia systems, which advocates providing individual resources (e.g., people) with unique URLs, and using those URLs to exchange structured information. HTTP requests can be made to these URLs, where HTTP methods are used to instruct what should happen with attached data, and status codes in responses are used to signal what happened with the data.<\/p>\n

The following URL’s are available:<\/p>\n

Requests are in JSON<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
URL<\/th>\nMethod<\/th>\nDescription<\/th>\n<\/tr>\n
\/api\/auth<\/code><\/td>\n<\/tr>\n
POST<\/code><\/td>\nauthenticate a user<\/td>\n\n
201<\/code> “person with username and password hash have been found”<\/div>\n

the person and a token<\/p>\n

401<\/code> “username or password not found”<\/div>\n<\/td>\n<\/tr>\n
\/api\/auth\/user<\/code><\/td>\n<\/tr>\n
GET<\/code> (params: token)<\/td>\nget the person who is logged in<\/td>\n\n
200<\/code> “person is logged in”<\/div>\n

the person<\/p>\n

404<\/code> “no person is logged in”<\/div>\n<\/td>\n<\/tr>\n
DELETE<\/code> (params: token)<\/td>\ndelete the session (log out)<\/td>\n\n
204<\/code> “session has been deleted”<\/div>\n
404<\/code> “no session exists”<\/div>\n<\/td>\n<\/tr>\n
\/api\/person<\/code><\/td>\n<\/tr>\n
POST<\/code><\/td>\ncreate a person<\/td>\n\n
201<\/code> “person created”<\/div>\n

the person<\/p>\n

401<\/code> “username already exists”<\/div>\n<\/td>\n<\/tr>\n
\/api\/person\/:id<\/code><\/td>\n<\/tr>\n
GET<\/code> (params: token)<\/td>\nget a person<\/td>\n\n
200<\/code> “person exists”<\/div>\n

the person<\/p>\n

401<\/code> “not allowed to see this person”<\/div>\n
404<\/code> “person does not exist”<\/div>\n<\/td>\n<\/tr>\n
PUT<\/code> (params: token)<\/td>\nmodify the person<\/td>\n\n
200<\/code> “person modified”<\/div>\n

the person<\/p>\n

401<\/code> “not allowed to modify this person”<\/div>\n
404<\/code> “person does not exist”<\/div>\n<\/td>\n<\/tr>\n
DELETE<\/code> (params: token)<\/td>\ndelete the person<\/td>\n\n
204<\/code> “person has been deleted”<\/div>\n
401<\/code> “not allowed to delete this person”<\/div>\n
404<\/code> “person does not exist”<\/div>\n<\/td>\n<\/tr>\n
\/api\/person\/:id\/friend\/<\/code><\/td>\n<\/tr>\n
GET<\/code> (params: token)<\/td>\nget a person’s friend list<\/td>\n\n
200<\/code> “person exists”<\/div>\n

the person’s friend list<\/p>\n

401<\/code> “not allowed to see this person’s friend list”<\/div>\n
404<\/code> “person does not exist”<\/div>\n<\/td>\n<\/tr>\n
POST<\/code> (params: token)<\/td>\nadd a new friend to this person<\/td>\n\n
201<\/code> “friend added”<\/div>\n

the new friend<\/p>\n

401<\/code> “not allowed to see this person’s friend list”<\/div>\n
404<\/code> “person does not exist”<\/div>\n<\/td>\n<\/tr>\n
DELETE<\/code> (params: token)<\/td>\ndelete a friend<\/td>\n\n
204<\/code> “friend removed”<\/div>\n
401<\/code> “not allowed to see this person’s friend list”<\/div>\n
404<\/code> “person does not exist”<\/div>\n<\/td>\n<\/tr>\n
\/api\/person\/:id\/block\/<\/code><\/td>\n<\/tr>\n
GET<\/code> (params: token)<\/td>\nget a person’s block list<\/td>\n\n
200<\/code> “person exists”<\/div>\n

the person’s block list<\/p>\n

401<\/code> “not allowed to see this person’s block list”<\/div>\n
404<\/code> “person does not exist”<\/div>\n<\/td>\n<\/tr>\n
POST<\/code> (params: token)<\/td>\nadd a new blocked person to this person<\/td>\n\n
201<\/code> “blocked person added”<\/div>\n

the new blocked person<\/p>\n

401<\/code> “not allowed to see this person’s block list”<\/div>\n
404<\/code> “person does not exist”<\/div>\n<\/td>\n<\/tr>\n
DELETE<\/code> (params: token)<\/td>\nremove a blocked person<\/td>\n\n
204<\/code> “blocked person removed”<\/div>\n
401<\/code> “not allowed to see this person’s block list”<\/div>\n
404<\/code> “person does not exist”<\/div>\n<\/td>\n<\/tr>\n
\/api\/person\/:id\/room\/<\/code><\/td>\n<\/tr>\n
GET<\/code> (params: token)<\/td>\nget a person’s room list<\/td>\n\n
200<\/code> “person exists”<\/div>\n

the person’s room list<\/p>\n

401<\/code> “not allowed to see this person’s room list”<\/div>\n
404<\/code> “person does not exist”<\/div>\n<\/td>\n<\/tr>\n
DELETE<\/code> (params: token)<\/td>\ndelete a room from a person’s room list<\/td>\n\n
204<\/code> “room has been removed from person’s room list”<\/div>\n
401<\/code> “not allowed to see this person’s room list”<\/div>\n
404<\/code> “person does not exist”<\/div>\n<\/td>\n<\/tr>\n
\/api\/person\/:id\/feed\/<\/code><\/td>\n<\/tr>\n
GET<\/code> (params: token)<\/td>\nget a person’s feed<\/td>\n\n
200<\/code> “person exists”<\/div>\n

list of posts in person’s feed<\/p>\n

401<\/code> “not allowed to see this person’s feed”<\/div>\n
404<\/code> “person does not exist”<\/div>\n<\/td>\n<\/tr>\n
\/api\/room\/<\/code><\/td>\n<\/tr>\n
GET<\/code> (params: token, code)<\/td>\nget a room from a specified code and add it to user’s room list<\/td>\n\n
200<\/code> “room exists”<\/div>\n

the room<\/p>\n

201<\/code> “room does not exists, so it has been created”<\/div>\n

the room<\/p>\n<\/td>\n<\/tr>\n

\/api\/room\/:id\/<\/code><\/td>\n<\/tr>\n
GET<\/code> (params: token)<\/td>\nget a room<\/td>\n\n
200<\/code> “room exists”<\/div>\n

the room<\/p>\n

401<\/code> “not allowed to see this room”<\/div>\n
404<\/code> “room does not exist”<\/div>\n<\/td>\n<\/tr>\n
PUT<\/code> (params: token)<\/td>\nchange the name of a room<\/td>\n\n
200<\/code> “room exists”<\/div>\n

the room<\/p>\n

401<\/code> “not allowed to see this room”<\/div>\n
404<\/code> “room does not exist”<\/div>\n<\/td>\n<\/tr>\n
\/api\/room\/:id\/post\/<\/code><\/td>\n<\/tr>\n
GET<\/code> (params: token)<\/td>\nget the posts in a room<\/td>\n\n
200<\/code> “room exists”<\/div>\n

the posts<\/p>\n

401<\/code> “not allowed to see this room”<\/div>\n
404<\/code> “room does not exist”<\/div>\n<\/td>\n<\/tr>\n
POST<\/code> (params: token)<\/td>\ncreate a post in a room<\/td>\n\n
201<\/code> “post created”<\/div>\n

the post<\/p>\n

401<\/code> “not allowed to see this room”<\/div>\n
404<\/code> “room does not exist”<\/div>\n<\/td>\n<\/tr>\n
\/api\/room\/:id\/post\/:id\/<\/code><\/td>\n<\/tr>\n
GET<\/code> (params: token)<\/td>\nget a post belonging to a room<\/td>\n\n
200<\/code> “post exists”<\/div>\n

the post<\/p>\n

401<\/code> “not allowed to see this post”<\/div>\n
404<\/code> “post does not exist”<\/div>\n<\/td>\n<\/tr>\n
\/api\/room\/:id\/post\/:id\/data\/<\/code><\/td>\n<\/tr>\n
GET<\/code> (params: token, preview, size, cell)<\/td>\nget the data (or a preview) attached to a post (eg, a picture)<\/td>\n\n
200<\/code> “data exists”<\/div>\n

the data or a preview<\/p>\n

401<\/code> “not allowed to see this post”<\/div>\n
404<\/code> “post does not exist”<\/div>\n<\/td>\n<\/tr>\n
\/api\/blankcell<\/code><\/td>\n<\/tr>\n
GET<\/code> (params: token, size)<\/td>\ngenerate a blank cell<\/td>\n\n
200<\/code> “ok”<\/div>\n

the blank cell<\/p>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n","protected":false},"excerpt":{"rendered":"

LeapIn.it uses a REST endpoint for access to the database. This is a design pattern for hypermedia systems, which advocates providing individual resources (e.g., people) with unique URLs, and using those URLs to exchange structured information. HTTP requests can be made to these URLs, where HTTP methods are used to instruct what should happen with attached data, and status codes… Read more → <\/a><\/span><\/p>\n","protected":false},"author":94019,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-892","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/blog.soton.ac.uk\/orion\/wp-json\/wp\/v2\/posts\/892","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.soton.ac.uk\/orion\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.soton.ac.uk\/orion\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.soton.ac.uk\/orion\/wp-json\/wp\/v2\/users\/94019"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.soton.ac.uk\/orion\/wp-json\/wp\/v2\/comments?post=892"}],"version-history":[{"count":1,"href":"https:\/\/blog.soton.ac.uk\/orion\/wp-json\/wp\/v2\/posts\/892\/revisions"}],"predecessor-version":[{"id":893,"href":"https:\/\/blog.soton.ac.uk\/orion\/wp-json\/wp\/v2\/posts\/892\/revisions\/893"}],"wp:attachment":[{"href":"https:\/\/blog.soton.ac.uk\/orion\/wp-json\/wp\/v2\/media?parent=892"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.soton.ac.uk\/orion\/wp-json\/wp\/v2\/categories?post=892"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.soton.ac.uk\/orion\/wp-json\/wp\/v2\/tags?post=892"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}