Skip to Content
Last modified by Admin on 2025/06/27 12:14
From version 5.1
edited by Admin
on 2017/04/05 10:32
Change comment: There is no comment for this version
To version 4.1
edited by sonish
on 2017/04/03 16:45
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -ONEcount API Documentation
1 +OC-API-04032017
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.Admin
1 +XWiki.sonish
Content
... ... @@ -1,8 +1,56 @@
1 +(% class="western" align="center" %)
2 +
3 +
4 +(% class="western" align="center" %)
5 +
6 +
7 +(% class="western" align="center" %)
8 +
9 +
10 +(% class="western" align="center" %)
11 +
12 +
13 +(% class="western" align="center" %)
14 +
15 +
16 +(% class="western" align="center" %)
17 +
18 +
19 +(% class="western" align="center" %)
20 +ONEcount REST API Developer's Guide
21 +
22 +(% class="western" align="center" %)
23 +Version 2.1
24 +
25 +(% class="western" align="center" %)
26 +
27 +
28 +(% class="western" align="center" %)
29 +
30 +
31 +(% class="western" align="center" %)
32 +
33 +
34 +(% class="western" align="center" %)
35 +
36 +
37 +(% class="western" align="center" %)
38 +
39 +
40 +(% class="western" align="center" %)
41 +
42 +
43 +(% class="western" align="center" %)
44 +
45 +
46 +(% class="western" align="center" %)
47 +
48 +
1 1  (% class="western" %)
2 2  **Introduction**
3 3  
4 4  (% class="western" %)
5 -ONEcount REST API is designed to allow you to directly manipulate the underlying data within the ONEcount application. his API can be used to lookup, create and updated different ONEcount resources which are listed below.
53 +ONEcount REST API provides different functionality to accomplish many integration related tasks. This API can be used to lookup, create and updated different ONEcount resources which are listed below.
6 6  
7 7  (% class="western" %)
8 8  REST takes advantage of the HTTP request methods to layer itself into the existing HTTP architecture. These operations consist of the following:
... ... @@ -10,11 +10,14 @@
10 10  1. (((
11 11  (% class="western" %)
12 12  **GET** - Used for lookup of resources
13 -)))
61 +
62 +* (((
14 14  1. (((
15 15  (% class="western" %)
16 16  **PUT** - Used to update a resource
17 17  )))
67 +)))
68 +)))
18 18  1. (((
19 19  (% class="western" %)
20 20  **POST** - Used to create a new resource
... ... @@ -21,7 +21,7 @@
21 21  )))
22 22  
23 23  (% class="western" %)
24 -Specifically, the ONEcount API provides following functionalities:
75 +ONEcount API provides following functionalities:
25 25  
26 26  1. (((
27 27  (% class="western" %)
... ... @@ -154,11 +154,17 @@
154 154  (% class="western" %)
155 155  ListSourceCodes
156 156  )))
157 -1. **Attach**
158 158  
159 -*
160 -** (((
161 161  (% class="western" %)
210 +
211 +
212 +1. (((
213 +(% class="western" %)
214 +**Attach**
215 +)))
216 +
217 +* (((
218 +(% class="western" %)
162 162  Attach resource to product
163 163  )))
164 164  
... ... @@ -166,19 +166,27 @@
166 166  
167 167  
168 168  (% class="western" %)
169 -**Accessing API**
226 +
170 170  
171 171  (% class="western" %)
172 -**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect"]]
229 +**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect" class="western"]]
173 173  
174 174  (% class="western" %)
175 -**Appkey**: THIS WILL BE PROVIDED TO YOU
232 +**Appkey**: THIS WILL BE PROVIDED
176 176  
177 177  (% class="western" %)
178 -**
179 -**
235 +
180 180  
181 181  (% class="western" %)
238 +**Function**
239 +
240 +(% class="western" %)
241 +The ONEcount REST API will be used to create, update & lookup users, transactions and questions e.t.c. in ONEcount hosted install of the client.
242 +
243 +(% class="western" %)
244 +**Accessing API**
245 +
246 +(% class="western" %)
182 182  Your HTTP requests to a REST API resource should contain the following information:
183 183  
184 184  * (((
... ... @@ -199,12 +199,9 @@
199 199  )))
200 200  
201 201  (% class="western" %)
202 -
267 +**Request**
203 203  
204 204  (% class="western" %)
205 -**API Usage**
206 -
207 -(% class="western" %)
208 208  The request data in POST (for create and update) will consist of request parameters required by each method in JSON format. Value of resource will determine which resource is being requested and the access method will determine whether you are trying to create, update or lookup that resource.
209 209  
210 210  (% class="western" %)
... ... @@ -333,18 +333,6 @@
333 333  
334 334  
335 335  (% class="western" %)
336 -**
337 -**
338 -
339 -(% class="western" %)
340 -**
341 -**
342 -
343 -(% class="western" %)
344 -**
345 -**
346 -
347 -(% class="western" %)
348 348  **Resources**
349 349  
350 350  (% class="western" %)
... ... @@ -2194,14 +2194,6 @@
2194 2194  
2195 2195  
2196 2196  
2197 -
2198 -
2199 -
2200 -
2201 -
2202 -
2203 -
2204 -
2205 2205  (% class="western" %)
2206 2206  **Stats**
2207 2207  
... ... @@ -2375,14 +2375,6 @@
2375 2375  
2376 2376  
2377 2377  
2378 -
2379 -
2380 -
2381 -
2382 -
2383 -
2384 -
2385 -
2386 2386  (% class="western" %)
2387 2387  **Reference**
2388 2388  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3539007
1 +3539005
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/3539007/ONEcount API Documentation
1 +https://info.onecount.net//wiki/spaces/OD/pages/3539005/OC-API-04032017