Skip to content

Instantly share code, notes, and snippets.

@francis-gmail

francis-gmail/docs

Last active August 29, 2015 14:21
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save francis-gmail/a1eb7de7d66da215306a to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save francis-gmail/a1eb7de7d66da215306a to your computer and use it in GitHub Desktop.
Download ZIP
Docs
Raw
docs
This contains all the Subject API methods<br>
<h1>SUBJECT</h1>
<table cellspacing="5">
<thead>
<tr>
<th>HTTP Verb</th>
<th>API URL</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>GET|HEAD</td>
<td><a href="#index">/subject</a></td>
<td>Gets lists of subjects</td>
</tr>
<tr>
<td>&nbsp;POST<span>&nbsp;&nbsp; &nbsp;</span></td>
<td>&nbsp;<a href="#store">/subject</a></td>
<td>&nbsp;Insert subject</td>
</tr>
<tr>
<td>&nbsp;PUT<span>&nbsp;&nbsp; &nbsp;</span></td>
<td>&nbsp;<a href="#update">/subject/{id}</a></td>
<td>&nbsp;Update subject</td>
</tr>
</tbody>
</table>
<br>
<a name="index"></a>
<h1>GET/HEAD /subject</h1>
<h3>Gets lists of subjects</h3>
<table cellspacing="0" style="border:1px solid rgb(160,160,160)">
<thead>
<tr>
<th style="background:none repeat scroll 0% 0% rgb(211,211,211);text-align:center;width:200px;height:17px">PARAMETERS</th>
<th style="background:none repeat scroll 0% 0% rgb(211,211,211);text-align:center;width:200px;height:17px">DATA TYPE</th>
<th style="background:none repeat scroll 0% 0% rgb(211,211,211);text-align:center;width:200px;height:17px">REQUIRED?</th>
</tr>
</thead>
<tbody>
<tr>
<td style="width:200px;height:17px;text-align:center">offset</td>
<td style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">int</td>
<td style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">N</td>
</tr>
<tr>
<td style="border-top:1px solid rgb(128,128,128);text-align:center">limit</td>
<td style="border-top:1px solid rgb(128,128,128);border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">int</td>
<td style="border-top:1px solid rgb(128,128,128);border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">N</td>
</tr>
<tr>
<td style="border-top:1px solid rgb(128,128,128);text-align:center">name</td>
<td style="border-top:1px solid rgb(128,128,128);border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">string</td>
<td style="border-top:1px solid rgb(128,128,128);border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">N</td>
</tr>
</tbody>
</table>
<br>
<table cellspacing="0" style="border:1px solid rgb(160,160,160);text-align:center">
<tbody>
<tr>
<th colspan="2" style="background:none repeat scroll 0% 0% rgb(211,211,211);text-align:center;width:418px;height:17px">OUTPUT</th>
</tr>
<tr>
<td align="center" style="border-top:1px solid rgb(128,128,128);width:200px;height:17px"><b>Header</b></td>
<td align="center" style="border-top:1px solid rgb(128,128,128);border-left:1px solid rgb(128,128,128);width:200px;height:17px"><b>Body</b></td>
</tr>
<tr>
<td align="center" style="border-top:1px solid rgb(128,128,128);width:200px;height:17px"></td>
<td align="center" style="border-top:1px solid rgb(128,128,128);border-left:1px solid rgb(128,128,128);width:200px;height:17px">total</td>
</tr>
<tr>
<td align="center" style="border-top:1px solid rgb(128,128,128);width:200px;height:17px">&nbsp;</td>
<td align="center" style="border-top:1px solid rgb(128,128,128);border-left:1px solid rgb(128,128,128);width:200px;height:17px">records&nbsp;</td>
</tr>
</tbody>
</table>
<br/>
<table cellspacing="0" style="font-size:13.3333330154419px;border:1px solid rgb(160,160,160);text-align:center">
<tbody>
<tr>
<th colspan="2" style="text-align:center;width:418px;height:17px;background-image:none;background-color:rgb(211,211,211)">ERROR</th>
</tr>
<tr>
<td align="center" style="width:200px;height:17px"><b>Header</b></td>
<td align="center" style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px"><b>Body</b></td>
</tr>
<tr>
<td align="center" style="border-top-width:1px;border-top-style:solid;border-top-color:rgb(128,128,128);width:200px;height:17px"></td>
<td align="center" style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);border-top-width:1px;border-top-style:solid;border-top-color:rgb(128,128,128);width:200px;height:17px">Errors</td>
</tr>
</tbody>
</table>
<br>
<table cellspacing="0" style="border:1px solid rgb(160,160,160);text-align:center">
<tbody>
<tr>
<th colspan="2" style="background:none repeat scroll 0% 0% rgb(211,211,211);text-align:center;width:624px;height:17px">SAMPLE REQUESTS</th>
</tr>
<tr>
<td align="center" style="width:200px;height:17px">Sample API URL</td>
<td style="border-left:1px solid rgb(128,128,128);text-align:left;width:424px;height:17px">http://dev.futureed.nerubia.com/api/v1/subject?offset=0&amp;limit=2&amp;name=math</td>
</tr>
<tr>
<td align="center" style="border-top:1px solid rgb(128,128,128);width:200px;height:34px">Sample Data Parameters</td>
<td style="border-left:1px solid rgb(128,128,128);border-top:1px solid rgb(128,128,128);width:424px;height:34px">
<div style="text-align:left"><span style="font-size:13.3333330154419px">name=math</span></div>
<div style="text-align:left"><span style="font-size:13.3333330154419px">offset=0</span></div>
<div style="text-align:left"><span style="font-size:13.3333330154419px">limit=2</span></div>
</td>
</tr>
<tr>
<td align="center" style="border-top:1px solid rgb(128,128,128);width:200px;height:129px">Sample Output</td>
<td style="border-left:1px solid rgb(128,128,128);border-top:1px solid rgb(128,128,128);width:424px;height:129px">
<div style="text-align:left">
<pre>
{
"status": 200,
"data": {
"total": 1,
"records": [
{
"id": 2,
"code": null,
"name": "Math",
"description": "Math",
"status": "Enabled"
}
]
}
}
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<br>
<a name="store"></a>
<h1>POST /subject</h1>
<h3>Insert subject</h3>
<table cellspacing="0" style="font-size:1em;line-height:1.5;border:1px solid rgb(160,160,160);background-color:transparent">
<tbody>
<tr>
<th style="text-align:center;width:200px;height:17px;background-image:none;background-color:rgb(211,211,211)">PARAMETERS</th>
<th style="text-align:center;width:200px;height:17px;background-image:none;background-color:rgb(211,211,211)">DATA TYPE</th>
<th style="text-align:center;width:200px;height:17px;background-image:none;background-color:rgb(211,211,211)">REQUIRED?</th>
</tr>
<tr>
<td style="width:200px;height:17px;text-align:center">code</td>
<td style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">int</td>
<td style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">Y</td>
</tr>
<tr>
<td style="border-top:1px solid rgb(128,128,128);width:200px;height:17px;text-align:center">name</td>
<td style="border-top:1px solid rgb(128,128,128);border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">string</td>
<td style="border-top:1px solid rgb(128,128,128);border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">Y</td>
</tr>
<tr>
<td style="border-top:1px solid rgb(128,128,128);width:200px;height:17px;text-align:center">description</td>
<td style="border-top:1px solid rgb(128,128,128);border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">string</td>
<td style="border-top:1px solid rgb(128,128,128);border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">N</td>
</tr>
<tr>
<td style="border-top:1px solid rgb(128,128,128);width:200px;height:17px;text-align:center">status</td>
<td style="border-top:1px solid rgb(128,128,128);border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">string</td>
<td style="border-top:1px solid rgb(128,128,128);border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">Y</td>
</tr>
</tbody>
</table>
<br>
<table cellspacing="0" style="border:1px solid rgb(160,160,160);text-align:center">
<tbody>
<tr>
<th colspan="2" style="background:none repeat scroll 0% 0% rgb(211,211,211);text-align:center;width:418px;height:17px">OUTPUT</th>
</tr>
<tr>
<td align="center" style="width:200px;height:17px"><b>Header</b></td>
<td align="center" style="border-left:1px solid rgb(128,128,128);width:200px;height:17px"><b>Body</b></td>
</tr>
<tr>
<td align="center" style="border-top:1px solid rgb(128,128,128);width:200px;height:17px"></td>
<td align="center" style="border-left:1px solid rgb(128,128,128);border-top:1px solid rgb(128,128,128);width:200px;height:17px">id</td>
</tr>
</tbody>
</table>
<br/>
<table cellspacing="0" style="font-size:13.3333330154419px;border:1px solid rgb(160,160,160);text-align:center">
<tbody>
<tr>
<th colspan="2" style="text-align:center;width:418px;height:17px;background-image:none;background-color:rgb(211,211,211)">ERROR</th>
</tr>
<tr>
<td align="center" style="width:200px;height:17px"><b>Header</b></td>
<td align="center" style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px"><b>Body</b></td>
</tr>
<tr>
<td align="center" style="border-top-width:1px;border-top-style:solid;border-top-color:rgb(128,128,128);width:200px;height:17px"></td>
<td align="center" style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);border-top-width:1px;border-top-style:solid;border-top-color:rgb(128,128,128);width:200px;height:17px">Errors</td>
</tr>
</tbody>
</table>
<br>
<table cellspacing="0" style="border:1px solid rgb(160,160,160);text-align:center">
<tbody>
<tr>
<th colspan="2" style="background:none repeat scroll 0% 0% rgb(211,211,211);text-align:center;width:624px;height:17px">SAMPLE REQUESTS</th>
</tr>
<tr>
<td align="center" style="width:200px;height:17px">Sample API URL</td>
<td style="border-left:1px solid rgb(128,128,128);text-align:left;width:424px;height:17px">http://dev.futureed.nerubia.com/api/v1/subject</td>
</tr>
<tr>
<td align="center" style="border-top:1px solid rgb(128,128,128);width:200px;height:34px">Sample Data Parameters</td>
<td style="border-left:1px solid rgb(128,128,128);border-top:1px solid rgb(128,128,128);width:424px;height:34px">
<div style="text-align:left"><span style="text-align:center;background-color:transparent">code</span><span style="font-size:13.3333330154419px">=</span><span style="text-align:center;background-color:transparent">999</span></div>
<div style="text-align:left"><span style="text-align:center;background-color:transparent">name</span><span style="font-size:13.3333330154419px">=</span><span style="text-align:center;background-color:transparent">Music</span></div>
<div style="text-align:left"><span style="text-align:center;background-color:transparent">status</span><span style="font-size:13.3333330154419px">=</span><span style="text-align:center;background-color:transparent">Enabled</span></div>
<div style="text-align:left"><span style="text-align:center;background-color:transparent">description=</span><span style="font-size:13.3333330154419px;text-align:center;line-height:1.5;background-color:transparent">&nbsp;Music</span></div>
</td>
</tr>
<tr>
<td align="center" style="border-top:1px solid rgb(128,128,128);width:200px;height:129px">Sample Output</td>
<td style="border-left:1px solid rgb(128,128,128);border-top:1px solid rgb(128,128,128);width:424px;height:129px">
<div style="text-align:left">
<pre>
{
"status": 200,
"data": {
"id": 12
}
}
</pre>
</div>
</td>
</tr>
</tbody>
</table>
<a name="update"></a>
<h1>PUT /subject/{id}</h1>
<h3>Update subject</h3>
<table cellspacing="0" style="font-size:1em;line-height:1.5;border:1px solid rgb(160,160,160);background-color:transparent">
<tbody>
<tr>
<th style="text-align:center;width:200px;height:17px;background-image:none;background-color:rgb(211,211,211)">PARAMETERS</th>
<th style="text-align:center;width:200px;height:17px;background-image:none;background-color:rgb(211,211,211)">DATA TYPE</th>
<th style="text-align:center;width:200px;height:17px;background-image:none;background-color:rgb(211,211,211)">REQUIRED?</th>
</tr>
<tr>
<td style="width:200px;height:17px;text-align:center">name</td>
<td style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">string</td>
<td style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">Y</td>
</tr>
<tr>
<td style="border-top:1px solid rgb(128,128,128);width:200px;height:17px;text-align:center">description</td>
<td style="border-top:1px solid rgb(128,128,128);border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">string</td>
<td style="border-top:1px solid rgb(128,128,128);border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">N</td>
</tr>
<tr>
<td style="border-top:1px solid rgb(128,128,128);width:200px;height:17px;text-align:center">status</td>
<td style="border-top:1px solid rgb(128,128,128);border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">string</td>
<td style="border-top:1px solid rgb(128,128,128);border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px;text-align:center">Y</td>
</tr>
</tbody>
</table>
<br>
<table cellspacing="0" style="border:1px solid rgb(160,160,160);text-align:center">
<tbody>
<tr>
<th colspan="2" style="text-align:center;width:418px;height:17px;background-image:none;background-color:rgb(211,211,211)">OUTPUT</th>
</tr>
<tr>
<td align="center" style="width:200px;height:17px"><b>Header</b></td>
<td align="center" style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px"><b>Body</b></td>
</tr>
<tr>
<td align="center" style="border-top-width:1px;border-top-style:solid;border-top-color:rgb(128,128,128);width:200px;height:17px"></td>
<td align="center" style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);border-top-width:1px;border-top-style:solid;border-top-color:rgb(128,128,128);width:200px;height:17px">id</td>
</tr>
</tbody>
</table>
<br/>
<table cellspacing="0" style="font-size:13.3333330154419px;border:1px solid rgb(160,160,160);text-align:center">
<tbody>
<tr>
<th colspan="2" style="text-align:center;width:418px;height:17px;background-image:none;background-color:rgb(211,211,211)">ERROR</th>
</tr>
<tr>
<td align="center" style="width:200px;height:17px"><b>Header</b></td>
<td align="center" style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);width:200px;height:17px"><b>Body</b></td>
</tr>
<tr>
<td align="center" style="border-top-width:1px;border-top-style:solid;border-top-color:rgb(128,128,128);width:200px;height:17px"></td>
<td align="center" style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);border-top-width:1px;border-top-style:solid;border-top-color:rgb(128,128,128);width:200px;height:17px">Errors</td>
</tr>
</tbody>
</table>
<br>
<table cellspacing="0" style="border:1px solid rgb(160,160,160);text-align:center">
<tbody>
<tr>
<th colspan="2" style="text-align:center;width:624px;height:17px;background-image:none;background-color:rgb(211,211,211)">SAMPLE REQUESTS</th>
</tr>
<tr>
<td align="center" style="width:200px;height:17px">Sample API URL</td>
<td style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);text-align:left;width:424px;height:17px">http://dev.futureed.nerubia.com/api/v1/subject/12</td>
</tr>
<tr>
<td align="center" style="border-top-width:1px;border-top-style:solid;border-top-color:rgb(128,128,128);width:200px;height:34px">Sample Data Parameters</td>
<td style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);border-top-width:1px;border-top-style:solid;border-top-color:rgb(128,128,128);width:424px;height:34px">
<div style="text-align:left"><span style="text-align:center;background-color:transparent">code</span><span style="font-size:13.3333330154419px">=</span><span style="text-align:center;background-color:transparent">999</span></div>
<div style="text-align:left"><span style="text-align:center;background-color:transparent">name</span><span style="font-size:13.3333330154419px">=</span><span style="text-align:center;background-color:transparent">Music</span></div>
<div style="text-align:left"><span style="text-align:center;background-color:transparent">status</span><span style="font-size:13.3333330154419px">=</span><span style="text-align:center;background-color:transparent">Enabled</span></div>
<div style="text-align:left"><span style="text-align:center;background-color:transparent">description=</span><span style="font-size:13.3333330154419px;text-align:center;line-height:1.5;background-color:transparent">&nbsp;Music</span></div>
</td>
</tr>
<tr>
<td align="center" style="border-top-width:1px;border-top-style:solid;border-top-color:rgb(128,128,128);width:200px;height:129px">Sample Output</td>
<td style="border-left-width:1px;border-left-style:solid;border-left-color:rgb(128,128,128);border-top-width:1px;border-top-style:solid;border-top-color:rgb(128,128,128);width:424px;height:129px">
<div style="text-align:left">
<pre>
{
"status": 200,
"data": {
"id": 12
}
}
</pre>
</div>
</td>
</tr>
</tbody>
</table>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment