Need a unique gift idea?
A Pastebin account makes a great Christmas gift
SHARE
TWEET

SRL API Documentation

puchiedarcy Feb 2nd, 2015 325 Never
Upgrade to PRO!
ENDING IN00days00hours00mins00secs
 
  1. SRL API Documentation
  2.  
  3. Checklist to Production
  4.  
  5. * /ratings/:player
  6.     - support for all time ? what does that make sense
  7.  
  8.  
  9. == Entrants ==
  10.  
  11. INDEX   /entrants      
  12.     [not implemented]
  13.    
  14. GET     /entrants/:id  
  15.     :id is race id
  16.     Returns list of players participating in a race
  17.    
  18. PUT     /entrants/:id
  19.     BODY
  20.         enter       : :playerName   - Enters a player into a race
  21.         ready       : :playerName   - Flags player as ready to race
  22.         unready     : :playerName   - Unflags player as ready to race
  23.         done        : :playerName   - Sets player as finished with the race
  24.         undone      : :playerName   - Sets player as not finished with the race
  25.         forfeit     : :playerName   - Allows the player to quit the race
  26.         comment     : :playerName   - Sets a player comment about the race
  27.         disqualify  : :playerName   - Disqualify a player from the race
  28.         message     : :string       - Sets message about disqualification
  29.  
  30. POST    /entrants/:id
  31.     [not implemented]
  32.    
  33. DELETE  /entrants/:id
  34.     BODY
  35.         entrant     : playerName    - Removes a player from a race
  36.        
  37.        
  38.        
  39. == Games ==
  40.  
  41. INDEX   /games
  42.     Returns un-paged list of all races games
  43.    
  44. GET     /games/:id
  45.     :id is game abbreviation
  46.     Return details about a specific game
  47.    
  48. PUT     /games/:id
  49.     Creates a new game, or updates a game's full name
  50.     BODY
  51.         name        : :string       - The full name of the new game
  52.  
  53. POST    /games/:id
  54.     [not implemented]
  55.    
  56. DELETE  /games/:id
  57.     [not implemented]
  58.    
  59.    
  60.    
  61. == Goalchanger ==
  62.  
  63. INDEX   /goalchanger
  64.     [not implemented]
  65.    
  66. GET     /goalchanger/:id
  67.     :id is game abbreviation
  68.     Returns list of all race goals for a game in the active season
  69.    
  70. PUT     /goalchanger/:id
  71.     Reassigns races with a certain race goal to a another goal (aka goal consolidation)
  72.     BODY
  73.         oldGoal     : :int          - The goal to be reassigned (to have 0 races after the call)
  74.         newGoal     : :int          - The goal to transfer to all the races
  75.        
  76. POST    /goalchanger/:id
  77.     [not implemented]
  78.    
  79. DELETE  /goalchanger/:id
  80.     [not implemented]
  81.    
  82.    
  83.    
  84. == Goals ==
  85.  
  86. INDEX   /goals
  87.     [not implemented]
  88.    
  89. GET     /goals/:id
  90.     :id is game abbreviation
  91.     Returns most commonly races goals for a season
  92.     QUERY STRING
  93.         season      : :int      - The season of the top goals, or the active season if omitted
  94.        
  95. PUT     /goals/:id
  96.     Creates a tracked goal for a game
  97.     BODY
  98.         goal        : :string   - The name/description of the goal to be raced
  99.        
  100. POST    /goals/:id
  101.     [not implemented]
  102.    
  103. DELETE  /goals/:id
  104.     [not implemented]
  105.    
  106.    
  107.    
  108. == Leaderboard ==
  109.  
  110. INDEX    /leaderboard
  111.     Returns the leaderboard for common race statistics
  112.     QUERY STRING
  113.         page        : :int      - Page of data to return; 1 if omitted
  114.         pageSize    : :int      - Size of paged data to return; 100 if omitted
  115.         sortField   : :int      - Statistic to sort on; vaild stats are 15 - Overall skill, 1 - number of races, 8 - number of wins, 6 - time played, 3 - unique games played
  116.         order       : :string   - Largest to smallest or vice-versa; ASC by default, DESC also acceptable
  117.        
  118. GET     /leaderboard/:id
  119.     :id is game abbreviation
  120.     Returns the trueskill leaderboard for a game in a season
  121.     QUERY STRING
  122.         season      : :int      - Id of season, active seasons if omitted
  123.        
  124. PUT     /leaderboard/:id
  125.     [not implemented]
  126.    
  127. POST    /leaderboard/:id
  128.     [not implemented]
  129.    
  130. DELETE  /leaderboard/:id
  131.     [not implemented]
  132.    
  133.    
  134.    
  135. == Pastraces ==
  136.  
  137. INDEX   /pastraces
  138.     Returns list of races from the past
  139.     QUERY STRING
  140.         page        : :int      - Page of data to return, 1 if omitted
  141.         pageSize    : :int      - Size of page, 20 if omitted, 20 max
  142.         season      : :int      - (optional) Id of the season in which the races took place
  143.         game        : :string   - (optional) Abbreviation of the game for the races
  144.         player      : :string   - (optional) Name of a player in the races
  145.         seasongoal  : :int      - (optional) Id of the season featured goal for the race
  146.    
  147. GET     /pastraces/:id
  148.     :id is the id of a specific past race
  149.     Returns the details of an individual race
  150.    
  151. PUT     /pastraces/:id
  152.     [not implemented]
  153.    
  154. POST    /pastraces/:id
  155.     [not implemented]
  156.    
  157. DELETE  /pastraces/:id
  158.     [not implemented]
  159.    
  160.    
  161.    
  162. == Players ==
  163.    
  164. INDEX   /players
  165.     [not implemented]
  166.    
  167. GET     /players/:id
  168.     :id is the player's name
  169.     Returns details about a specific player
  170.    
  171. PUT     /players/:id
  172.     Changes a player's name
  173.     BODY
  174.         newName     : :string       - The new name of the player
  175.    
  176. POST    /players/:id
  177.     [not implemented]
  178.    
  179. DELETE  /players/:id
  180.     [not implemented]
  181.    
  182.    
  183.    
  184. == Races ==
  185.  
  186. INDEX   /races
  187.     Returns a list of all currently active races
  188.    
  189. GET     /races/:id
  190.     :id is the id of the active race
  191.     QUERY STRING
  192.         lower       : :string       - (optional) Any value here sets player name keys in json to lowercase
  193.    
  194. PUT     /races/:id
  195.     Changes the state of a race
  196.     BODY
  197.         filename    : :string       - Any value with flag a race as needing a filename
  198.         game        : :string       - Set the game abbreviation of the race
  199.         goal        : :string       - Set the race goal/description
  200.         state       : :int          - Set the race state, 2 - Entry Close, 3 - In Progress, 4 - Complete, 5 - Race Over
  201.         record      : :string       - Record the race
  202.         rematch     : :string       - Clear entrants list, and set race state to Entry Open
  203.        
  204. POST    /races
  205.     Creates a new race
  206.     BODY
  207.         game        : :string       - Game abbrevation of the game to be raced
  208.    
  209. DELETE  /races/:id
  210.     Deletes a race
  211.    
  212.    
  213.    
  214. == Ratings ==
  215.  
  216. INDEX   /ratings
  217.     Returns a random champion of a game (#1 ranked player)
  218.    
  219. GET     /ratings/:id
  220.     :id is a player name
  221.     Returns the ratins of all played games for a player
  222.    
  223. PUT     /ratings/:id
  224.     [not implemented]
  225.    
  226. POST    /ratings
  227.     Test function for trueskill ratings
  228.    
  229. DELETE  /ratings/:id
  230.     [not implemented]
  231.    
  232.    
  233.    
  234. == Rtaleaderboards ==
  235.  
  236. == Rtaleaderboardtags ==
  237.  
  238. == Rtamilestones ==
  239.  
  240. == Rtatimes ==
  241.  
  242. == Rules ==
  243.  
  244. INDEX   /rules
  245.     [not implemented]
  246.    
  247. GET     /rules/:id
  248.     :id is game abbreviation
  249.     Returns the rules for racing a game
  250.    
  251. PUT     /rules/:id
  252.     [not implemented]
  253.    
  254. POST    /rules
  255.     [not implemented]
  256.    
  257. DELETE  /rules/:id
  258.     [not implemented]
  259.    
  260.    
  261.    
  262. == Seasongoal ==
  263.  
  264. INDEX   /seasongoal
  265.     [not implemented]
  266.    
  267. GET     /seasongoal/;id
  268.     :id is the id of the season goal
  269.     Get detailed information about a season goal including leaderboard
  270.    
  271. PUT     /seasongoal/:id
  272.     [not implemented]
  273.    
  274. POST    /seasongoal
  275.     Add a goal to a season to be tracked
  276.     BODY
  277.         season_id       : :int         - Id of the season to add the goal to
  278.         goal_id         : :int         - Id of the goal to track in the season
  279.    
  280. DELETE  /seasongoal
  281.     [not implemented]
  282.    
  283.    
  284.    
  285. == Seasons ==
  286.  
  287. INDEX   /season
  288.     Returns a list of previous seasons and the active season id
  289.    
  290. GET     /season/:id
  291.     :id is the id of the season
  292.     Returns detailed information about the season (like goals)
  293.    
  294. PUT     /season/:id
  295.     [not implemented]
  296.    
  297. POST    /season
  298.     Creates a new season with a name
  299.     BODY
  300.         season_name     : :string       - Name of the new season
  301.    
  302. DELETE  /season/:id
  303.     [not implemented]
  304.    
  305.    
  306.    
  307. == Stat ==
  308.  
  309. INDEX   /stat
  310.     Returns various statistics for overall, players, or games
  311.     QUERY STRING
  312.         player          : :string       - (optional) Name of the player to get stats for
  313.         game            : :string       - (optional) Abbreviation of the game to get statistics for
  314.    
  315. GET     /stat/monthly
  316.     Returns month-over-month statistics
  317.    
  318. PUT     /stat/:
  319.     [not implemented]
  320.    
  321. POST    /stat
  322.     [not implemented]
  323.    
  324. DELETE  /stat
  325.     [not implemented]
  326.    
  327.    
  328.    
  329. == Streams ==
  330.  
  331. INDEX   /streams
  332.     Returns a list of player names for a given list of stream names
  333.     QUERY STRING
  334.         channels        : :string       - Comma separated list of stream names
  335.        
  336. GET     /streams/:id
  337.     :id is player name
  338.     Returns the stream channel name of a player
  339.    
  340. PUT     /streams/:id
  341.     Sets the stream channel name for a player
  342.     BODY
  343.         channel         : :string       - Channel name
  344.        
  345. POST    /streams
  346.     [not implemented]
  347.    
  348. DELETE  /streams
  349.     Removes the stream of a player
  350.     BODY
  351.         user            : :string       - Name of the player
RAW Paste Data
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy. OK, I Understand
 
Top