Difference between revisions of "Team:UESTC Software/Documentation.html"
(Created page with "<!DOCTYPE html> <html class="no-js"> <head> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width, initial-scale=1"> <title>Documentation- Requirements</...") |
|||
Line 75: | Line 75: | ||
<div class="cd-main-content"> | <div class="cd-main-content"> | ||
<div class="dou_m_c_p"> | <div class="dou_m_c_p"> | ||
− | <div class="dou_title"> | + | <div class="dou_title dou_table_title"> |
<h2>Service API Documentation</h2> | <h2>Service API Documentation</h2> | ||
<p><i>Developers can reuse the function of our software quickly by use Service API.</i></p> | <p><i>Developers can reuse the function of our software quickly by use Service API.</i></p> | ||
Line 314: | Line 314: | ||
<div class="cd-main-content"> | <div class="cd-main-content"> | ||
<div class="dou_m_c_p"> | <div class="dou_m_c_p"> | ||
− | <div class="dou_title"> | + | <div class="dou_title dou_table_title"> |
<h2>Service Page Documentation</h2> | <h2>Service Page Documentation</h2> | ||
<p><i>Service Page can be visited directly to view the corresponding result.</i></p> | <p><i>Service Page can be visited directly to view the corresponding result.</i></p> |
Revision as of 18:55, 11 September 2015
<!DOCTYPE html>
Documentation
Service API Documentation
Developers can reuse the function of our software quickly by use Service API.
URL | /api/cegRecord/fetchCeg.php |
GET | id |
Return | Result in json style. Status 0 means execute successfuly, and 1 means error. Data is the minimal gene set filtered. |
Example | http://yourHost.com/api/cegRecord/fetchCeg.php?id=01020304 |
1 Get minimal gene set
URL | /api/cegRecord/compare.php |
GET | id |
Return | Result in json style. Status 0 means execute successfuly, and 1 means error. Data is the minimal gene set. Statics is the statistical value. |
Example | http://yourHost.com/api/cegRecord/compare.php?id=01020304+05060708 |
2 Compare two minimal gene sett
URL | api/download/cegCSV.php |
GET | id |
Return | File with CSV format. |
Example | http://yourHost.com/api/download/cegCSV.php?id=01020304 |
3 Download minimal gene set with CSV format
URL | api/download/cegXML.php |
GET | id |
Return | File with XML format. |
Example | http://yourHost.com/api/download/cegXML.php?id=01020304 |
4 Download minimal gene set with XML format
URL | api/kegg/entireModule.php |
GET | id |
Return | Result in json style. Status 0 means execute successfuly, and 1 means error. Data is the URL of module results. |
Example | http://yourHost.com/api/kegg/entireModule.php?id=01020304 |
5 Get module with whole minimal gene set
URL | api/kegg/entirePathway.php |
GET | id |
Return | Result in json style. Status 0 means execute successfuly, and 1 means error. Data is the URL of pathway results. |
Example | http://yourHost.com/api/kegg/entireModule.php?id=01020304 |
6 Get pathway with whole minimal gene set
URL | api/kegg/metabolicModule.php |
GET | id |
Return | Result in json style. Status 0 means execute successfuly, and 1 means error. Data is the URL of module results. |
Example | http://yourHost.com/api/kegg/metabolicModule.php?id=01020304 |
7 Get module with gene set that only about metabolism
URL | /api/kegg/metabolicPathway.php |
GET | id |
Return | Result in json style. Status 0 means execute successfuly, and 1 means error. Data is the URL of pathway results. |
Example | http://yourHost.com/api/kegg/metabolicPathway.php?id=01020304 |
8 Get pathway with gene set that only about metabolism
Service Page Documentation
Service Page can be visited directly to view the corresponding result.
URL | /app/page/mapEntireModule.php |
GET | id |
Return | Module list |
Example | http://yourHost.com/app/page/mapEntireModule.php?id=01020304 |
1 Page of Module wtih whole minimal gene set
URL | /app/page/mapEntirePathway.php |
GET | id |
Return | Pathway list |
Example | http://yourHost.com/app/page/mapEntireModule.php?id=01020304 |
2 Page of pathway wtih whole minimal gene set
URL | /app/page/mapMetaModule.php |
GET | id |
Return | Module list |
Example | http://yourHost.com/app/page/mapMetaModule.php?id=01020304 |
3 Page of module with gene set that only about metabolism
URL | /app/page/mapMetaPathway.php |
GET | id |
Return | Module list |
Example | http://yourHost.com/app/page/mapMetaPathway.php?id=01020304 |
4 Page of pathway wtih gene set that only about metabolism