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 6.1
edited by Admin
on 2017/04/05 10:47
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,178 +72,56 @@
72 72  )))
73 73  
74 74  (% class="western" %)
75 -ONEcount API provides following functionalities:
24 +Specifically, the ONEcount API provides to the following components:
76 76  
77 -1. (((
78 -(% class="western" %)
79 -**Lookup**
26 +1. User data
27 +11. List users
28 +11. Lookup users
29 +11. Create users
30 +11. Update users
31 +1. Transaction data
32 +11. Lookup transactions
33 +11. Create transactions
34 +\\
35 +1. Product data
36 +11. Lookup products
37 +11. Create products
38 +11. Update products
39 +1. Term Data
40 +11. Lookup terms
41 +11. Create terms
42 +11. Update terms
43 +1. Resource Data
44 +11. Lookup resources
45 +11. Create resources
46 +11. Update resources
47 +1. Questions
48 +11. Lookup questions
49 +11. List questions
50 +11. Create questions
51 +1. Source Codes
52 +11. Lookup source code
53 +11. Create source codes
54 +11. Update source codes
55 +1. Attach a resource to a product
56 +1. Leads
57 +11. Create a lead
58 +\\\\\\
80 80  
81 -*
82 -
83 83  (% class="western" %)
84 -User lookup
61 +**Accessing API**
85 85  
86 -*
87 -
88 88  (% class="western" %)
89 -Transaction lookup
64 +**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect"]]
90 90  
91 -*
92 -
93 93  (% class="western" %)
94 -Question lookup
67 +**Appkey**: THIS WILL BE PROVIDED TO YOU
95 95  
96 -*
97 -
98 98  (% class="western" %)
99 -Source code lookup
70 +**
71 +**
100 100  
101 -*
102 -
103 103  (% class="western" %)
104 -Product lookup
105 -
106 -*
107 -
108 -(% class="western" %)
109 -Term lookup
110 -
111 -*
112 -
113 -(% class="western" %)
114 -Resource lookup
115 -)))
116 -1. (((
117 -(% class="western" %)
118 -**Create**
119 -
120 -*
121 -
122 -(% class="western" %)
123 -Add a user/demo
124 -
125 -*
126 -
127 -(% class="western" %)
128 -Add a question
129 -
130 -*
131 -
132 -(% class="western" %)
133 -Add user transaction
134 -
135 -*
136 -
137 -(% class="western" %)
138 -Add source code
139 -
140 -*
141 -
142 -(% class="western" %)
143 -Add Product
144 -
145 -*
146 -
147 -(% class="western" %)
148 -Add Term
149 -
150 -*
151 -
152 -(% class="western" %)
153 -Add Resource
154 -
155 -*
156 -
157 -(% class="western" %)
158 -Stats – Telemarketing
159 -)))
160 -1. (((
161 -(% class="western" %)
162 -**Update**
163 -
164 -*
165 -
166 -(% class="western" %)
167 -Update a user/demo
168 -
169 -*
170 -
171 -(% class="western" %)
172 -Update a question
173 -
174 -*
175 -
176 -(% class="western" %)
177 -Update source code
178 -
179 -*
180 -
181 -(% class="western" %)
182 -Update product
183 -
184 -*
185 -
186 -(% class="western" %)
187 -Update term
188 -
189 -*
190 -
191 -(% class="western" %)
192 -Update resource
193 -)))
194 -1. (((
195 -(% class="western" %)
196 -**List**
197 -
198 -*
199 -
200 -(% class="western" %)
201 -ListQuestions
202 -
203 -*
204 -
205 -(% class="western" %)
206 -ListSourceCodes
207 -)))
208 -
209 -(% class="western" %)
210 -
211 -
212 -1. (((
213 -(% class="western" %)
214 -**Attach**
215 -)))
216 -
217 -* (((
218 -(% class="western" %)
219 -Attach resource to product
220 -)))
221 -
222 -(% class="western" %)
223 -
224 -
225 -(% class="western" %)
226 -
227 -
228 -(% class="western" %)
229 -**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect" class="western"]]
230 -
231 -(% class="western" %)
232 -**Appkey**: THIS WILL BE PROVIDED
233 -
234 -(% class="western" %)
235 -
236 -
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**
94 +
268 268  
269 269  (% class="western" %)
97 +**General API Usage**
98 +
99 +(% 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,42 +395,24 @@
395 395  
396 396  
397 397  (% class="western" %)
398 -**Resources**
228 +**
229 +**
399 399  
400 400  (% class="western" %)
401 -Resources are the available entities that can be accessed/modified via API. Each resource can be created, updated or requested by using the corresponding http method described above.
232 +**
233 +**
402 402  
403 -* (((
404 404  (% class="western" %)
405 -questions
406 -)))
407 -* (((
236 +**
237 +**
238 +
239 +
240 +
408 408  (% class="western" %)
409 -users
410 -)))
411 -* (((
412 -(% class="western" %)
413 -products
414 -)))
415 -* (((
416 -(% class="western" %)
417 -terms
418 -)))
419 -* (((
420 -(% class="western" %)
421 -resources
422 -)))
423 -* (((
424 -(% class="western" %)
425 -sources
426 -)))
427 -* (((
428 -(% class="western" %)
429 -transactions
430 -)))
242 +**RESOURCE: Questions**
431 431  
432 432  (% class="western" %)
433 -**Questions**
245 +All data fields in ONEcount are made up of questions. Questions are configurable on a per-client basis, and no two customer installations will have the same question (ie., field) layout. Therefore, before querying or updating any ONEcount installation, you'll need to get an understanding of the question layout of the installation. This API segment will allow you to query ONEcount to determine the question layout for the installation. It will also allow you to create new questions within the system. This resource does not allow you to update the data for a specific user (see User section).
434 434  
435 435  (% class="western" %)
436 436  This resource is for manipulating questions resource. Questions in ONEcount means any question that is asked to the subscriber. It could be any questions that appears on customer forms or print forms that gets answered by a subscriber. Questions api call will allow creation, update and search of question in ONEcount. To add a new questions to the system you'll make a POST api call to the questions resource.
... ... @@ -777,7 +777,7 @@
777 777  
778 778  (% class="western" %)
779 779  
780 -**Users**
592 +**RESOURCE: Users**
781 781  
782 782  (% class="western" %)
783 783  Users means the customers of your system. Users can be added, updated and searched for using the users resource from the api. For lookup, If a return parameter is specified Users object will have those fields. If nothing is specified by default only UserId is returned.
... ... @@ -1853,9 +1853,41 @@
1853 1853  
1854 1854  
1855 1855  (% class="western" %)
1856 -
1668 +**Resources**
1857 1857  
1858 1858  (% class="western" %)
1671 +Resources are the available entities that can be accessed/modified via API. Each resource can be created, updated or requested by using the corresponding http method described above.
1672 +
1673 +* (((
1674 +(% class="western" %)
1675 +questions
1676 +)))
1677 +* (((
1678 +(% class="western" %)
1679 +users
1680 +)))
1681 +* (((
1682 +(% class="western" %)
1683 +products
1684 +)))
1685 +* (((
1686 +(% class="western" %)
1687 +terms
1688 +)))
1689 +* (((
1690 +(% class="western" %)
1691 +resources
1692 +)))
1693 +* (((
1694 +(% class="western" %)
1695 +sources
1696 +)))
1697 +* (((
1698 +(% class="western" %)
1699 +transactions
1700 +)))
1701 +
1702 +(% class="western" %)
1859 1859  
1860 1860  
1861 1861  (% class="western" %)
... ... @@ -2244,6 +2244,14 @@
2244 2244  
2245 2245  
2246 2246  
2091 +
2092 +
2093 +
2094 +
2095 +
2096 +
2097 +
2098 +
2247 2247  (% class="western" %)
2248 2248  **Stats**
2249 2249  
... ... @@ -2417,6 +2417,14 @@
2417 2417  
2418 2418  
2419 2419  
2272 +
2273 +
2274 +
2275 +
2276 +
2277 +
2278 +
2279 +
2420 2420  (% class="western" %)
2421 2421  **Reference**
2422 2422  
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -3539005
1 +3539009
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/3539009/ONEcount API Documentation