Skip to Content
Last modified by Admin on 2025/06/27 12:14
From version 15.1
edited by mikef
on 2017/05/04 11:57
Change comment: There is no comment for this version
To version 3.1
edited by sonish
on 2017/04/03 16:44
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -ONEcount API Documentation
1 +sonish-APIDocument-230317-1008-18
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.mikef
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. This API can be used to lookup, create and update different ONEcount data components 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:
... ... @@ -9,12 +9,15 @@
9 9  
10 10  1. (((
11 11  (% class="western" %)
12 -**GET** - Used for lookup of resourcesresources
13 -)))
60 +**GET** - Used for lookup of resources
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,55 +21,178 @@
21 21  )))
22 22  
23 23  (% class="western" %)
24 -Specifically, the ONEcount API provides to the following components:
75 +ONEcount API provides following functionalities:
25 25  
26 -1. User data
27 -11. List users
28 -11. Lookup users
29 -11. Create users
30 -11. Update users
31 -1. Questions
32 -11. Lookup questions
33 -11. List questions
34 -11. Create questions
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. Transaction data
48 -11. Lookup transactions
49 -11. Create transactions
50 -1. Source Codes
51 -11. Lookup source code
52 -11. Create source codes
53 -11. Update source codes
54 -1. Attach a resource to a product
55 -1. Leads
56 -11. Create a lead
57 -\\\\\\
77 +1. (((
78 +(% class="western" %)
79 +**Lookup**
58 58  
81 +*
82 +
59 59  (% class="western" %)
60 -**Accessing API**
84 +User lookup
61 61  
86 +*
87 +
62 62  (% class="western" %)
63 -**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect"]]
89 +Transaction lookup
64 64  
91 +*
92 +
65 65  (% class="western" %)
66 -**Appkey**: THIS WILL BE PROVIDED TO YOU
94 +Question lookup
67 67  
96 +*
97 +
68 68  (% class="western" %)
69 -**
70 -**
99 +Source code lookup
71 71  
101 +*
102 +
72 72  (% 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" %)
73 73  Your HTTP requests to a REST API resource should contain the following information:
74 74  
75 75  * (((
... ... @@ -90,12 +90,9 @@
90 90  )))
91 91  
92 92  (% class="western" %)
93 -
267 +**Request**
94 94  
95 95  (% class="western" %)
96 -**General API Usage**
97 -
98 -(% class="western" %)
99 99  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.
100 100  
101 101  (% class="western" %)
... ... @@ -224,100 +224,131 @@
224 224  
225 225  
226 226  (% class="western" %)
227 -**
228 -**
398 +**Resources**
229 229  
230 -**COMPONENT: Users**
231 -
232 232  (% class="western" %)
233 -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.
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.
234 234  
403 +* (((
235 235  (% class="western" %)
236 -Additionally (Array of) transaction object specifying parts of the transaction to be added to the new user can be specified. UserId, TransactionId and SubscriptionType will be ignored if specified for this case. As this is new user and new transaction is being added.
405 +questions
406 +)))
407 +* (((
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 +)))
237 237  
238 238  (% class="western" %)
239 -In this case the provided demographic information in users object will be used to create a new user in ONEcount and then a response will be generated. Before creating a new user, a check for duplicate will be performed based on Dedupe columns and if found, and error code will be generated.
433 +**Questions**
240 240  
241 241  (% class="western" %)
242 -If username and password is not one of the parameters being passed, then a random username and password will be generated for the user while creating his user account in ONEcount.
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.
243 243  
244 244  (% class="western" %)
245 -Return parameter will have the comma separated list of question Ids that is requested back from the API.
439 +The data that is sent should be in JSON format and of type questions as described in References section. The type property of questions object is described below. Questions object will only need a choices block if the question is a multiple choice question(type=4 or 5 or 6)
246 246  
247 247  (% class="western" %)
248 -Return is an optional parameter in request. If return is not requested then by default, only UserId (which is ONEcount ID) will be returned in the Users object.
442 +There can be 6 types of questions:
249 249  
250 -
251 -
252 -(% class="wrapped" %)
253 253  |(((
254 -(% class="western" %)
255 -**Method**
445 +(% class="western" align="center" %)
446 +**Type**
256 256  )))|(((
257 257  (% class="western" %)
258 -**Url**
449 +**Description**
450 +)))
451 +|(((
452 +(% class="western" align="center" %)
453 +1
259 259  )))|(((
260 260  (% class="western" %)
261 -**Action**
456 +Textbox type questions or short response type question. The response length needs to be less than 255 characters.
262 262  )))
263 263  |(((
264 -(% class="western" %)
265 -GET
459 +(% class="western" align="center" %)
460 +2
266 266  )))|(((
267 267  (% class="western" %)
268 -/users
463 +Textarea type question or long response type question.
464 +)))
465 +|(((
466 +(% class="western" align="center" %)
467 +3
269 269  )))|(((
270 270  (% class="western" %)
271 -Get users data limiting 25.
470 +Password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *.
272 272  )))
273 273  |(((
473 +(% class="western" align="center" %)
474 +4
475 +)))|(((
274 274  (% class="western" %)
275 -GET
477 +Select or dropdown type questions. This is a multiple choice, 1 response type question. When creating this type of question the choices block also needs to be part of the questions object that will hold the possible choices of the select question.
478 +)))
479 +|(((
480 +(% class="western" align="center" %)
481 +5
276 276  )))|(((
277 277  (% class="western" %)
278 -/users/1
484 +Radio button type question. This is a multiple choice, 1 response type question. When creating this type of question the choices block also needs to be part of the questions object that will hold the possible choices of the radio question.
485 +)))
486 +|(((
487 +(% class="western" align="center" %)
488 +6
279 279  )))|(((
280 280  (% class="western" %)
281 -Get data for user id 1. The user id can be a numeric value or a hash
491 +Checkbox type question. This is a multiple choice, multi response type question. When creating this type of question the choices block also needs to be part of the questions object that will hold the possible choices of the checkbox question.
282 282  )))
493 +
283 283  |(((
284 284  (% class="western" %)
285 -GET
496 +**Method**
286 286  )))|(((
287 287  (% class="western" %)
288 -/users/lookup?1=user1@[[email.com>>url:http://email.com||shape="rect"]]&return=1,2
499 +**Url**
289 289  )))|(((
290 290  (% class="western" %)
291 -Lookup for user whose question id (1) is equal to supplied value. The users object returned will have value of questions 1 & 2. Here for example assumed to be firstname and last name.
292 -
293 -(% class="western" %)
294 -Return parameter defines a csv of question id that are requested back in response.
502 +**Action**
295 295  )))
296 296  |(((
297 297  (% class="western" %)
298 -POST
506 +GET
299 299  )))|(((
300 300  (% class="western" %)
301 -/users
509 +/questions
302 302  )))|(((
303 303  (% class="western" %)
304 -Create a new users
305 -
306 -(% class="western" %)
307 -Parameters required to create the user needs to be sent as post data in JSON format.
512 +List all questions
308 308  )))
309 309  |(((
310 310  (% class="western" %)
311 -PUT
516 +GET
312 312  )))|(((
313 313  (% class="western" %)
314 -/users/1
519 +/questions/1
315 315  )))|(((
316 316  (% class="western" %)
317 -Update user id 1. The user id can be a numeric value or a hash
318 -
319 -(% class="western" %)
320 -Parameters required to update the user needs to be sent as post data in JSON format.
522 +Returns question id 1
321 321  )))
322 322  |(((
323 323  (% class="western" %)
... ... @@ -324,10 +324,10 @@
324 324  GET
325 325  )))|(((
326 326  (% class="western" %)
327 -/users/1/partners/2
529 +/questions/lookup?Text=Email
328 328  )))|(((
329 329  (% class="western" %)
330 -Get user id 1 and partner id 2's ONEcount hash. The user id can be a numeric value or a hash.
532 +Returns all questions with “Email" in question text
331 331  )))
332 332  |(((
333 333  (% class="western" %)
... ... @@ -334,42 +334,33 @@
334 334  POST
335 335  )))|(((
336 336  (% class="western" %)
337 -/users/login
539 +/questions
338 338  )))|(((
339 339  (% class="western" %)
340 -Check to see user exist with username/email and password.
542 +Create a new question
341 341  
342 342  (% class="western" %)
343 -Parameters required to create JSON object with **u** as username, **e** as email and **p** as password and sent is as POST param.
344 -
545 +JSON of the Questions type object needs to be sent as post data. Id field should not be sent.
546 +)))
547 +|(((
345 345  (% class="western" %)
346 -Example:
347 -
549 +PUT
550 +)))|(((
348 348  (% class="western" %)
349 -{"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","e":"abc@[[one-count.com>>url:http://one-count.com||shape="rect"]]","p":"1234"}
350 -
552 +/questions
553 +)))|(((
351 351  (% class="western" %)
352 -OR
555 +Update a question
353 353  
354 354  (% class="western" %)
355 -{"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
356 -
357 -(% class="western" %)
358 -OR
359 -
360 -(% class="western" %)
361 -{"e":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
362 -
363 -(% class="western" %)
364 -**OUTPUT** : Should get ocid of the user if it finds it otherwise get and error with msg user not found.
558 +JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
365 365  )))
366 366  
367 367  
368 368  
369 369  (% class="western" %)
370 -**GET method should be used to lookup users.**
564 +**GET method can be used to lookup questions.**
371 371  
372 -(% class="wrapped" %)
373 373  |(((
374 374  (% class="western" %)
375 375  **Request**
... ... @@ -388,20 +388,18 @@
388 388  String
389 389  )))|(((
390 390  (% class="western" %)
391 -URL encoded key value string parameters for the lookup. Return property has csv of questions id requested back in Users object.
584 +URL encoded key value string parameters for the question that a user is trying to search.
392 392  
393 393  (% class="western" %)
394 -Params: Value of question Ids: Key value for Lookup question ids for e.g. 1=user1@[[email.com>>url:http://email.com||shape="rect"]]
587 +Params:
395 395  
396 396  (% class="western" %)
397 -return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String)
590 +Text: Word or phrase that should be present in the question text (String)
591 +
592 +(% class="western" %)
593 +Type: Look up the question type.
398 398  )))
399 399  
400 -
401 -
402 -
403 -
404 -(% class="wrapped" %)
405 405  |(((
406 406  (% class="western" %)
407 407  **Response**
... ... @@ -414,21 +414,20 @@
414 414  )))
415 415  |(((
416 416  (% class="western" %)
417 -Users
418 -)))|=(((
419 -(% class="western" align="left" %)
420 -Users
608 +Questions
421 421  )))|(((
422 422  (% class="western" %)
423 -Found users returned with the demo field requested in return parameter in json format.
611 +Questions
612 +)))|(((
613 +(% class="western" %)
614 +Returns found question details.
424 424  )))
425 425  
426 426  
427 427  
428 428  (% class="western" %)
429 -**POST method should be used to create users.**
620 +**POST method should be used to create questions. The data that is sent should be in JSON format and of type questions as described in references section. Questions object will only need a choices block if the question is a multiple choice question (type=4 or 5 or 6).**
430 430  
431 -(% class="wrapped" %)
432 432  |(((
433 433  (% class="western" %)
434 434  **Request**
... ... @@ -441,49 +441,44 @@
441 441  )))
442 442  |(((
443 443  (% class="western" %)
444 -Users
634 +Questions
445 445  )))|(((
446 446  (% class="western" %)
447 -Users
637 +Questions
448 448  )))|(((
449 449  (% class="western" %)
450 -Users object that contains information about user to create. PartnerId Needs to be specified.
640 +This defines the question contents and possible responses.
451 451  )))
642 +
452 452  |(((
453 453  (% class="western" %)
454 -Transactions
645 +**Response**
455 455  )))|(((
456 456  (% class="western" %)
457 -Transactions
648 +**Type**
458 458  )))|(((
459 459  (% class="western" %)
460 -(Array of) transaction object specifying parts of the transaction to be added to the new user. UserId and TransactionId, SubscriptionType will be ignored if specified. As this is new user and new transaction is being added.
651 +**Description**
461 461  )))
462 462  |(((
463 463  (% class="western" %)
464 -DedupeColumns
655 +QuestionId
465 465  )))|(((
466 466  (% class="western" %)
467 -String
658 +Int
468 468  )))|(((
469 469  (% class="western" %)
470 -CSV of question id's that should be considered to find duplicate.
661 +Returns ONEcount question id on successful creation of the question.
471 471  )))
472 -|(((
663 +
664 +
665 +
473 473  (% class="western" %)
474 -Return
475 -)))|(((
476 -(% class="western" %)
477 -String
478 -)))|(((
479 -(% class="western" %)
480 -CSV of ONEcount QuestionId's requested back in Users object in response.
481 -)))
667 +PUT method should be used to update question.
482 482  
483 -(% class="wrapped" %)
484 484  |(((
485 485  (% class="western" %)
486 -**Response**
671 +**Request**
487 487  )))|(((
488 488  (% class="western" %)
489 489  **Type**
... ... @@ -493,24 +493,18 @@
493 493  )))
494 494  |(((
495 495  (% class="western" %)
496 -Users
497 -)))|=(((
498 -(% class="western" align="left" %)
499 -Users
681 +Questions
500 500  )))|(((
501 501  (% class="western" %)
502 -Created users returned with the demo field requested in return parameter in json format. If return was not specified only UserId will be returned.
684 +Questions
685 +)))|(((
686 +(% class="western" %)
687 +This defines the question contents and responses.
503 503  )))
504 504  
505 -
506 -
507 -(% class="western" %)
508 -**PUT method should be used to update users.**
509 -
510 -(% class="wrapped" %)
511 511  |(((
512 512  (% class="western" %)
513 -**Request**
692 +**Response**
514 514  )))|(((
515 515  (% class="western" %)
516 516  **Type**
... ... @@ -520,174 +520,167 @@
520 520  )))
521 521  |(((
522 522  (% class="western" %)
523 -Users
702 +QuestionId
524 524  )))|(((
525 525  (% class="western" %)
526 -Users
705 +Int
527 527  )))|(((
528 528  (% class="western" %)
529 -Users object with update fields. Return property has csv of questions id requested back in Users object.
708 +Returns ONEcount question id on successful update of the question.
530 530  )))
531 -|(((
710 +
532 532  (% class="western" %)
533 -Return
534 -)))|(((
712 +
713 +
535 535  (% class="western" %)
536 -String
537 -)))|(((
715 +Example: Get list of questions from api which has FirstName in text
716 +
717 +{{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions/lookup?Text=FirstName}}}
718 +
538 538  (% class="western" %)
539 -CSV of ONEcount QuestionId's requested back in Users object in response
540 -)))
541 -|(((
720 +{
721 +
542 542  (% class="western" %)
543 -RequestDate
544 -)))|(((
723 +"result": {
724 +
545 545  (% class="western" %)
546 -Date
547 -)))|(((
726 +"success": "1",
727 +
548 548  (% class="western" %)
549 -RequestDate to use for the demo update. If not provided current date will be used.
550 -)))
729 +"error": {
551 551  
552 -(% class="wrapped" %)
553 -|(((
554 554  (% class="western" %)
555 -**Response**
556 -)))|(((
732 +"code": "0",
733 +
557 557  (% class="western" %)
558 -**Type**
559 -)))|(((
735 +"message": ""
736 +
560 560  (% class="western" %)
561 -**Description**
562 -)))
563 -|(((
738 +}
739 +
564 564  (% class="western" %)
565 -Users
566 -)))|=(((
567 -(% class="western" align="left" %)
568 -Users
569 -)))|(((
741 +},
742 +
570 570  (% class="western" %)
571 -Updated user returned with the demo field requested in return parameter in json format.
572 -)))
744 +"Questions": [
573 573  
574 574  (% class="western" %)
575 -
747 +{
576 576  
577 577  (% class="western" %)
578 -
750 +"Id": "6",
579 579  
580 580  (% class="western" %)
581 -Create new users. Here in this example the JSON for request is passed in userFile.json file.
753 +"Text": "FirstName",
582 582  
583 -{{{curl -X POST -H “Appkey: xxx” -H "Content-Type: application/json" –data-binary -d '@userFile.json' https://api.onecount.net/v2/users}}}
755 +(% class="western" %)
756 +"Type": "1",
584 584  
585 585  (% class="western" %)
586 -**
587 -**
759 +"Alias": "FName"
588 588  
589 589  (% class="western" %)
590 -**
591 -**
762 +}
592 592  
593 -
764 +(% class="western" %)
765 +]
594 594  
595 595  (% class="western" %)
596 -**COMPONENT: Questions**
768 +}
597 597  
598 598  (% class="western" %)
599 -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).
600 600  
772 +**Users**
773 +
601 601  (% class="western" %)
602 -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.
775 +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.
603 603  
604 604  (% class="western" %)
605 -The data that is sent should be in JSON format and of type questions as described in References section. The type property of questions object is described below. Questions object will only need a choices block if the question is a multiple choice question(type=4 or 5 or 6)
778 +Additionally (Array of) transaction object specifying parts of the transaction to be added to the new user can be specified. UserId, TransactionId and SubscriptionType will be ignored if specified for this case. As this is new user and new transaction is being added.
606 606  
607 607  (% class="western" %)
608 -There can be 6 types of questions:
781 +In this case the provided demographic information in users object will be used to create a new user in ONEcount and then a response will be generated. Before creating a new user, a check for duplicate will be performed based on Dedupe columns and if found, and error code will be generated.
609 609  
610 -(% class="wrapped" %)
611 -|(((
612 -(% class="western" align="center" %)
613 -**Type**
614 -)))|(((
615 615  (% class="western" %)
616 -**Description**
617 -)))
784 +If username and password is not one of the parameters being passed, then a random username and password will be generated for the user while creating his user account in ONEcount.
785 +
786 +(% class="western" %)
787 +Return parameter will have the comma separated list of question Ids that is requested back from the API.
788 +
789 +(% class="western" %)
790 +Return is an optional parameter in request. If return is not requested then by default, only UserId (which is ONEcount ID) will be returned in the Users object.
791 +
792 +(% class="western" %)
793 +
794 +
618 618  |(((
619 -(% class="western" align="center" %)
620 -1
796 +(% class="western" %)
797 +**Method**
621 621  )))|(((
622 622  (% class="western" %)
623 -Textbox type questions or short response type question. The response length needs to be less than 255 characters.
624 -)))
625 -|(((
626 -(% class="western" align="center" %)
627 -2
800 +**Url**
628 628  )))|(((
629 629  (% class="western" %)
630 -Textarea type question or long response type question.
803 +**Action**
631 631  )))
632 632  |(((
633 -(% class="western" align="center" %)
634 -3
806 +(% class="western" %)
807 +GET
635 635  )))|(((
636 636  (% class="western" %)
637 -Password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *.
638 -)))
639 -|(((
640 -(% class="western" align="center" %)
641 -4
810 +/users
642 642  )))|(((
643 643  (% class="western" %)
644 -Select or dropdown type questions. This is a multiple choice, 1 response type question. When creating this type of question the choices block also needs to be part of the questions object that will hold the possible choices of the select question.
813 +Get users data limiting 25.
645 645  )))
646 646  |(((
647 -(% class="western" align="center" %)
648 -5
816 +(% class="western" %)
817 +GET
649 649  )))|(((
650 650  (% class="western" %)
651 -Radio button type question. This is a multiple choice, 1 response type question. When creating this type of question the choices block also needs to be part of the questions object that will hold the possible choices of the radio question.
652 -)))
653 -|(((
654 -(% class="western" align="center" %)
655 -6
820 +/users/1
656 656  )))|(((
657 657  (% class="western" %)
658 -Checkbox type question. This is a multiple choice, multi response type question. When creating this type of question the choices block also needs to be part of the questions object that will hold the possible choices of the checkbox question.
823 +Get data for user id 1. The user id can be a numeric value or a hash
659 659  )))
660 -
661 -(% class="wrapped" %)
662 662  |(((
663 663  (% class="western" %)
664 -**Method**
827 +GET
665 665  )))|(((
666 666  (% class="western" %)
667 -**Url**
830 +/users/lookup?1=user1@[[email.com>>url:http://email.com||shape="rect"]]&return=1,2
668 668  )))|(((
669 669  (% class="western" %)
670 -**Action**
833 +Lookup for user whose question id (1) is equal to supplied value. The users object returned will have value of questions 1 & 2. Here for example assumed to be firstname and last name.
834 +
835 +(% class="western" %)
836 +Return parameter defines a csv of question id that are requested back in response.
671 671  )))
672 672  |(((
673 673  (% class="western" %)
674 -GET
840 +POST
675 675  )))|(((
676 676  (% class="western" %)
677 -/questions
843 +/users
678 678  )))|(((
679 679  (% class="western" %)
680 -List all questions
846 +Create a new users
847 +
848 +(% class="western" %)
849 +Parameters required to create the user needs to be sent as post data in JSON format.
681 681  )))
682 682  |(((
683 683  (% class="western" %)
684 -GET
853 +PUT
685 685  )))|(((
686 686  (% class="western" %)
687 -/questions/1
856 +/users/1
688 688  )))|(((
689 689  (% class="western" %)
690 -Returns question id 1
859 +Update user id 1. The user id can be a numeric value or a hash
860 +
861 +(% class="western" %)
862 +Parameters required to update the user needs to be sent as post data in JSON format.
691 691  )))
692 692  |(((
693 693  (% class="western" %)
... ... @@ -694,10 +694,10 @@
694 694  GET
695 695  )))|(((
696 696  (% class="western" %)
697 -/questions/lookup?Text=Email
869 +/users/1/partners/2
698 698  )))|(((
699 699  (% class="western" %)
700 -Returns all questions with “Email" in question text
872 +Get user id 1 and partner id 2's ONEcount hash. The user id can be a numeric value or a hash.
701 701  )))
702 702  |(((
703 703  (% class="western" %)
... ... @@ -704,34 +704,41 @@
704 704  POST
705 705  )))|(((
706 706  (% class="western" %)
707 -/questions
879 +/users/login
708 708  )))|(((
709 709  (% class="western" %)
710 -Create a new question
882 +Check to see user exist with username/email and password.
711 711  
712 712  (% class="western" %)
713 -JSON of the Questions type object needs to be sent as post data. Id field should not be sent.
714 -)))
715 -|(((
885 +Parameters required to create JSON object with **u** as username, **e** as email and **p** as password and sent is as POST param.
886 +
716 716  (% class="western" %)
717 -PUT
718 -)))|(((
888 +Example:
889 +
719 719  (% class="western" %)
720 -/questions
721 -)))|(((
891 +{"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","e":"abc@[[one-count.com>>url:http://one-count.com||shape="rect"]]","p":"1234"}
892 +
722 722  (% class="western" %)
723 -Update a question
894 +OR
724 724  
725 725  (% class="western" %)
726 -JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
897 +{"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
898 +
899 +(% class="western" %)
900 +OR
901 +
902 +(% class="western" %)
903 +{"e":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
904 +
905 +(% class="western" %)
906 +**OUTPUT** : Should get ocid of the user if it finds it otherwise get and error with msg user not found.
727 727  )))
728 728  
729 729  
730 730  
731 731  (% class="western" %)
732 -**GET method can be used to lookup questions.**
912 +**GET method should be used to lookup users.**
733 733  
734 -(% class="wrapped" %)
735 735  |(((
736 736  (% class="western" %)
737 737  **Request**
... ... @@ -750,19 +750,19 @@
750 750  String
751 751  )))|(((
752 752  (% class="western" %)
753 -URL encoded key value string parameters for the question that a user is trying to search.
932 +URL encoded key value string parameters for the lookup. Return property has csv of questions id requested back in Users object.
754 754  
755 755  (% class="western" %)
756 -Params:
935 +Params: Value of question Ids: Key value for Lookup question ids for e.g. 1=user1@[[email.com>>url:http://email.com||shape="rect"]]
757 757  
758 758  (% class="western" %)
759 -Text: Word or phrase that should be present in the question text (String)
760 -
761 -(% class="western" %)
762 -Type: Look up the question type.
938 +return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String)
763 763  )))
764 764  
765 -(% class="wrapped" %)
941 +
942 +
943 +
944 +
766 766  |(((
767 767  (% class="western" %)
768 768  **Response**
... ... @@ -775,21 +775,20 @@
775 775  )))
776 776  |(((
777 777  (% class="western" %)
778 -Questions
957 +Users
958 +)))|=(((
959 +(% class="western" align="left" %)
960 +Users
779 779  )))|(((
780 780  (% class="western" %)
781 -Questions
782 -)))|(((
783 -(% class="western" %)
784 -Returns found question details.
963 +Found users returned with the demo field requested in return parameter in json format.
785 785  )))
786 786  
787 787  
788 788  
789 789  (% class="western" %)
790 -**POST method should be used to create questions. The data that is sent should be in JSON format and of type questions as described in references section. Questions object will only need a choices block if the question is a multiple choice question (type=4 or 5 or 6).**
969 +**POST method should be used to create users.**
791 791  
792 -(% class="wrapped" %)
793 793  |(((
794 794  (% class="western" %)
795 795  **Request**
... ... @@ -802,46 +802,48 @@
802 802  )))
803 803  |(((
804 804  (% class="western" %)
805 -Questions
983 +Users
806 806  )))|(((
807 807  (% class="western" %)
808 -Questions
986 +Users
809 809  )))|(((
810 810  (% class="western" %)
811 -This defines the question contents and possible responses.
989 +Users object that contains information about user to create. PartnerId Needs to be specified.
812 812  )))
813 -
814 -(% class="wrapped" %)
815 815  |(((
816 816  (% class="western" %)
817 -**Response**
993 +Transactions
818 818  )))|(((
819 819  (% class="western" %)
820 -**Type**
996 +Transactions
821 821  )))|(((
822 822  (% class="western" %)
823 -**Description**
999 +(Array of) transaction object specifying parts of the transaction to be added to the new user. UserId and TransactionId, SubscriptionType will be ignored if specified. As this is new user and new transaction is being added.
824 824  )))
825 825  |(((
826 826  (% class="western" %)
827 -QuestionId
1003 +DedupeColumns
828 828  )))|(((
829 829  (% class="western" %)
830 -Int
1006 +String
831 831  )))|(((
832 832  (% class="western" %)
833 -Returns ONEcount question id on successful creation of the question.
1009 +CSV of question id's that should be considered to find duplicate.
834 834  )))
835 -
836 -
837 -
1011 +|(((
838 838  (% class="western" %)
839 -PUT method should be used to update question.
1013 +Return
1014 +)))|(((
1015 +(% class="western" %)
1016 +String
1017 +)))|(((
1018 +(% class="western" %)
1019 +CSV of ONEcount QuestionId's requested back in Users object in response.
1020 +)))
840 840  
841 -(% class="wrapped" %)
842 842  |(((
843 843  (% class="western" %)
844 -**Request**
1024 +**Response**
845 845  )))|(((
846 846  (% class="western" %)
847 847  **Type**
... ... @@ -851,19 +851,23 @@
851 851  )))
852 852  |(((
853 853  (% class="western" %)
854 -Questions
1034 +Users
1035 +)))|=(((
1036 +(% class="western" align="left" %)
1037 +Users
855 855  )))|(((
856 856  (% class="western" %)
857 -Questions
858 -)))|(((
859 -(% class="western" %)
860 -This defines the question contents and responses.
1040 +Created users returned with the demo field requested in return parameter in json format. If return was not specified only UserId will be returned.
861 861  )))
862 862  
863 -(% class="wrapped" %)
1043 +
1044 +
1045 +(% class="western" %)
1046 +**PUT method should be used to update users.**
1047 +
864 864  |(((
865 865  (% class="western" %)
866 -**Response**
1050 +**Request**
867 867  )))|(((
868 868  (% class="western" %)
869 869  **Type**
... ... @@ -873,84 +873,73 @@
873 873  )))
874 874  |(((
875 875  (% class="western" %)
876 -QuestionId
1060 +Users
877 877  )))|(((
878 878  (% class="western" %)
879 -Int
1063 +Users
880 880  )))|(((
881 881  (% class="western" %)
882 -Returns ONEcount question id on successful update of the question.
1066 +Users object with update fields. Return property has csv of questions id requested back in Users object.
883 883  )))
884 -
1068 +|(((
885 885  (% class="western" %)
886 -
887 -
1070 +Return
1071 +)))|(((
888 888  (% class="western" %)
889 -Example: Get list of questions from api which has FirstName in text
890 -
891 -{{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions/lookup?Text=FirstName}}}
892 -
1073 +String
1074 +)))|(((
893 893  (% class="western" %)
894 -{
895 -
1076 +CSV of ONEcount QuestionId's requested back in Users object in response
1077 +)))
1078 +|(((
896 896  (% class="western" %)
897 -"result": {
898 -
1080 +RequestDate
1081 +)))|(((
899 899  (% class="western" %)
900 -"success": "1",
901 -
1083 +Date
1084 +)))|(((
902 902  (% class="western" %)
903 -"error": {
1086 +RequestDate to use for the demo update. If not provided current date will be used.
1087 +)))
904 904  
1089 +|(((
905 905  (% class="western" %)
906 -"code": "0",
907 -
1091 +**Response**
1092 +)))|(((
908 908  (% class="western" %)
909 -"message": ""
910 -
1094 +**Type**
1095 +)))|(((
911 911  (% class="western" %)
912 -}
913 -
1097 +**Description**
1098 +)))
1099 +|(((
914 914  (% class="western" %)
915 -},
916 -
1101 +Users
1102 +)))|=(((
1103 +(% class="western" align="left" %)
1104 +Users
1105 +)))|(((
917 917  (% class="western" %)
918 -"Questions": [
1107 +Updated user returned with the demo field requested in return parameter in json format.
1108 +)))
919 919  
920 920  (% class="western" %)
921 -{
1111 +
922 922  
923 923  (% class="western" %)
924 -"Id": "6",
1114 +
925 925  
926 926  (% class="western" %)
927 -"Text": "FirstName",
1117 +Create new users. Here in this example the JSON for request is passed in userFile.json file.
928 928  
929 -(% class="western" %)
930 -"Type": "1",
1119 +{{{curl -X POST -H “Appkey: xxx” -H "Content-Type: application/json" –data-binary -d '@userFile.json' https://api.onecount.net/v2/users}}}
931 931  
932 932  (% class="western" %)
933 -"Alias": "FName"
1122 +**Products**
934 934  
935 935  (% class="western" %)
936 -}
937 -
938 -(% class="western" %)
939 -]
940 -
941 -(% class="western" %)
942 -}
943 -
944 -(% class="western" %)
945 -
946 -
947 -(% class="western" %)
948 -**COMPONENT: Products**
949 -
950 -(% class="western" %)
951 951  This resource is for manipulating products resource. A product can be created, updated or searched.
952 952  
953 -(% class="wrapped" %)
954 954  |(((
955 955  (% class="western" %)
956 956  **Method**
... ... @@ -1036,7 +1036,6 @@
1036 1036  (% class="western" %)
1037 1037  **GET method should be used to lookup products.**
1038 1038  
1039 -(% class="wrapped" %)
1040 1040  |(((
1041 1041  (% class="western" %)
1042 1042  **Request**
... ... @@ -1064,7 +1064,6 @@
1064 1064  Name: Name of the Product for lookup (String)
1065 1065  )))
1066 1066  
1067 -(% class="wrapped" %)
1068 1068  |(((
1069 1069  (% class="western" %)
1070 1070  **Response**
... ... @@ -1091,7 +1091,6 @@
1091 1091  (% class="western" %)
1092 1092  **POST method should be used to create products.**
1093 1093  
1094 -(% class="wrapped" %)
1095 1095  |(((
1096 1096  (% class="western" %)
1097 1097  **Request**
... ... @@ -1116,10 +1116,9 @@
1116 1116  Example:
1117 1117  
1118 1118  (% class="western" %)
1119 -{"Title":"Test123","Description": "Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1289 +{"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1120 1120  )))
1121 1121  
1122 -(% class="wrapped" %)
1123 1123  |(((
1124 1124  (% class="western" %)
1125 1125  **Response**
... ... @@ -1146,7 +1146,6 @@
1146 1146  (% class="western" %)
1147 1147  PUT method should be used to update an individual product given the product info.
1148 1148  
1149 -(% class="wrapped" %)
1150 1150  |(((
1151 1151  (% class="western" %)
1152 1152  **Request**
... ... @@ -1174,10 +1174,9 @@
1174 1174  **Example**:
1175 1175  
1176 1176  (% class="western" %)
1177 -{"Title":"Test123","Description": "Testss","PrimaryFormId":10,"ResourceID":17}
1345 +{"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1178 1178  )))
1179 1179  
1180 -(% class="wrapped" %)
1181 1181  |(((
1182 1182  (% class="western" %)
1183 1183  **Response**
... ... @@ -1202,12 +1202,11 @@
1202 1202  
1203 1203  
1204 1204  (% class="western" %)
1205 -**COMPONENT: Terms**
1372 +**Terms**
1206 1206  
1207 1207  (% class="western" %)
1208 1208  This resource is for manipulating terms resource. A term can be created, updated or searched.
1209 1209  
1210 -(% class="wrapped" %)
1211 1211  |(((
1212 1212  (% class="western" %)
1213 1213  **Method**
... ... @@ -1264,7 +1264,6 @@
1264 1264  (% class="western" %)
1265 1265  **GET method should be used to lookup products.**
1266 1266  
1267 -(% class="wrapped" %)
1268 1268  |(((
1269 1269  (% class="western" %)
1270 1270  **Request**
... ... @@ -1292,7 +1292,6 @@
1292 1292  Name: Name of the term for lookup (String)
1293 1293  )))
1294 1294  
1295 -(% class="wrapped" %)
1296 1296  |(((
1297 1297  (% class="western" %)
1298 1298  **Response**
... ... @@ -1319,7 +1319,6 @@
1319 1319  (% class="western" %)
1320 1320  **POST method should be used to create products.**
1321 1321  
1322 -(% class="wrapped" %)
1323 1323  |(((
1324 1324  (% class="western" %)
1325 1325  **Request**
... ... @@ -1350,7 +1350,6 @@
1350 1350  {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
1351 1351  )))
1352 1352  
1353 -(% class="wrapped" %)
1354 1354  |(((
1355 1355  (% class="western" %)
1356 1356  **Response**
... ... @@ -1377,7 +1377,6 @@
1377 1377  (% class="western" %)
1378 1378  PUT method should be used to update an individual term given the term info.
1379 1379  
1380 -(% class="wrapped" %)
1381 1381  |(((
1382 1382  (% class="western" %)
1383 1383  **Request**
... ... @@ -1408,7 +1408,6 @@
1408 1408  {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
1409 1409  )))
1410 1410  
1411 -(% class="wrapped" %)
1412 1412  |(((
1413 1413  (% class="western" %)
1414 1414  **Response**
... ... @@ -1433,48 +1433,11 @@
1433 1433  
1434 1434  
1435 1435  (% class="western" %)
1436 -**COMPONENT: Resources**
1596 +**Resources**
1437 1437  
1438 1438  (% class="western" %)
1439 -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.
1440 -
1441 -* (((
1442 -(% class="western" %)
1443 -questions
1444 -)))
1445 -* (((
1446 -(% class="western" %)
1447 -users
1448 -)))
1449 -* (((
1450 -(% class="western" %)
1451 -products
1452 -)))
1453 -* (((
1454 -(% class="western" %)
1455 -terms
1456 -)))
1457 -* (((
1458 -(% class="western" %)
1459 -resources
1460 -)))
1461 -* (((
1462 -(% class="western" %)
1463 -sources
1464 -)))
1465 -* (((
1466 -(% class="western" %)
1467 -transactions
1468 -)))
1469 -
1470 -(% class="western" %)
1471 -**
1472 -**
1473 -
1474 -(% class="western" %)
1475 1475  This resource is for manipulating resources resource. A resource can be created, updated or searched.
1476 1476  
1477 -(% class="wrapped" %)
1478 1478  |(((
1479 1479  (% class="western" %)
1480 1480  **Method**
... ... @@ -1529,9 +1529,8 @@
1529 1529  
1530 1530  
1531 1531  (% class="western" %)
1532 -**GET method should be used to lookup resources.**
1655 +**GET method should be used to lookup products.**
1533 1533  
1534 -(% class="wrapped" %)
1535 1535  |(((
1536 1536  (% class="western" %)
1537 1537  **Request**
... ... @@ -1559,7 +1559,6 @@
1559 1559  Name: Name of the resource for lookup (String)
1560 1560  )))
1561 1561  
1562 -(% class="wrapped" %)
1563 1563  |(((
1564 1564  (% class="western" %)
1565 1565  **Response**
... ... @@ -1584,9 +1584,8 @@
1584 1584  
1585 1585  
1586 1586  (% class="western" %)
1587 -**POST method should be used to create resources.**
1708 +**POST method should be used to create products.**
1588 1588  
1589 -(% class="wrapped" %)
1590 1590  |(((
1591 1591  (% class="western" %)
1592 1592  **Request**
... ... @@ -1608,7 +1608,7 @@
1608 1608  resource details in json to be sent as post data. Id should not be set.
1609 1609  
1610 1610  (% class="western" %)
1611 -**Possible Request Params**: Name, Description, Type, Value, FreePass
1731 +**Possible Request Params**: Name, Description, Type, Value
1612 1612  
1613 1613  (% class="western" %)
1614 1614  **Example**:
... ... @@ -1615,18 +1615,8 @@
1615 1615  
1616 1616  (% class="western" %)
1617 1617  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1618 -
1619 -(% class="western" %)
1620 -{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"]}
1621 -
1622 -(% class="western" %)
1623 -{"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”, "FreePass":1}
1624 -
1625 -(% class="western" %)
1626 -{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"],"FreePass":1}
1627 1627  )))
1628 1628  
1629 -(% class="wrapped" %)
1630 1630  |(((
1631 1631  (% class="western" %)
1632 1632  **Response**
... ... @@ -1653,7 +1653,6 @@
1653 1653  (% class="western" %)
1654 1654  PUT method should be used to update an individual resource given the resource info.
1655 1655  
1656 -(% class="wrapped" %)
1657 1657  |(((
1658 1658  (% class="western" %)
1659 1659  **Request**
... ... @@ -1672,28 +1672,18 @@
1672 1672  Resource
1673 1673  )))|(((
1674 1674  (% class="western" %)
1675 -Resource details to be updated injsonformat to be sent withrequest. Id property needs to be set to identify the resource to be updated.
1784 +Resource details to be updated in json format to be sent with request. Id property needs to be set to identify the resource to be updated.
1676 1676  
1677 1677  (% class="western" %)
1678 1678  
1679 1679  
1680 1680  (% class="western" %)
1681 -Examples:
1790 +Example:
1682 1682  
1683 1683  (% class="western" %)
1684 1684  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
1685 -
1686 -(% class="western" %)
1687 -{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"]}
1688 -
1689 -(% class="western" %)
1690 -{"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”,"FreePass":1}
1691 -
1692 -(% class="western" %)
1693 -{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"],"FreePass":1}
1694 1694  )))
1695 1695  
1696 -(% class="wrapped" %)
1697 1697  |(((
1698 1698  (% class="western" %)
1699 1699  **Response**
... ... @@ -1717,6 +1717,7 @@
1717 1717  
1718 1718  
1719 1719  
1819 +(% class="western" %)
1720 1720  
1721 1721  
1722 1722  (% class="western" %)
... ... @@ -1723,13 +1723,11 @@
1723 1723  
1724 1724  
1725 1725  (% class="western" %)
1726 -**COMPONENT: Source Codes
1727 -**
1826 +**Sources**
1728 1728  
1729 1729  (% class="western" %)
1730 -This resource is for manipulating source code for a resource. A source code can be created, updated or searched.
1829 +This resource is for manipulating sources resource. A source can be created, updated or searched.
1731 1731  
1732 -(% class="wrapped" %)
1733 1733  |(((
1734 1734  (% class="western" %)
1735 1735  **Method**
... ... @@ -1786,7 +1786,6 @@
1786 1786  (% class="western" %)
1787 1787  **Sources can be looked up given the code or Id. GET method should be used for lookup.**
1788 1788  
1789 -(% class="wrapped" %)
1790 1790  |(((
1791 1791  (% class="western" %)
1792 1792  **Request**
... ... @@ -1814,7 +1814,6 @@
1814 1814  Source: Source value (String)
1815 1815  )))
1816 1816  
1817 -(% class="wrapped" %)
1818 1818  |(((
1819 1819  (% class="western" %)
1820 1820  **Response**
... ... @@ -1844,7 +1844,6 @@
1844 1844  (% class="western" %)
1845 1845  POST method should be used to create an individual source given the source parameters.
1846 1846  
1847 -(% class="wrapped" %)
1848 1848  |(((
1849 1849  (% class="western" %)
1850 1850  **Request**
... ... @@ -1866,7 +1866,6 @@
1866 1866  Defines the contents that makes up the source. Id parameters should not be set.
1867 1867  )))
1868 1868  
1869 -(% class="wrapped" %)
1870 1870  |(((
1871 1871  (% class="western" %)
1872 1872  **Response**
... ... @@ -1893,7 +1893,6 @@
1893 1893  (% class="western" %)
1894 1894  **PUT method can be used to update an individual source given the id.**
1895 1895  
1896 -(% class="wrapped" %)
1897 1897  |(((
1898 1898  (% class="western" %)
1899 1899  **Request**
... ... @@ -1915,7 +1915,6 @@
1915 1915  Defines the contents that makes up the source. The id parameter needs to be set which will identify the id of the source to be updated.
1916 1916  )))
1917 1917  
1918 -(% class="wrapped" %)
1919 1919  |(((
1920 1920  (% class="western" %)
1921 1921  **Response**
... ... @@ -1943,12 +1943,11 @@
1943 1943  
1944 1944  
1945 1945  (% class="western" %)
1946 -**COMPONENT: Transactions**
2038 +**Transactions**
1947 1947  
1948 1948  (% class="western" %)
1949 1949  This resource is for manipulating transactions resource. A transaction can be created or searched.
1950 1950  
1951 -(% class="wrapped" %)
1952 1952  |(((
1953 1953  (% class="western" %)
1954 1954  **Method**
... ... @@ -1998,7 +1998,6 @@
1998 1998  (% class="western" %)
1999 1999  Transactions can be looked up using transactionId, date range, userid. Use GET method to do lookup.
2000 2000  
2001 -(% class="wrapped" %)
2002 2002  |(((
2003 2003  (% class="western" %)
2004 2004  **Request**
... ... @@ -2036,7 +2036,6 @@
2036 2036  
2037 2037  
2038 2038  
2039 -(% class="wrapped" %)
2040 2040  |(((
2041 2041  (% class="western" %)
2042 2042  **Response**
... ... @@ -2063,7 +2063,6 @@
2063 2063  (% class="western" %)
2064 2064  POST method can be used to create user transaction. Transaction info needs to be sent as request and a TransactionId will be returned when the transaction is created.
2065 2065  
2066 -(% class="wrapped" %)
2067 2067  |(((
2068 2068  (% class="western" %)
2069 2069  **Request**
... ... @@ -2085,7 +2085,6 @@
2085 2085  Contains fields that define a transaction. Id field should not be set.
2086 2086  )))
2087 2087  
2088 -(% class="wrapped" %)
2089 2089  |(((
2090 2090  (% class="western" %)
2091 2091  **Response**
... ... @@ -2109,11 +2109,8 @@
2109 2109  
2110 2110  
2111 2111  
2112 -
2113 -
2114 2114  (% class="western" %)
2115 -**COMPONENT: Leads
2116 -**
2200 +**Stats**
2117 2117  
2118 2118  (% class="western" %)
2119 2119  Stats resource can be used to submit any type of stat collected on the third party systems. Each type of stat will be represented by a sub-resource. So, for telemarketing it could be **/stats/telemarketing** endpoint, for videos it can be **/stats/videos**, for webinar it could be **/stats/webinars** etc. Right now we only have telemarketing sub-resource.
... ... @@ -2134,14 +2134,12 @@
2134 2134  
2135 2135  
2136 2136  (% class="western" %)
2137 -**Telemarketing Leads
2138 -**
2221 +**Telemarketing**
2139 2139  
2140 2140  (% class="western" %)
2141 2141  
2142 2142  This resource is for manipulating telemarketing stat resource. A telemarketing stat can be created or listed.
2143 2143  
2144 -(% class="wrapped" %)
2145 2145  |(((
2146 2146  (% class="western" %)
2147 2147  **Method**
... ... @@ -2188,7 +2188,6 @@
2188 2188  (% class="western" %)
2189 2189  POST method can be used to create telemarketing stat. Telemarketing info needs to be sent as request and an Id will be returned when the transaction is created.
2190 2190  
2191 -(% class="wrapped" %)
2192 2192  |(((
2193 2193  (% class="western" %)
2194 2194  **Request**
... ... @@ -2262,7 +2262,6 @@
2262 2262  
2263 2263  )))
2264 2264  
2265 -(% class="wrapped" %)
2266 2266  |(((
2267 2267  (% class="western" %)
2268 2268  **Response**
... ... @@ -2286,21 +2286,12 @@
2286 2286  
2287 2287  
2288 2288  
2289 -
2290 -
2291 -
2292 -
2293 -
2294 -
2295 -
2296 -
2297 2297  (% class="western" %)
2298 -**API REFERENCE**
2370 +**Reference**
2299 2299  
2300 2300  (% class="western" %)
2301 2301  **Type: Questions**
2302 2302  
2303 -(% class="wrapped" %)
2304 2304  |(((
2305 2305  (% class="western" %)
2306 2306  **Property Name**
... ... @@ -2380,7 +2380,6 @@
2380 2380  (% class="western" %)
2381 2381  **Type: Choices**
2382 2382  
2383 -(% class="wrapped" %)
2384 2384  |(((
2385 2385  (% class="western" %)
2386 2386  **Property Name**
... ... @@ -2447,7 +2447,6 @@
2447 2447  (% class="western" %)
2448 2448  **Type: Users**
2449 2449  
2450 -(% class="wrapped" %)
2451 2451  |(((
2452 2452  (% class="western" %)
2453 2453  **Property Name**
... ... @@ -2504,7 +2504,6 @@
2504 2504  (% class="western" %)
2505 2505  **Type: Demo**
2506 2506  
2507 -(% class="wrapped" %)
2508 2508  |(((
2509 2509  (% class="western" %)
2510 2510  **Property Name**
... ... @@ -2551,7 +2551,6 @@
2551 2551  (% class="western" %)
2552 2552  **Type: Transactions**
2553 2553  
2554 -(% class="wrapped" %)
2555 2555  |(((
2556 2556  (% class="western" %)
2557 2557  **Property Name**
... ... @@ -2698,7 +2698,6 @@
2698 2698  (% class="western" %)
2699 2699  **Type: Sources**
2700 2700  
2701 -(% class="wrapped" %)
2702 2702  |(((
2703 2703  (% class="western" %)
2704 2704  **Property Name**
... ... @@ -2758,7 +2758,6 @@
2758 2758  (% class="western" %)
2759 2759  **Type: Products**
2760 2760  
2761 -(% class="wrapped" %)
2762 2762  |(((
2763 2763  (% class="western" %)
2764 2764  **Property Name**
... ... @@ -2815,7 +2815,6 @@
2815 2815  (% class="western" %)
2816 2816  **Type: Terms**
2817 2817  
2818 -(% class="wrapped" %)
2819 2819  |(((
2820 2820  (% class="western" %)
2821 2821  **Property Name**
... ... @@ -2902,7 +2902,6 @@
2902 2902  (% class="western" %)
2903 2903  **Type: Resources**
2904 2904  
2905 -(% class="wrapped" %)
2906 2906  |(((
2907 2907  (% class="western" %)
2908 2908  **Property Name**
... ... @@ -2974,30 +2974,14 @@
2974 2974  )))|(((
2975 2975  (% class="western" %)
2976 2976  String
2977 -
2978 -(% class="western" %)
2979 -or
2980 -
2981 -(% class="western" %)
2982 -Array
2983 2983  )))|(((
2984 2984  (% class="western" %)
2985 -Value of Resource Type:
3042 +Value of Resource Type.
2986 2986  
2987 2987  (% class="western" %)
2988 -When requesting a resource (GET), you should expect a string if there is only one value. If there are multiple values, you should expect an array.
3045 +Example : if the Type sent is 3 then Value would be **/digital/**
2989 2989  
2990 2990  (% class="western" %)
2991 -For creating/updating a resource (POST/PUT), it is highly recommended to send an array - this will handle single and multiple value requests.
2992 -
2993 -(% class="western" %)
2994 -Example :
2995 -
2996 -(% class="western" %)
2997 -if the Type sent is 3 with one value then Value would be "**/digital/**" or **["/digital"/].** We recommend using the second approach of **["/digital"/].** **
2998 -**if the Type sent is 3 with two values then Value would be ["**/digital/**", "**/articles/**"]
2999 -
3000 -(% class="western" %)
3001 3001  For Function type resource leave it blank.
3002 3002  )))
3003 3003  |(((
... ... @@ -3008,18 +3008,8 @@
3008 3008  Int
3009 3009  )))|(((
3010 3010  (% class="western" %)
3011 -Default limit is 25 but if all the data needs to be pulled then pass limit=0.
3058 +Default limit is 25 but all the data needs to be pulled then pass limit=0.
3012 3012  )))
3013 -|(% colspan="1" %)(% colspan="1" %)
3014 -(((
3015 -FreePass
3016 -)))|(% colspan="1" %)(% colspan="1" %)
3017 -(((
3018 -Int
3019 -)))|(% colspan="1" %)(% colspan="1" %)
3020 -(((
3021 -Default value is 0. This parameter is used to provide access to protected content.
3022 -)))
3023 3023  
3024 3024  
3025 3025  
... ... @@ -3026,7 +3026,6 @@
3026 3026  (% class="western" %)
3027 3027  **Type: Telemarketing**
3028 3028  
3029 -(% class="wrapped" %)
3030 3030  |(((
3031 3031  (% class="western" %)
3032 3032  **Property Name**
Confluence.Code.ConfluencePageClass[0]
id
... ... @@ -1,1 +1,1 @@
1 -23331811
1 +3538998
url
... ... @@ -1,1 +1,1 @@
1 -https://info.onecount.net//wiki/spaces/OD/pages/23331811/ONEcount API Documentation
1 +https://info.onecount.net//wiki/spaces/OD/pages/3538998/sonish-APIDocument-230317-1008-18