Guest User

Untitled

a guest
Jun 22nd, 2018
83
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 4.39 KB | None | 0 0
  1. Sample Request Header
  2. =====================
  3. content-type: {text/xml}, {application/json}
  4. authentication-key: {key-value}
  5.  
  6. REST API Methods
  7. ================
  8. Project Methods
  9. * projects
  10. URL: /projects.format
  11. Formats: xml, json, rss, atom
  12. HTTP Method: GET
  13. Requires Authentication: true
  14. Parameters:
  15. * page, Optional, Specifies the page of projects list to retrieve
  16. Example: /projects.json?page=3
  17. Response:
  18. XML example:
  19. <?xml version="1.0" encoding="UTF-8"?>
  20. <projects>
  21. <project>
  22. <id>111</id>
  23. <title>Some tile</title>
  24. <description>some description</description>
  25. <created_date>Tue Apr 07 22:52:51 +0000 2009</created_date>
  26. <updated_date>Tue Apr 07 22:52:51 +0000 2009</updated_date>
  27. </project>
  28. <project>
  29. <id>112</id>
  30. <title>AgainSome tile</title>
  31. <description>again some description</description>
  32. <created_date>Tue Apr 07 22:52:51 +0000 2009</created_date>
  33. <updated_date>Tue Apr 07 22:52:51 +0000 2009</updated_date>
  34. </project>
  35. </projects>
  36.  
  37. JSON example:
  38. [
  39. {
  40. "title": "some title",
  41. "id": 111,
  42. "created_date": "Tue Apr 07 22:52:51 +0000 2009",
  43. "description": "some description",
  44. "updated_date": "Tue Apr 07 22:52:51 +0000 2009"
  45. },
  46. {
  47. "title": "again some title",
  48. "id": 112,
  49. "created_date": "Tue Apr 07 22:52:51 +0000 2009",
  50. "description": "again some description",
  51. "updated_date": "Tue Apr 07 22:52:51 +0000 2009"
  52. }
  53. ]
  54.  
  55. * projects/new
  56. URL: /projects/new.format
  57. Formats: xml, json
  58. HTTP method: POST
  59. Require Authentication: true
  60. Parameters:
  61. title, Required.
  62. description, optional
  63. Response:
  64. XML example:
  65. <?xml version="1.0" encoding="UTF-8"?>
  66. <project>
  67. <id>111</id>
  68. <title>Some tile</title>
  69. <description>some description</description>
  70. <created_date>Tue Apr 07 22:52:51 +0000 2009</created_date>
  71. <updated_date>Tue Apr 07 22:52:51 +0000 2009</updated_date>
  72. </project>
  73.  
  74. JSON example:
  75. {
  76. "title": "some title",
  77. "id": 111,
  78. "created_date": "Tue Apr 07 22:52:51 +0000 2009",
  79. "description": "some description",
  80. "updated_date": "Tue Apr 07 22:52:51 +0000 2009"
  81. }
  82.  
  83. * projects/{id}
  84. URL: /projects/{id}.format
  85. Formats: xml, json, rss, atom
  86. HTTP method: GET
  87. Require Authentication: true
  88. Parameters:
  89. id, Required.
  90. Response:
  91. XML example:
  92. <?xml version="1.0" encoding="UTF-8"?>
  93. <project>
  94. <id>111</id>
  95. <title>Some tile</title>
  96. <description>some description</description>
  97. <created_date>Tue Apr 07 22:52:51 +0000 2009</created_date>
  98. <updated_date>Tue Apr 07 22:52:51 +0000 2009</updated_date>
  99. </project>
  100.  
  101. JSON example:
  102. {
  103. "title": "some title",
  104. "id": 111,
  105. "created_date": "Tue Apr 07 22:52:51 +0000 2009",
  106. "description": "some description",
  107. "updated_date": "Tue Apr 07 22:52:51 +0000 2009"
  108. }
  109.  
  110. * projects/edit/{id}
  111. URL: /projects/edit/{id}.format
  112. Formats: xml, json
  113. HTTP method: POST
  114. Require Authentication: true
  115. Parameters:
  116. id, Required.
  117. Response:
  118. XML example:
  119. <?xml version="1.0" encoding="UTF-8"?>
  120. <project>
  121. <id>111</id>
  122. <title>Some tile</title>
  123. <description>some description</description>
  124. <created_date>Tue Apr 07 22:52:51 +0000 2009</created_date>
  125. <updated_date>Tue Apr 07 22:52:51 +0000 2009</updated_date>
  126. </project>
  127.  
  128. JSON example:
  129. {
  130. "title": "some title",
  131. "id": 111,
  132. "created_date": "Tue Apr 07 22:52:51 +0000 2009",
  133. "description": "some description",
  134. "updated_date": "Tue Apr 07 22:52:51 +0000 2009"
  135. }
  136.  
  137. * projects/delete/{id}
  138. URL: /projects/delete/{id}.format
  139. Formats: xml, json
  140. HTTP method: POST
  141. Require Authentication: true
  142. Parameters:
  143. id, Required.
  144. Response:
  145. XML example:
  146. <?xml version="1.0" encoding="UTF-8"?>
  147. <project>
  148. <id>111</id>
  149. <title>Some tile</title>
  150. <description>some description</description>
  151. <created_date>Tue Apr 07 22:52:51 +0000 2009</created_date>
  152. <updated_date>Tue Apr 07 22:52:51 +0000 2009</updated_date>
  153. </project>
  154.  
  155. JSON example:
  156. {
  157. "title": "some title",
  158. "id": 111,
  159. "created_date": "Tue Apr 07 22:52:51 +0000 2009",
  160. "description": "some description",
  161. "updated_date": "Tue Apr 07 22:52:51 +0000 2009"
  162. }
Add Comment
Please, Sign In to add comment