{"_id":"54457e7b0a8dbc1a00ff6a69","__v":5,"hidden":false,"link_url":"","updates":[],"version":"54457e7b0a8dbc1a00ff6a65","type":"basic","createdAt":"2014-10-08T07:47:28.316Z","githubsync":"","link_external":false,"order":0,"slug":"getting-started","sync_unique":"","user":"5434ebf5adf50e0800b88bb3","is_link":false,"project":"5434ec103513400800a13ff7","api":{"auth":"never","basic_auth":false,"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"Success"},{"code":"{}","name":"Failure","language":"json"}]},"try":true,"url":""},"body":"Need help? Join channel #strimoid @ Freenode and ask ;)\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Source code\",\n  \"body\": \"If you are not afraid of PHP, you can just [dig into Strimoid source code](https://github.com/Strimoid/Strimoid)\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Feedback\",\n  \"body\": \"Something doesn't work? Something could be improved? Let us know, we are always willing to help!\"\n}\n[/block]","category":"54457e7b0a8dbc1a00ff6a66","excerpt":"This page will help you get started with Strimoid. You'll be up and running in a jiffy!","title":"Getting Started with Strimoid","childrenPages":[]}

Getting Started with Strimoid

This page will help you get started with Strimoid. You'll be up and running in a jiffy!

Need help? Join channel #strimoid @ Freenode and ask ;) [block:callout] { "type": "info", "title": "Source code", "body": "If you are not afraid of PHP, you can just [dig into Strimoid source code](https://github.com/Strimoid/Strimoid)" } [/block] [block:callout] { "type": "info", "title": "Feedback", "body": "Something doesn't work? Something could be improved? Let us know, we are always willing to help!" } [/block]
Need help? Join channel #strimoid @ Freenode and ask ;) [block:callout] { "type": "info", "title": "Source code", "body": "If you are not afraid of PHP, you can just [dig into Strimoid source code](https://github.com/Strimoid/Strimoid)" } [/block] [block:callout] { "type": "info", "title": "Feedback", "body": "Something doesn't work? Something could be improved? Let us know, we are always willing to help!" } [/block]
{"_id":"54457e7b0a8dbc1a00ff6a6a","__v":0,"category":"54457e7b0a8dbc1a00ff6a66","api":{"params":[],"url":"","auth":"never","results":{"codes":[{"language":"json","code":"{}","name":"Success"},{"name":"Failure","language":"json","code":"{}"}]},"basic_auth":false,"try":true},"body":"Please use OAuth 2.0 or HTTP Basic Auth. We think that writing another one OAuth guide would be waste of time, so if you need it, just use existing one, eg. https://developer.github.com/v3/oauth/\n\nRemember to use correct endpoint URLs:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"Access Token URL\",\n    \"0-1\": \"https://strimoid.pl/oauth2/token\",\n    \"1-1\": \"https://strimoid.pl/oauth2/authorize\",\n    \"1-0\": \"Authorization URL\"\n  },\n  \"cols\": 2,\n  \"rows\": 2\n}\n[/block]","createdAt":"2014-10-19T21:22:11.891Z","githubsync":"","order":1,"excerpt":"Using OAuth 2.0 or Basic Auth","link_url":"","type":"basic","is_link":false,"project":"5434ec103513400800a13ff7","slug":"test","sync_unique":"","title":"Authorization","updates":[],"user":"5434ebf5adf50e0800b88bb3","version":"54457e7b0a8dbc1a00ff6a65","childrenPages":[]}

Authorization

Using OAuth 2.0 or Basic Auth

Please use OAuth 2.0 or HTTP Basic Auth. We think that writing another one OAuth guide would be waste of time, so if you need it, just use existing one, eg. https://developer.github.com/v3/oauth/ Remember to use correct endpoint URLs: [block:parameters] { "data": { "0-0": "Access Token URL", "0-1": "https://strimoid.pl/oauth2/token", "1-1": "https://strimoid.pl/oauth2/authorize", "1-0": "Authorization URL" }, "cols": 2, "rows": 2 } [/block]
Please use OAuth 2.0 or HTTP Basic Auth. We think that writing another one OAuth guide would be waste of time, so if you need it, just use existing one, eg. https://developer.github.com/v3/oauth/ Remember to use correct endpoint URLs: [block:parameters] { "data": { "0-0": "Access Token URL", "0-1": "https://strimoid.pl/oauth2/token", "1-1": "https://strimoid.pl/oauth2/authorize", "1-0": "Authorization URL" }, "cols": 2, "rows": 2 } [/block]
{"_id":"54651f1a5871e90800f5030f","slug":"error-codes","sync_unique":"","__v":2,"body":"Not ready yet!\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Hint\",\n  \"body\": \"If response code is not 2xx, then probably something went wrong.\"\n}\n[/block]","createdAt":"2014-11-13T21:14:02.909Z","githubsync":"","link_external":false,"link_url":"","title":"Error codes","type":"basic","updates":[],"hidden":false,"is_link":false,"version":"54457e7b0a8dbc1a00ff6a65","api":{"url":"","auth":"never","basic_auth":false,"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"try":true},"excerpt":"","project":"5434ec103513400800a13ff7","user":"5434ebf5adf50e0800b88bb3","category":"54457e7b0a8dbc1a00ff6a66","order":999,"childrenPages":[]}

Error codes


Not ready yet! [block:callout] { "type": "info", "title": "Hint", "body": "If response code is not 2xx, then probably something went wrong." } [/block]
Not ready yet! [block:callout] { "type": "info", "title": "Hint", "body": "If response code is not 2xx, then probably something went wrong." } [/block]
{"_id":"544ebc72698ab40800b4ef08","category":"544949043acc37080099e71f","is_link":false,"link_external":false,"updates":[],"version":"54457e7b0a8dbc1a00ff6a65","body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","editedParams2":true,"githubsync":"","hidden":false,"order":999,"type":"get","user":"5434ebf5adf50e0800b88bb3","__v":1,"api":{"auth":"never","basic_auth":false,"method":"get","params":[{"in":"query","_id":"544ebc72698ab40800b4ef09","required":false,"desc":"Filter by group","default":"","type":"string","name":"group"},{"type":"string","name":"folder","in":"query","_id":"54f6fbf41b14363500102149","required":false,"desc":"Filter by folder","default":""},{"_id":"54f6fbf41b14363500102148","required":false,"desc":"Comments per page (min: 1, max: 100)","default":"25","type":"int","name":"per_page","in":"query"}],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"try":true,"url":"/comments"},"createdAt":"2014-10-27T21:43:14.938Z","slug":"list-of-comments","title":"List of comments","editedParams":true,"excerpt":"","link_url":"","project":"5434ec103513400800a13ff7","sync_unique":"","childrenPages":[]}

getList of comments


Query Params

group:
string
Filter by group
folder:
string
Filter by folder
per_page:
integer25
Comments per page (min: 1, max: 100)
[block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



[block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"54f6f99e543685210097148d","hidden":false,"api":{"method":"post","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"url":"","auth":"required"},"createdAt":"2015-03-04T12:25:02.484Z","excerpt":"","category":"544949043acc37080099e71f","order":999,"slug":"create-new-comment","link_external":false,"link_url":"","project":"5434ec103513400800a13ff7","user":"5434ebf5adf50e0800b88bb3","__v":1,"body":"","githubsync":"","type":"post","updates":[],"version":"54457e7b0a8dbc1a00ff6a65","sync_unique":"","title":"Create new comment","childrenPages":[]}

postCreate new comment


{"_id":"54457e7b0a8dbc1a00ff6a68","editedParams":true,"excerpt":"","is_link":false,"title":"List of contents","updates":[],"version":"54457e7b0a8dbc1a00ff6a65","__v":4,"api":{"method":"get","params":[{"default":"all","type":"string","name":"group","in":"query","_id":"544586aea21e4d140055dcb6","required":false,"desc":"Filter by group"},{"required":false,"desc":"Filter by folder","default":"","type":"string","name":"folder","in":"query","_id":"544ebc9a698ab40800b4ef0b"},{"name":"user","in":"query","_id":"544ebc84cf9f860800800d28","required":false,"desc":"Filter by user","default":"","type":"string"},{"desc":"[created_at|frontpage_at|comments|score]","default":"created_at","type":"string","name":"sort","in":"query","_id":"544aa283bb58010800710b66","required":false}],"results":{"codes":[{"name":"Success","code":"{\n    total: 18677,\n    per_page: 20,\n    current_page: 1,\n    last_page: 934,\n    from: 1,\n    to: 20,\n    data: [{\n        _id: \"81hYdK\",\n        uv: 1,\n        dv: 0,\n        score: 1,\n        comments: 0,\n        title: \"Zbiór samolotów z czasów II WŚ przechwyconych i przemalowanych przez siły powietrzne wroga.\",\n        description: \"Są takie perełki jak np. przemalowany niemiecki Spitfire, B17 czy japoński Hurricane. \",\n        nsfw: false,\n        eng: false,\n        url: \"https://imgur.com/a/9hxDQ\",\n        domain: \"imgur.com\",\n        user_id: \"wysuszony\",\n        group_id: \"Historia\",\n        created_at: \"2014-10-23 22:13:28\",\n        thumbnail: \"9tzCfJf72.png\",\n        votes: [{\n            user_id: \"Volkh\",\n            created_at: {\n                sec: 1414095814,\n                usec: 563000\n            },\n            up: true\n        }],\n        vote_state: \"none\",\n        user: {\n            _id: \"wysuszony\",\n            avatar: \"EnuWPNvm.png\",\n            name: \"wysuszony\"\n        },\n        group: {\n            _id: \"Historia\",\n            created_at: \"2013-10-18 18:40:46\",\n            creator_id: \"Herschel\",\n            description: \"Historia to matka wszelkich nauk. Tutaj dowiecie się wszelkiej maści ciekawostek z życia naszych dziadów.\",\n            name: \"Historia\",\n            subscribers: 67,\n            avatar: \"mH1fNQBO.png\"\n        }\n    }]\n}","language":"json","status":200},{"name":"Failure","code":"{}","language":"json"}]},"try":true,"url":"/contents","auth":"never","basic_auth":false},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('https://strimoid.pl/api/v1/contents' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","order":0,"sync_unique":"","category":"544583250a8dbc1a00ff6a6c","createdAt":"2014-10-20T00:34:00.141Z","githubsync":"","link_url":"","slug":"contents","editedParams2":true,"project":"5434ec103513400800a13ff7","type":"get","user":"5434ebf5adf50e0800b88bb3","childrenPages":[]}

getList of contents


Query Params

group:
stringall
Filter by group
folder:
string
Filter by folder
user:
string
Filter by user
sort:
stringcreated_at
[created_at|frontpage_at|comments|score]
Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('https://strimoid.pl/api/v1/contents' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('https://strimoid.pl/api/v1/contents' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"54458519a21e4d140055dcab","api":{"try":true,"url":"/contents/:id","auth":"never","basic_auth":false,"method":"get","params":[{"desc":"Content ID","default":"","type":"string","name":"id","in":"path","_id":"544962e5cdc94422004885c4","required":true}],"results":{"codes":[{"language":"json","code":"{}","name":"Success"},{"language":"json","code":"{}","name":"Failure"}]}},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","project":"5434ec103513400800a13ff7","type":"get","user":"5434ebf5adf50e0800b88bb3","version":"54457e7b0a8dbc1a00ff6a65","updates":[],"__v":8,"category":"544583250a8dbc1a00ff6a6c","link_url":"","order":1,"slug":"contentid","sync_unique":"","createdAt":"2014-10-20T21:56:41.018Z","editedParams":true,"excerpt":"","githubsync":"","is_link":false,"editedParams2":true,"title":"Get a content data","childrenPages":[]}

getGet a content data


Path Params

id:
required
string
Content ID
Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"544586d2a21e4d140055dcb8","is_link":false,"link_url":"","sync_unique":"","type":"post","updates":[],"createdAt":"2014-10-20T22:04:02.047Z","hidden":false,"editedParams2":true,"excerpt":"","__v":3,"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","editedParams":true,"slug":"groupsnamecontents","title":"Create new content","user":"5434ebf5adf50e0800b88bb3","version":"54457e7b0a8dbc1a00ff6a65","category":"544583250a8dbc1a00ff6a6c","githubsync":"","project":"5434ec103513400800a13ff7","api":{"try":true,"url":"/contents","auth":"required","basic_auth":true,"method":"post","params":[{"name":"title","in":"body","_id":"5445893a0a8dbc1a00ff6a8e","required":true,"desc":"max: 128 chars","default":"","type":"string"},{"name":"description","in":"body","_id":"5445893a0a8dbc1a00ff6a8d","required":false,"desc":"max: 255 chars","default":"","type":"string"},{"name":"group","in":"body","_id":"545fe2fd1604950800a0141f","required":true,"desc":"","default":"","type":"string"}],"results":{"codes":[{"language":"json","code":"{}","name":"Success"},{"language":"json","code":"{}","name":"Failure"}]}},"order":2,"childrenPages":[]}

postCreate new content


Body Params

title:
required
string
max: 128 chars
description:
string
max: 255 chars
group:
required
string
Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"54458963a21e4d140055dcc7","body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","sync_unique":"","type":"patch","updates":[],"user":"5434ebf5adf50e0800b88bb3","__v":4,"excerpt":"","title":"Update content","version":"54457e7b0a8dbc1a00ff6a65","category":"544583250a8dbc1a00ff6a6c","createdAt":"2014-10-20T22:14:59.774Z","is_link":false,"link_url":"","project":"5434ec103513400800a13ff7","api":{"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"Success"},{"language":"json","code":"{}","name":"Failure"}]},"try":true,"url":"/contents/:id","auth":"never","basic_auth":false,"method":"patch"},"githubsync":"","order":3,"slug":"contentsid","childrenPages":[]}

patchUpdate content


Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"544589fe0a8dbc1a00ff6a8f","api":{"basic_auth":false,"method":"delete","params":[{"desc":"Content ID","default":"","type":"string","name":"id","in":"path","_id":"544ebcbd698ab40800b4ef0e","required":true}],"results":{"codes":[{"status":204,"language":"http","code":"","name":"Success"},{"language":"json","code":"{}","name":"Failure"}]},"try":true,"url":"/contents/:id","auth":"never"},"editedParams":true,"slug":"contentsid-1","sync_unique":"","title":"Delete content","type":"delete","category":"544583250a8dbc1a00ff6a6c","createdAt":"2014-10-20T22:17:34.843Z","is_link":false,"version":"54457e7b0a8dbc1a00ff6a65","__v":3,"editedParams2":true,"project":"5434ec103513400800a13ff7","body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","excerpt":"","githubsync":"","link_url":"","order":4,"updates":[],"user":"5434ebf5adf50e0800b88bb3","childrenPages":[]}

deleteDelete content


Path Params

id:
required
string
Content ID
Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}


Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"5456a5d8f037df08000355b8","excerpt":"","project":"5434ec103513400800a13ff7","sync_unique":"","title":"List of entries","__v":0,"category":"5456a5bdf7974c080018afed","editedParams":true,"editedParams2":true,"type":"get","version":"54457e7b0a8dbc1a00ff6a65","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"try":true,"url":"/entries","auth":"never","basic_auth":false,"method":"get","params":[{"type":"string","name":"group","in":"query","_id":"5456a5d8f037df08000355b9","required":false,"desc":"Filter by group","default":""}]},"createdAt":"2014-11-02T21:44:56.879Z","order":999,"updates":[],"user":"5434ebf5adf50e0800b88bb3","body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","githubsync":"","is_link":false,"link_url":"","slug":"list-of-entries","childrenPages":[]}

getList of entries


Query Params

group:
string
Filter by group
Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"5456ab61f7974c080018aff4","title":"Create new entry","type":"post","version":"54457e7b0a8dbc1a00ff6a65","api":{"auth":"never","basic_auth":false,"method":"post","params":[{"_id":"5456ab61f7974c080018aff6","required":true,"desc":"Markdown formatted text","default":"","type":"string","name":"text","in":"body"},{"_id":"5456ab61f7974c080018aff5","required":true,"desc":"Name of group where entry shall be added","default":"","type":"string","name":"group","in":"body"}],"results":{"codes":[{"code":"{\n    \"status\": \"ok\",\n    \"entry\": {\n        \"uv\": 0,\n        \"dv\": 0,\n        \"_id\": \"07SaTZ\",\n        \"text\": \"<p>test<\\/p>\",\n        \"created_at\": \"2014-11-03 01:25:34\",\n        \"vote_state\": \"none\",\n        \"user\": {\n            \"_id\": \"duxet\",\n            \"age\": \"\",\n            \"avatar\": \"47M2TeJH.png\",\n            \"created_at\": \"2013-10-17 19:41:50\",\n            \"description\": \"Lorem ipsum kartoflum\",\n            \"location\": \"Internet\",\n            \"name\": \"duxet\",\n            \"sex\": \"male\"\n        },\n        \"group\": {\n            \"_id\": \"testujemy\",\n            \"created_at\": \"2013-10-15 01:55:09\",\n            \"description\": \"\",\n            \"name\": \"Testowanie projektu\",\n            \"subscribers\": 5\n        }\n    }\n}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"try":true,"url":"/entry"},"category":"5456a5bdf7974c080018afed","excerpt":"","project":"5434ec103513400800a13ff7","sync_unique":"","__v":0,"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","createdAt":"2014-11-02T22:08:33.196Z","editedParams":true,"user":"5434ebf5adf50e0800b88bb3","order":999,"slug":"create-new-entry","updates":[],"editedParams2":true,"githubsync":"","is_link":false,"link_url":"","childrenPages":[]}

postCreate new entry


Body Params

text:
required
string
Markdown formatted text
group:
required
string
Name of group where entry shall be added
Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"5456ab98f037df08000355c6","category":"5456a5bdf7974c080018afed","order":999,"project":"5434ec103513400800a13ff7","sync_unique":"","body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","createdAt":"2014-11-02T22:09:28.515Z","link_url":"","type":"post","user":"5434ebf5adf50e0800b88bb3","__v":0,"editedParams2":true,"githubsync":"","slug":"create-new-reply","updates":[],"editedParams":true,"excerpt":"","is_link":false,"title":"Create new reply","version":"54457e7b0a8dbc1a00ff6a65","api":{"url":"/entries/:id/replies","auth":"never","basic_auth":false,"method":"post","params":[{"type":"string","name":"text","in":"body","_id":"5456ab98f037df08000355c7","required":true,"desc":"Markdown formatted text","default":""}],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"try":true},"childrenPages":[]}

postCreate new reply


Body Params

text:
required
string
Markdown formatted text
Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"54458344a21e4d140055dc9f","version":"54457e7b0a8dbc1a00ff6a65","is_link":false,"order":0,"slug":"groups","sync_unique":"","updates":[],"excerpt":"","link_url":"","project":"5434ec103513400800a13ff7","user":"5434ebf5adf50e0800b88bb3","type":"get","api":{"auth":"never","basic_auth":false,"method":"get","params":[],"results":{"codes":[{"name":"Success","language":"json","code":"{}"},{"language":"json","code":"{}","name":"Failure"}]},"try":true,"url":"/groups"},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","category":"54458322a21e4d140055dc9d","githubsync":"","__v":2,"createdAt":"2014-10-20T21:48:52.208Z","title":"List of groups","childrenPages":[]}

getList of groups


Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"54458549a21e4d140055dcad","api":{"method":"get","params":[{"type":"string","name":"id","in":"path","_id":"545013b43c6f700800a9b429","required":true,"desc":"Group ID","default":""}],"results":{"codes":[{"language":"json","code":"{\n    _id: \"Security\",\n    avatar: \"GcMR6IOu.png\",\n    created_at: \"2013-10-28 15:55:43\",\n    description: \"Grupa dotycząca bezpieczeństwa.\",\n    name: \"Bezpieczeństwo\",\n    sidebar: \"Bezpieczeństwo teleinformatyczne to dziedzina telekomunikacji i informatyki, która zajmuje się kontrolą ryzyka związanego z przetwarzaniem informacji w komputerach oraz systemach operacyjnych i aplikacjach, przesyłaniem ich w sieciach teleinformatycznych i przechowywaniem na nośnikach.\",\n    subscribers: 67,\n    creator: {\n        _id: \"ToshioSM\",\n        age: \"\",\n        avatar: \"twGnmkx5.jpg\",\n        created_at: \"2013-10-18 12:46:32\",\n        location: \"\",\n        name: \"ToshioSM\",\n        sex: \"\"\n    },\n    stats: {\n        contents: 297,\n        comments: 248,\n        entries: 54,\n        banned: 7,\n        subscribers: 67,\n        moderators: 4\n    }\n}","name":"Success","status":200},{"code":"{}","name":"Failure","language":"json"}]},"try":true,"url":"/groups/:id","auth":"never","basic_auth":false},"category":"54458322a21e4d140055dc9d","editedParams2":true,"githubsync":"","is_link":false,"link_url":"","__v":2,"version":"54457e7b0a8dbc1a00ff6a65","slug":"groupsname","user":"5434ebf5adf50e0800b88bb3","type":"get","updates":[],"excerpt":"","project":"5434ec103513400800a13ff7","createdAt":"2014-10-20T21:57:29.324Z","order":1,"sync_unique":"","title":"Get a group data","body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","editedParams":true,"childrenPages":[]}

getGet a group data


Path Params

id:
required
string
Group ID
Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"544583b20a8dbc1a00ff6a6e","user":"5434ebf5adf50e0800b88bb3","createdAt":"2014-10-20T21:50:42.312Z","order":0,"title":"List of notifications","updates":[],"__v":4,"api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":"Success"},{"language":"json","code":"{}","name":"Failure"}]},"try":true,"url":"/notifications","auth":"required","basic_auth":true,"method":"get"},"category":"544583a6a21e4d140055dca3","is_link":false,"link_url":"","version":"54457e7b0a8dbc1a00ff6a65","sync_unique":"","type":"get","body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","excerpt":"","githubsync":"","project":"5434ec103513400800a13ff7","slug":"testinput","childrenPages":[]}

getList of notifications


Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"54491d943acc37080099e68a","body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","category":"544583a1a21e4d140055dca2","is_link":false,"sync_unique":"","__v":0,"type":"get","user":"5434ebf5adf50e0800b88bb3","title":"Get ranking","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"try":true,"url":"/ranking","auth":"never","basic_auth":false,"method":"get","params":[]},"createdAt":"2014-10-23T15:24:04.071Z","githubsync":"","link_url":"","order":0,"slug":"get-ranking","updates":[],"project":"5434ec103513400800a13ff7","version":"54457e7b0a8dbc1a00ff6a65","excerpt":"","childrenPages":[]}

getGet ranking


Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"5446b8d2ae0040140035fa04","createdAt":"2014-10-21T19:49:38.247Z","is_link":false,"project":"5434ec103513400800a13ff7","title":"Get a user data","body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","category":"544583a1a21e4d140055dca2","link_url":"","user":"5434ebf5adf50e0800b88bb3","version":"54457e7b0a8dbc1a00ff6a65","githubsync":"","slug":"get-a-user-data","updates":[],"__v":2,"api":{"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"Success"},{"language":"json","code":"{}","name":"Failure"}]},"try":true,"url":"/users/:name","auth":"never","basic_auth":false,"method":"get"},"excerpt":"","order":1,"sync_unique":"","type":"get","childrenPages":[]}

getGet a user data


Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"54538e4408d1800800473d98","category":"54483e55cfb4580800d5e2a1","createdAt":"2014-10-31T13:27:32.426Z","order":999,"type":"post","updates":[],"user":"5434ebf5adf50e0800b88bb3","editedParams":true,"hidden":false,"is_link":false,"link_url":"","sync_unique":"","__v":1,"editedParams2":true,"excerpt":"","githubsync":"","title":"Add vote","api":{"try":true,"url":"/votes","auth":"never","basic_auth":false,"method":"post","params":[{"name":"type","in":"body","_id":"5465173ff42a472000b0c5ff","required":true,"desc":"Object type [content|related|comment|comment_reply|entry|entry_reply]","default":"","type":"string"},{"name":"id","in":"body","_id":"5465173ff42a472000b0c5fe","required":true,"desc":"Object ID","default":"","type":"string"}],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]}},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","project":"5434ec103513400800a13ff7","slug":"add-vote","version":"54457e7b0a8dbc1a00ff6a65","childrenPages":[]}

postAdd vote


Body Params

type:
required
string
Object type [content|related|comment|comment_reply|entry|entry_reply]
id:
required
string
Object ID
Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]
{"_id":"545f6fae344e2b1400339f3d","excerpt":"","updates":[],"api":{"basic_auth":false,"method":"delete","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"try":true,"url":"/votes","auth":"never"},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit.\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"$.get('http://yoursite.com/test/' + id, function(data) {\\n    console.log(data);\\n});\",\n      \"language\": \"javascript\"\n    }\n  ]\n}\n[/block]","order":999,"slug":"remove-vote","type":"delete","category":"54483e55cfb4580800d5e2a1","createdAt":"2014-11-09T13:44:14.157Z","githubsync":"","title":"Remove vote","hidden":false,"link_url":"","sync_unique":"","user":"5434ebf5adf50e0800b88bb3","version":"54457e7b0a8dbc1a00ff6a65","__v":1,"is_link":false,"project":"5434ec103513400800a13ff7","childrenPages":[]}

deleteRemove vote


Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]

Definition

{{ api_url }}{{ page_api_url }}

Result Format



Lorem ipsum dolor sit amet, consectetur adipiscing elit. [block:code] { "codes": [ { "code": "$.get('http://yoursite.com/test/' + id, function(data) {\n console.log(data);\n});", "language": "javascript" } ] } [/block]