editor-api-docs/index.html at main · ishgroup/editor-api-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
<!DOCTYPE html>
<head>
  <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"/>
  <meta content="width=device-width, initial-scale=1.0" name="viewport"/>

  <link rel="stylesheet" type="text/css" href="assets/css/bootstrap.css" media="screen">
  <link rel="stylesheet" type="text/css" href="assets/css/bootstrap-responsive.css" media="screen">
  <link rel="stylesheet" type="text/css" href="assets/css/style.css">
  <script src="assets/js/jquery-1.8.3.min.js" type="text/javascript"></script>
  <script src="assets/js/main.js" type="text/javascript"></script>

  <title>onCourse REST API documentation</title>
</head>
<body>
  <div class="header">
    <div class="top-bar">
      <h1 id="logo"><a class="logo" href="/"><span>onCourse Editor API</span> <span class="light">v1</span></a></h1>
    </div>
  </div>
  <div class="modal fade" id="modal-container" tabindex="-1" role="dialog">
    <div class="modal-dialog" role="document">
      <div class="modal-content clearfix">
        <div class="modal-body"></div>
      </div>
    </div>
  </div>
  <div class="content clearfix">
    <div class="sidebar">
      <div class="section-box">
        <div class="section-header">
          Overview
        </div>
        <ul>
          <li>Getting Started</li>
        </ul>
      </div>
      <div class="section-box">
        <div class="section-header">
          <a href="#!/AuthApi">auth</a>
        </div>
        <ul>
          <li><a href="#!/AuthApi#createSession">createSession</a></li>
          <li><a href="#!/AuthApi#destroySession">destroySession</a></li>
          <li><a href="#!/AuthApi#getUser">getUser</a></li>
        </ul>
      </div>
      <div class="section-box">
        <div class="section-header">
          <a href="#!/BlockApi">block</a>
        </div>
        <ul>
          <li><a href="#!/BlockApi#createBlock">createBlock</a></li>
          <li><a href="#!/BlockApi#deleteBlock">deleteBlock</a></li>
          <li><a href="#!/BlockApi#getBlockById">getBlockById</a></li>
          <li><a href="#!/BlockApi#getBlocks">getBlocks</a></li>
          <li><a href="#!/BlockApi#updateBlock">updateBlock</a></li>
        </ul>
      </div>
      <div class="section-box">
        <div class="section-header">
          <a href="#!/MenuApi">menu</a>
        </div>
        <ul>
          <li><a href="#!/MenuApi#getMenus">getMenus</a></li>
          <li><a href="#!/MenuApi#updateMenus">updateMenus</a></li>
        </ul>
      </div>
      <div class="section-box">
        <div class="section-header">
          <a href="#!/PageApi">page</a>
        </div>
        <ul>
          <li><a href="#!/PageApi#createPage">createPage</a></li>
          <li><a href="#!/PageApi#deletePage">deletePage</a></li>
          <li><a href="#!/PageApi#getPages">getPages</a></li>
          <li><a href="#!/PageApi#updatePage">updatePage</a></li>
        </ul>
      </div>
      <div class="section-box">
        <div class="section-header">
          <a href="#!/RedirectApi">redirect</a>
        </div>
        <ul>
          <li><a href="#!/RedirectApi#getRedirects">getRedirects</a></li>
          <li><a href="#!/RedirectApi#updateRedirects">updateRedirects</a></li>
        </ul>
      </div>
      <div class="section-box">
        <div class="section-header">
          <a href="#!/SettingsApi">settings</a>
        </div>
        <ul>
          <li><a href="#!/SettingsApi#getCheckoutSettings">getCheckoutSettings</a></li>
          <li><a href="#!/SettingsApi#getSkillsOnCourseSettings">getSkillsOnCourseSettings</a></li>
          <li><a href="#!/SettingsApi#getWebsiteSettings">getWebsiteSettings</a></li>
          <li><a href="#!/SettingsApi#updateCheckoutSettings">updateCheckoutSettings</a></li>
          <li><a href="#!/SettingsApi#updateSkillsOnCourseSettings">updateSkillsOnCourseSettings</a></li>
          <li><a href="#!/SettingsApi#updateWebsiteSettings">updateWebsiteSettings</a></li>
        </ul>
      </div>
      <div class="section-box">
        <div class="section-header">
          <a href="#!/SpecialPageApi">specialPage</a>
        </div>
        <ul>
          <li><a href="#!/SpecialPageApi#getSpecialPages">getSpecialPages</a></li>
          <li><a href="#!/SpecialPageApi#updateSpecialPages">updateSpecialPages</a></li>
        </ul>
      </div>
      <div class="section-box">
        <div class="section-header">
          <a href="#!/ThemeApi">theme</a>
        </div>
        <ul>
          <li><a href="#!/ThemeApi#createTheme">createTheme</a></li>
          <li><a href="#!/ThemeApi#deleteTheme">deleteTheme</a></li>
          <li><a href="#!/ThemeApi#getLayouts">getLayouts</a></li>
          <li><a href="#!/ThemeApi#getThemes">getThemes</a></li>
          <li><a href="#!/ThemeApi#updateTheme">updateTheme</a></li>
        </ul>
      </div>
      <div class="section-box">
        <div class="section-header">
          <a href="#!/VersionApi">version</a>
        </div>
        <ul>
          <li><a href="#!/VersionApi#getVersions">getVersions</a></li>
          <li><a href="#!/VersionApi#updateVersion">updateVersion</a></li>
        </ul>
      </div>
    </div>
    <div class="non-sidebar">
      <div class="main-content">
        <h2>Getting Started</h2>
        <p class="app-desc">An API for updating with the onCourse website</p>
          <p>This ReSTful API is available to interact with onCourse from automated scripts and tools.</p>
          <p>Where you see <code>{siteKey}.oncourse.cc</code> in the URL you should substitute your own staging site key or just use
        the full hostname of your production site.</p>
      </div>
    </div>
  </div>
</body>
</html>