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

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -OC-API-04032017
1 +ONEcount API Documentation
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.sonish
1 +XWiki.Admin
Content
... ... @@ -1,56 +49,8 @@
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 -
49 49  (% class="western" %)
50 50  **Introduction**
51 51  
52 52  (% class="western" %)
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.
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.
54 54  
55 55  (% class="western" %)
56 56  REST takes advantage of the HTTP request methods to layer itself into the existing HTTP architecture. These operations consist of the following:
... ... @@ -58,14 +58,11 @@
58 58  1. (((
59 59  (% class="western" %)
60 60  **GET** - Used for lookup of resources
61 -
62 -* (((
13 +)))
63 63  1. (((
64 64  (% class="western" %)
65 65  **PUT** - Used to update a resource
66 66  )))
67 -)))
68 -)))
69 69  1. (((
70 70  (% class="western" %)
71 71  **POST** - Used to create a new resource
... ... @@ -72,7 +72,7 @@
72 72  )))
73 73  
74 74  (% class="western" %)
75 -ONEcount API provides following functionalities:
24 +Specifically, the ONEcount API provides following functionalities:
76 76  
77 77  1. (((
78 78  (% class="western" %)
... ... @@ -205,17 +205,11 @@
205 205  (% class="western" %)
206 206  ListSourceCodes
207 207  )))
157 +1. **Attach**
208 208  
159 +*
160 +** (((
209 209  (% class="western" %)
210 -
211 -
212 -1. (((
213 -(% class="western" %)
214 -**Attach**
215 -)))
216 -
217 -* (((
218 -(% class="western" %)
219 219  Attach resource to product
220 220  )))
221 221  
... ... @@ -223,27 +223,19 @@
223 223  
224 224  
225 225  (% class="western" %)
226 -
169 +**Accessing API**
227 227  
228 228  (% class="western" %)
229 -**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect" class="western"]]
172 +**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect"]]
230 230  
231 231  (% class="western" %)
232 -**Appkey**: THIS WILL BE PROVIDED
175 +**Appkey**: THIS WILL BE PROVIDED TO YOU
233 233  
234 234  (% class="western" %)
235 -
178 +**
179 +**
236 236  
237 237  (% 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" %)
247 247  Your HTTP requests to a REST API resource should contain the following information:
248 248  
249 249  * (((
... ... @@ -264,9 +264,12 @@
264 264  )))
265 265  
266 266  (% class="western" %)
267 -**Request**
202 +
268 268  
269 269  (% class="western" %)
205 +**API Usage**
206 +
207 +(% class="western" %)
270 270  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.
271 271  
272 272  (% class="western" %)
... ... @@ -395,6 +395,18 @@
395 395  
396 396  
397 397  (% class="western" %)
336 +**
337 +**
338 +
339 +(% class="western" %)
340 +**
341 +**
342 +
343 +(% class="western" %)
344 +**
345 +**
346 +
347 +(% class="western" %)
398 398  **Resources**
399 399  
400 400  (% class="western" %)
... ... @@ -2244,6 +2244,14 @@
2244 2244  
2245 2245  
2246 2246  
2197 +
2198 +
2199 +
2200 +
2201 +
2202 +
2203 +
2204 +
2247 2247  (% class="western" %)
2248 2248  **Stats**
2249 2249  
... ... @@ -2417,6 +2417,14 @@
2417 2417  
2418 2418  
2419 2419  
2378 +
2379 +
2380 +
2381 +
2382 +
2383 +
2384 +
2385 +
2420 2420  (% class="western" %)
2421 2421  **Reference**
2422 2422  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3539005
1 +3539007
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/3539005/OC-API-04032017
1 +https://info.onecount.net//wiki/spaces/OD/pages/3539007/ONEcount API Documentation