Guest User

Untitled

a guest
Jul 18th, 2018
87
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 4.13 KB | None | 0 0
  1. API:
  2.  
  3. api/classes.php
  4. eg: api/class.php
  5. result:
  6. <result>
  7. <classes>
  8. <class>
  9. ...
  10. </class>
  11.  
  12. <class>
  13. ...
  14. </class>
  15. ...
  16. </classes>
  17. </result>
  18.  
  19.  
  20. api/class.php?id=[number]
  21. id: unique integer corresponding to a single class, such as COMS1004
  22.  
  23. eg: api/class.php?id=12345
  24. result:
  25. <result>
  26. <class>
  27. <id>[number]</id>
  28. <name>[string]</name>
  29.  
  30. //TODO
  31.  
  32. <books>
  33. <bookMaster>
  34. ...
  35. </bookMaster>
  36.  
  37. <bookMaster>
  38. ...
  39. </bookMaster>
  40. ...
  41. </books>
  42.  
  43. </class>
  44. </result>
  45.  
  46. api/bookMasters.php
  47. returns a list of master books.
  48.  
  49. eg: api/bookMasters.php
  50. result:
  51. <result>
  52. <bookMasters>
  53. <bookMaster>
  54. ...
  55. </bookMaster>
  56.  
  57. <bookMaster>
  58. ...
  59. </bookMaster>
  60. ...
  61. </bookMasters>
  62. </result>
  63.  
  64. api/bookMaster.php?id=[number]
  65. id: unique integer corresponding to a single book, such as "Big Java".
  66. Not dependent upon version.
  67.  
  68. eg: api/book.php?id=12345
  69. result:
  70. <result>
  71. <bookMaster>
  72. <id>[number]</id>
  73. <title>[string]</title>
  74. <author>[string]</author>
  75.  
  76. // TODO
  77.  
  78. <bookVersions>
  79. <bookVersion>
  80. ...
  81. </bookVersion>
  82.  
  83. <bookVersion>
  84. ...
  85. <bookVersion>
  86. ...
  87. </bookVersions>
  88. </bookMaster>
  89. </result>
  90.  
  91. api/bookVersions.php?id=[number]
  92. returns a list of versions for a given book
  93.  
  94. eg: api/bookVersions.php?id=12345
  95. result:
  96. <result>
  97. <bookVersions>
  98. <bookVersion>
  99. ...
  100. </bookVersion>
  101.  
  102. <bookVersion>
  103. ...
  104. <bookVersion>
  105. ...
  106. </bookVersions>
  107. </result>
  108.  
  109. api/bookVersion.php?id=[number]&version=[number]
  110.  
  111. id: unique integer corresponding to a single book, such as "Big Java".
  112. version: unique integer corresponding to a specific version of a book.
  113. This is still dependent upon the id.
  114.  
  115. eg: api/bookVersion.php?id=12345&version=6789
  116. result:
  117. <result>
  118. <bookVersions>
  119. <bookVersion>
  120. ...
  121. </bookVersion>
  122.  
  123. <bookVersion>
  124. ...
  125. <bookVersion>
  126. ...
  127. </bookVersions>
  128. </result>
  129.  
  130. api/bookInstances.php?id=[number]
  131. returns a list of instances of a given book, of all versions
  132.  
  133. eg: api/bookInstances.php?id=12345
  134. result:
  135. <result>
  136. <bookVersion>
  137. <id>[number]</int>
  138. <bookInstances>
  139. <bookInstance>
  140. ...
  141. </bookInstance>
  142.  
  143. <bookInstance>
  144. ...
  145. <bookInstance>
  146. ...
  147. </bookInstances>
  148. <bookVersion>
  149.  
  150. <bookVersion>
  151. <id>[number]</int>
  152. <bookInstances>
  153. <bookInstance>
  154. ...
  155. </bookInstance>
  156.  
  157. <bookInstance>
  158. ...
  159. <bookInstance>
  160. ...
  161. </bookInstances>
  162. <bookVersion>
  163.  
  164. ...
  165.  
  166. </result>
  167.  
  168. api/bookInstances.php?id=[number]&version=[number]
  169. returns a list of instances of a given book, with a given version
  170.  
  171. eg: api/bookInstances.php?id=12345&version=678
  172. result:
  173. <result>
  174. <bookInstances>
  175. <bookInstance>
  176. ...
  177. </bookInstance>
  178.  
  179. <bookInstance>
  180. ...
  181. <bookInstance>
  182. ...
  183. </bookInstances>
  184. </result>
  185.  
  186. api/bookInstance.php?id=[number]&version=[number]&instance=[number]
  187. id: unique integer corresponding to a single book, such as "Big Java".
  188. version: unique integer corresponding to a specific version of a book.
  189. instance: unique integer corresponding to a specific instance of a
  190. version of a book.
  191.  
  192. eg: api/book.php?id=12345&version=6789&instance=12345
  193. result:
  194. <result>
  195. <bookInstance>
  196. <condition>
  197.  
  198. // TODO
  199.  
  200. </bookInstance>
  201. </result>
  202.  
  203.  
  204. api/query?type=[type]&query=[query]
  205. type: one of {author, name, ...}
Add Comment
Please, Sign In to add comment