Version 3.1 by sonish on 2017/04/03 16:44

Hide last authors
sonish 3.1 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 (% class="western" %)
50 **Introduction**
51
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.
54
55 (% class="western" %)
56 REST takes advantage of the HTTP request methods to layer itself into the existing HTTP architecture. These operations consist of the following:
57
58 1. (((
59 (% class="western" %)
60 **GET** - Used for lookup of resources
61
62 * (((
63 1. (((
64 (% class="western" %)
65 **PUT** - Used to update a resource
66 )))
67 )))
68 )))
69 1. (((
70 (% class="western" %)
71 **POST** - Used to create a new resource
72 )))
73
74 (% class="western" %)
sonish 1.1 75 ONEcount API provides following functionalities:
76
sonish 3.1 77 1. (((
78 (% class="western" %)
79 **Lookup**
sonish 1.1 80
sonish 3.1 81 *
82
83 (% class="western" %)
84 User lookup
85
86 *
87
88 (% class="western" %)
89 Transaction lookup
90
91 *
92
93 (% class="western" %)
94 Question lookup
95
96 *
97
98 (% class="western" %)
99 Source code lookup
100
101 *
102
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" %)
sonish 1.1 123 Add a user/demo
sonish 3.1 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" %)
sonish 1.1 210
sonish 3.1 211
212 1. (((
213 (% class="western" %)
214 **Attach**
215 )))
216
217 * (((
218 (% class="western" %)
219 Attach resource to product
220 )))
221
222 (% class="western" %)
sonish 1.1 223
224
sonish 3.1 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 Your HTTP requests to a REST API resource should contain the following information:
248
249 * (((
250 (% class="western" %)
251 An HTTP method GET, POST, PUT.
252 )))
253 * (((
254 (% class="western" %)
255 An Appkey sent as Appkey header in the http request to authenticate the request.
256 )))
257 * (((
258 (% class="western" %)
259 Resource name in the url (/resourcename)
260 )))
261 * (((
262 (% class="western" %)
263 Any JSON data or JSON files containing information needed for requests, such as updating a record with new information.
264 )))
265
266 (% class="western" %)
267 **Request**
268
269 (% class="western" %)
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
272 (% class="western" %)
273 For lookup, the parameter list will be part of the request url.
274
275 (% class="western" %)
276
277
278 (% class="western" %)
279 **Response**
280
281 (% class="western" %)
282 API will output the response in a JSON format discussed below.
283
284 (% class="western" %)
285 {
286
287 (% class="western" %)
288 "result": {
289
290 (% class="western" %)
291 "success": "1",
292
293 (% class="western" %)
294 "error": {
295
296 (% class="western" %)
297 "code": "0",
298
299 (% class="western" %)
300 "message": ""
301
302 (% class="western" %)
303 }
304
305 (% class="western" %)
306 },
307
308 (% class="western" %)
309 "Users": {
310
311 (% class="western" %)
312 "Id": "12562",
313
314 (% class="western" %)
315 "PartnerId": "5467",
316
317 (% class="western" %)
318 "Demo": {
319
320 (% class="western" %)
321 "6": "Sundeep",
322
323 (% class="western" %)
324 "7": "Dangol"
325
326 (% class="western" %)
327 }
328
329 (% class="western" %)
330 }
331
332 (% class="western" %)
333 }
334
335 (% class="western" %)
336 The result of the api request will be determined by the value of the success property of result object. Here the value of success will either be 1 (true) or 0 (false) depending on whether the requested action succeed.
337
338 (% class="western" %)
339
340
341 (% class="western" %)
342 If value of success is 0 then an error will be generated inside the result object. Code property will have an error code. message property will have the details about the error. This value might be used to display the error in the client application. The response will always have a result object in it plus the individual response listed for each method.
343
344 (% class="western" %)
345 If the value of success is 1 then the response parameters of the called method will also be output.
346
347 (% class="western" %)
348 Example: Get list of questions from api
349
350 {{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions
351 {
352 "result": {
353 "success": "1",
354 "error": {
355 "code": "0",
356 "message": ""
357 }
358 },
359 "Questions": [
360 {
361 "Id": "6",
362 "Text": "First Name",
363 "Type": "1",
364 "Alias": "FName"
365 },
366 {
367 "Id": "7",
368 "Text": "Last Name",
369 "Type": "1",
370 "Alias": "LName"
371 },
372 {
373 "Id": "5",
374 "Text": "Specialty",
375 "Type": "5",
376 "Alias": "specialty all",
377 "Choices": [
378 {
379 "Id": "123",
380 "Text": "Physician",
381 "Value": "PH",
382 "Order": "1",
383 "QuestionId": "5"
384 },
385 {
386 "Id": "124",
387 "Text": "Nurse Practioner",
388 "Value": "NP",
389 "Order": "2",
390 "QuestionId": "5"
391 }
392 ]}]}}}}
393
394 (% class="western" %)
395
396
397 (% class="western" %)
398 **Resources**
399
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.
402
403 * (((
404 (% class="western" %)
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 )))
431
432 (% class="western" %)
433 **Questions**
434
435 (% class="western" %)
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.
437
438 (% class="western" %)
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)
440
441 (% class="western" %)
442 There can be 6 types of questions:
443
sonish 1.1 444 |(((
sonish 3.1 445 (% class="western" align="center" %)
sonish 1.1 446 **Type**
447 )))|(((
sonish 3.1 448 (% class="western" %)
sonish 1.1 449 **Description**
450 )))
451 |(((
sonish 3.1 452 (% class="western" align="center" %)
sonish 1.1 453 1
454 )))|(((
sonish 3.1 455 (% class="western" %)
sonish 1.1 456 Textbox type questions or short response type question. The response length needs to be less than 255 characters.
457 )))
458 |(((
sonish 3.1 459 (% class="western" align="center" %)
sonish 1.1 460 2
461 )))|(((
sonish 3.1 462 (% class="western" %)
sonish 1.1 463 Textarea type question or long response type question.
464 )))
465 |(((
sonish 3.1 466 (% class="western" align="center" %)
sonish 1.1 467 3
468 )))|(((
sonish 3.1 469 (% class="western" %)
470 Password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *.
sonish 1.1 471 )))
472 |(((
sonish 3.1 473 (% class="western" align="center" %)
sonish 1.1 474 4
475 )))|(((
sonish 3.1 476 (% class="western" %)
sonish 1.1 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 |(((
sonish 3.1 480 (% class="western" align="center" %)
sonish 1.1 481 5
482 )))|(((
sonish 3.1 483 (% class="western" %)
sonish 1.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 |(((
sonish 3.1 487 (% class="western" align="center" %)
sonish 1.1 488 6
489 )))|(((
sonish 3.1 490 (% class="western" %)
sonish 1.1 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.
492 )))
493
494 |(((
sonish 3.1 495 (% class="western" %)
sonish 1.1 496 **Method**
497 )))|(((
sonish 3.1 498 (% class="western" %)
sonish 1.1 499 **Url**
500 )))|(((
sonish 3.1 501 (% class="western" %)
sonish 1.1 502 **Action**
503 )))
504 |(((
sonish 3.1 505 (% class="western" %)
sonish 1.1 506 GET
507 )))|(((
sonish 3.1 508 (% class="western" %)
sonish 1.1 509 /questions
510 )))|(((
sonish 3.1 511 (% class="western" %)
sonish 1.1 512 List all questions
513 )))
514 |(((
sonish 3.1 515 (% class="western" %)
sonish 1.1 516 GET
517 )))|(((
sonish 3.1 518 (% class="western" %)
sonish 1.1 519 /questions/1
520 )))|(((
sonish 3.1 521 (% class="western" %)
sonish 1.1 522 Returns question id 1
523 )))
524 |(((
sonish 3.1 525 (% class="western" %)
sonish 1.1 526 GET
527 )))|(((
sonish 3.1 528 (% class="western" %)
sonish 1.1 529 /questions/lookup?Text=Email
530 )))|(((
sonish 3.1 531 (% class="western" %)
532 Returns all questions with “Email" in question text
sonish 1.1 533 )))
534 |(((
sonish 3.1 535 (% class="western" %)
sonish 1.1 536 POST
537 )))|(((
sonish 3.1 538 (% class="western" %)
sonish 1.1 539 /questions
540 )))|(((
sonish 3.1 541 (% class="western" %)
542 Create a new question
543
544 (% class="western" %)
545 JSON of the Questions type object needs to be sent as post data. Id field should not be sent.
sonish 1.1 546 )))
547 |(((
sonish 3.1 548 (% class="western" %)
sonish 1.1 549 PUT
550 )))|(((
sonish 3.1 551 (% class="western" %)
sonish 1.1 552 /questions
553 )))|(((
sonish 3.1 554 (% class="western" %)
555 Update a question
556
557 (% class="western" %)
558 JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
sonish 1.1 559 )))
560
sonish 3.1 561
sonish 1.1 562
sonish 3.1 563 (% class="western" %)
564 **GET method can be used to lookup questions.**
sonish 1.1 565
566 |(((
sonish 3.1 567 (% class="western" %)
sonish 1.1 568 **Request**
569 )))|(((
sonish 3.1 570 (% class="western" %)
sonish 1.1 571 **Type**
572 )))|(((
sonish 3.1 573 (% class="western" %)
sonish 1.1 574 **Description**
575 )))
576 |(((
sonish 3.1 577 (% class="western" %)
sonish 1.1 578 Lookup params
579 )))|(((
sonish 3.1 580 (% class="western" %)
sonish 1.1 581 String
582 )))|(((
sonish 3.1 583 (% class="western" %)
584 URL encoded key value string parameters for the question that a user is trying to search.
585
586 (% class="western" %)
587 Params:
588
589 (% class="western" %)
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.
sonish 1.1 594 )))
595
596 |(((
sonish 3.1 597 (% class="western" %)
sonish 1.1 598 **Response**
599 )))|(((
sonish 3.1 600 (% class="western" %)
sonish 1.1 601 **Type**
602 )))|(((
sonish 3.1 603 (% class="western" %)
sonish 1.1 604 **Description**
605 )))
606 |(((
sonish 3.1 607 (% class="western" %)
sonish 1.1 608 Questions
609 )))|(((
sonish 3.1 610 (% class="western" %)
sonish 1.1 611 Questions
612 )))|(((
sonish 3.1 613 (% class="western" %)
sonish 1.1 614 Returns found question details.
615 )))
616
sonish 3.1 617
sonish 1.1 618
sonish 3.1 619 (% class="western" %)
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).**
sonish 1.1 621
622 |(((
sonish 3.1 623 (% class="western" %)
sonish 1.1 624 **Request**
625 )))|(((
sonish 3.1 626 (% class="western" %)
sonish 1.1 627 **Type**
628 )))|(((
sonish 3.1 629 (% class="western" %)
sonish 1.1 630 **Description**
631 )))
632 |(((
sonish 3.1 633 (% class="western" %)
sonish 1.1 634 Questions
635 )))|(((
sonish 3.1 636 (% class="western" %)
sonish 1.1 637 Questions
638 )))|(((
sonish 3.1 639 (% class="western" %)
sonish 1.1 640 This defines the question contents and possible responses.
641 )))
642
643 |(((
sonish 3.1 644 (% class="western" %)
sonish 1.1 645 **Response**
646 )))|(((
sonish 3.1 647 (% class="western" %)
sonish 1.1 648 **Type**
649 )))|(((
sonish 3.1 650 (% class="western" %)
sonish 1.1 651 **Description**
652 )))
653 |(((
sonish 3.1 654 (% class="western" %)
sonish 1.1 655 QuestionId
656 )))|(((
sonish 3.1 657 (% class="western" %)
sonish 1.1 658 Int
659 )))|(((
sonish 3.1 660 (% class="western" %)
sonish 1.1 661 Returns ONEcount question id on successful creation of the question.
662 )))
663
sonish 3.1 664
sonish 1.1 665
sonish 3.1 666 (% class="western" %)
667 PUT method should be used to update question.
668
sonish 1.1 669 |(((
sonish 3.1 670 (% class="western" %)
sonish 1.1 671 **Request**
672 )))|(((
sonish 3.1 673 (% class="western" %)
sonish 1.1 674 **Type**
675 )))|(((
sonish 3.1 676 (% class="western" %)
sonish 1.1 677 **Description**
678 )))
679 |(((
sonish 3.1 680 (% class="western" %)
sonish 1.1 681 Questions
682 )))|(((
sonish 3.1 683 (% class="western" %)
sonish 1.1 684 Questions
685 )))|(((
sonish 3.1 686 (% class="western" %)
sonish 1.1 687 This defines the question contents and responses.
688 )))
689
690 |(((
sonish 3.1 691 (% class="western" %)
sonish 1.1 692 **Response**
693 )))|(((
sonish 3.1 694 (% class="western" %)
sonish 1.1 695 **Type**
696 )))|(((
sonish 3.1 697 (% class="western" %)
sonish 1.1 698 **Description**
699 )))
700 |(((
sonish 3.1 701 (% class="western" %)
sonish 1.1 702 QuestionId
703 )))|(((
sonish 3.1 704 (% class="western" %)
sonish 1.1 705 Int
706 )))|(((
sonish 3.1 707 (% class="western" %)
sonish 1.1 708 Returns ONEcount question id on successful update of the question.
709 )))
710
sonish 3.1 711 (% class="western" %)
712
sonish 1.1 713
sonish 3.1 714 (% class="western" %)
715 Example: Get list of questions from api which has FirstName in text
sonish 1.1 716
sonish 3.1 717 {{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions/lookup?Text=FirstName}}}
718
719 (% class="western" %)
720 {
721
722 (% class="western" %)
723 "result": {
724
725 (% class="western" %)
726 "success": "1",
727
728 (% class="western" %)
729 "error": {
730
731 (% class="western" %)
732 "code": "0",
733
734 (% class="western" %)
735 "message": ""
736
737 (% class="western" %)
738 }
739
740 (% class="western" %)
741 },
742
743 (% class="western" %)
744 "Questions": [
745
746 (% class="western" %)
747 {
748
749 (% class="western" %)
sonish 1.1 750 "Id": "6",
sonish 3.1 751
752 (% class="western" %)
753 "Text": "FirstName",
754
755 (% class="western" %)
756 "Type": "1",
757
758 (% class="western" %)
sonish 1.1 759 "Alias": "FName"
sonish 3.1 760
761 (% class="western" %)
762 }
763
764 (% class="western" %)
765 ]
766
767 (% class="western" %)
768 }
769
770 (% class="western" %)
771
772 **Users**
773
774 (% class="western" %)
sonish 1.1 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.
sonish 3.1 776
777 (% class="western" %)
sonish 1.1 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.
sonish 3.1 779
780 (% class="western" %)
sonish 1.1 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.
sonish 3.1 782
783 (% class="western" %)
sonish 1.1 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.
sonish 3.1 785
786 (% class="western" %)
sonish 1.1 787 Return parameter will have the comma separated list of question Ids that is requested back from the API.
788
sonish 3.1 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
sonish 1.1 795 |(((
sonish 3.1 796 (% class="western" %)
797 **Method**
798 )))|(((
799 (% class="western" %)
800 **Url**
801 )))|(((
802 (% class="western" %)
803 **Action**
804 )))
805 |(((
806 (% class="western" %)
sonish 1.1 807 GET
808 )))|(((
sonish 3.1 809 (% class="western" %)
sonish 1.1 810 /users
811 )))|(((
sonish 3.1 812 (% class="western" %)
sonish 1.1 813 Get users data limiting 25.
814 )))
815 |(((
sonish 3.1 816 (% class="western" %)
sonish 1.1 817 GET
818 )))|(((
sonish 3.1 819 (% class="western" %)
sonish 1.1 820 /users/1
821 )))|(((
sonish 3.1 822 (% class="western" %)
sonish 1.1 823 Get data for user id 1. The user id can be a numeric value or a hash
824 )))
825 |(((
sonish 3.1 826 (% class="western" %)
sonish 1.1 827 GET
828 )))|(((
sonish 3.1 829 (% class="western" %)
830 /users/lookup?1=user1@[[email.com>>url:http://email.com||shape="rect"]]&return=1,2
sonish 1.1 831 )))|(((
sonish 3.1 832 (% class="western" %)
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.
sonish 1.1 837 )))
838 |(((
sonish 3.1 839 (% class="western" %)
sonish 1.1 840 POST
841 )))|(((
sonish 3.1 842 (% class="western" %)
sonish 1.1 843 /users
844 )))|(((
sonish 3.1 845 (% class="western" %)
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.
sonish 1.1 850 )))
851 |(((
sonish 3.1 852 (% class="western" %)
sonish 1.1 853 PUT
854 )))|(((
sonish 3.1 855 (% class="western" %)
sonish 1.1 856 /users/1
857 )))|(((
sonish 3.1 858 (% class="western" %)
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.
sonish 1.1 863 )))
864 |(((
sonish 3.1 865 (% class="western" %)
sonish 1.1 866 GET
867 )))|(((
sonish 3.1 868 (% class="western" %)
sonish 1.1 869 /users/1/partners/2
870 )))|(((
sonish 3.1 871 (% class="western" %)
sonish 1.1 872 Get user id 1 and partner id 2's ONEcount hash. The user id can be a numeric value or a hash.
873 )))
874 |(((
sonish 3.1 875 (% class="western" %)
sonish 1.1 876 POST
877 )))|(((
sonish 3.1 878 (% class="western" %)
sonish 1.1 879 /users/login
880 )))|(((
sonish 3.1 881 (% class="western" %)
882 Check to see user exist with username/email and password.
883
884 (% class="western" %)
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
887 (% class="western" %)
888 Example:
889
890 (% class="western" %)
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
893 (% class="western" %)
894 OR
895
896 (% class="western" %)
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.
sonish 1.1 907 )))
908
sonish 3.1 909
sonish 1.1 910
sonish 3.1 911 (% class="western" %)
912 **GET method should be used to lookup users.**
sonish 1.1 913
914 |(((
sonish 3.1 915 (% class="western" %)
sonish 1.1 916 **Request**
917 )))|(((
sonish 3.1 918 (% class="western" %)
sonish 1.1 919 **Type**
920 )))|(((
sonish 3.1 921 (% class="western" %)
sonish 1.1 922 **Description**
923 )))
924 |(((
sonish 3.1 925 (% class="western" %)
sonish 1.1 926 Lookup params
927 )))|(((
sonish 3.1 928 (% class="western" %)
sonish 1.1 929 String
930 )))|(((
sonish 3.1 931 (% class="western" %)
932 URL encoded key value string parameters for the lookup. Return property has csv of questions id requested back in Users object.
933
934 (% class="western" %)
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"]]
936
937 (% class="western" %)
938 return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String)
sonish 1.1 939 )))
940
sonish 3.1 941
sonish 1.1 942
sonish 3.1 943
sonish 1.1 944
945 |(((
sonish 3.1 946 (% class="western" %)
sonish 1.1 947 **Response**
948 )))|(((
sonish 3.1 949 (% class="western" %)
sonish 1.1 950 **Type**
951 )))|(((
sonish 3.1 952 (% class="western" %)
sonish 1.1 953 **Description**
954 )))
955 |(((
sonish 3.1 956 (% class="western" %)
sonish 1.1 957 Users
sonish 3.1 958 )))|=(((
959 (% class="western" align="left" %)
960 Users
sonish 1.1 961 )))|(((
sonish 3.1 962 (% class="western" %)
sonish 1.1 963 Found users returned with the demo field requested in return parameter in json format.
964 )))
965
sonish 3.1 966
sonish 1.1 967
sonish 3.1 968 (% class="western" %)
969 **POST method should be used to create users.**
sonish 1.1 970
971 |(((
sonish 3.1 972 (% class="western" %)
sonish 1.1 973 **Request**
974 )))|(((
sonish 3.1 975 (% class="western" %)
sonish 1.1 976 **Type**
977 )))|(((
sonish 3.1 978 (% class="western" %)
sonish 1.1 979 **Description**
980 )))
981 |(((
sonish 3.1 982 (% class="western" %)
sonish 1.1 983 Users
984 )))|(((
sonish 3.1 985 (% class="western" %)
sonish 1.1 986 Users
987 )))|(((
sonish 3.1 988 (% class="western" %)
sonish 1.1 989 Users object that contains information about user to create. PartnerId Needs to be specified.
990 )))
991 |(((
sonish 3.1 992 (% class="western" %)
sonish 1.1 993 Transactions
994 )))|(((
sonish 3.1 995 (% class="western" %)
sonish 1.1 996 Transactions
997 )))|(((
sonish 3.1 998 (% class="western" %)
sonish 1.1 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.
1000 )))
1001 |(((
sonish 3.1 1002 (% class="western" %)
sonish 1.1 1003 DedupeColumns
1004 )))|(((
sonish 3.1 1005 (% class="western" %)
sonish 1.1 1006 String
1007 )))|(((
sonish 3.1 1008 (% class="western" %)
sonish 1.1 1009 CSV of question id's that should be considered to find duplicate.
1010 )))
sonish 3.1 1011 |(((
1012 (% class="western" %)
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 )))
sonish 1.1 1021
1022 |(((
sonish 3.1 1023 (% class="western" %)
sonish 1.1 1024 **Response**
1025 )))|(((
sonish 3.1 1026 (% class="western" %)
sonish 1.1 1027 **Type**
1028 )))|(((
sonish 3.1 1029 (% class="western" %)
sonish 1.1 1030 **Description**
1031 )))
1032 |(((
sonish 3.1 1033 (% class="western" %)
sonish 1.1 1034 Users
sonish 3.1 1035 )))|=(((
1036 (% class="western" align="left" %)
1037 Users
sonish 1.1 1038 )))|(((
sonish 3.1 1039 (% class="western" %)
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.
sonish 1.1 1041 )))
1042
sonish 3.1 1043
sonish 1.1 1044
sonish 3.1 1045 (% class="western" %)
1046 **PUT method should be used to update users.**
sonish 1.1 1047
1048 |(((
sonish 3.1 1049 (% class="western" %)
sonish 1.1 1050 **Request**
1051 )))|(((
sonish 3.1 1052 (% class="western" %)
sonish 1.1 1053 **Type**
1054 )))|(((
sonish 3.1 1055 (% class="western" %)
sonish 1.1 1056 **Description**
1057 )))
1058 |(((
sonish 3.1 1059 (% class="western" %)
sonish 1.1 1060 Users
1061 )))|(((
sonish 3.1 1062 (% class="western" %)
sonish 1.1 1063 Users
1064 )))|(((
sonish 3.1 1065 (% class="western" %)
sonish 1.1 1066 Users object with update fields. Return property has csv of questions id requested back in Users object.
1067 )))
1068 |(((
sonish 3.1 1069 (% class="western" %)
sonish 1.1 1070 Return
1071 )))|(((
sonish 3.1 1072 (% class="western" %)
sonish 1.1 1073 String
1074 )))|(((
sonish 3.1 1075 (% class="western" %)
sonish 1.1 1076 CSV of ONEcount QuestionId's requested back in Users object in response
1077 )))
1078 |(((
sonish 3.1 1079 (% class="western" %)
sonish 1.1 1080 RequestDate
1081 )))|(((
sonish 3.1 1082 (% class="western" %)
sonish 1.1 1083 Date
1084 )))|(((
sonish 3.1 1085 (% class="western" %)
sonish 1.1 1086 RequestDate to use for the demo update. If not provided current date will be used.
1087 )))
1088
1089 |(((
sonish 3.1 1090 (% class="western" %)
sonish 1.1 1091 **Response**
1092 )))|(((
sonish 3.1 1093 (% class="western" %)
sonish 1.1 1094 **Type**
1095 )))|(((
sonish 3.1 1096 (% class="western" %)
sonish 1.1 1097 **Description**
1098 )))
1099 |(((
sonish 3.1 1100 (% class="western" %)
sonish 1.1 1101 Users
sonish 3.1 1102 )))|=(((
1103 (% class="western" align="left" %)
1104 Users
sonish 1.1 1105 )))|(((
sonish 3.1 1106 (% class="western" %)
sonish 1.1 1107 Updated user returned with the demo field requested in return parameter in json format.
1108 )))
1109
sonish 3.1 1110 (% class="western" %)
1111
sonish 1.1 1112
sonish 3.1 1113 (% class="western" %)
1114
sonish 1.1 1115
sonish 3.1 1116 (% class="western" %)
1117 Create new users. Here in this example the JSON for request is passed in userFile.json file.
1118
1119 {{{curl -X POST -H “Appkey: xxx” -H "Content-Type: application/json" –data-binary -d '@userFile.json' https://api.onecount.net/v2/users}}}
1120
1121 (% class="western" %)
1122 **Products**
1123
1124 (% class="western" %)
1125 This resource is for manipulating products resource. A product can be created, updated or searched.
1126
sonish 1.1 1127 |(((
sonish 3.1 1128 (% class="western" %)
sonish 1.1 1129 **Method**
1130 )))|(((
sonish 3.1 1131 (% class="western" %)
sonish 1.1 1132 **Url**
1133 )))|(((
sonish 3.1 1134 (% class="western" %)
sonish 1.1 1135 **Action**
1136 )))
1137 |(((
sonish 3.1 1138 (% class="western" %)
sonish 1.1 1139 GET
1140 )))|(((
sonish 3.1 1141 (% class="western" %)
sonish 1.1 1142 /products
1143 )))|(((
sonish 3.1 1144 (% class="western" %)
sonish 1.1 1145 Get all product details
1146 )))
1147 |(((
sonish 3.1 1148 (% class="western" %)
sonish 1.1 1149 GET
1150 )))|(((
sonish 3.1 1151 (% class="western" %)
sonish 1.1 1152 /products/5
1153 )))|(((
sonish 3.1 1154 (% class="western" %)
sonish 1.1 1155 Get product id 5
1156 )))
1157 |(((
sonish 3.1 1158 (% class="western" %)
sonish 1.1 1159 GET
1160 )))|(((
sonish 3.1 1161 (% class="western" %)
sonish 1.1 1162 /products/lookup?Title=productname
1163 )))|(((
sonish 3.1 1164 (% class="western" %)
sonish 1.1 1165 Lookup products by Title
1166 )))
1167 |(((
sonish 3.1 1168 (% class="western" %)
sonish 1.1 1169 POST
1170 )))|(((
sonish 3.1 1171 (% class="western" %)
sonish 1.1 1172 /products
1173 )))|(((
sonish 3.1 1174 (% class="western" %)
sonish 1.1 1175 JSON of the Products type object needs to be sent as post data. Id field should not be sent.
1176 )))
1177 |(((
sonish 3.1 1178 (% class="western" %)
sonish 1.1 1179 PUT
1180 )))|(((
sonish 3.1 1181 (% class="western" %)
sonish 1.1 1182 /products/5
1183 )))|(((
sonish 3.1 1184 (% class="western" %)
sonish 1.1 1185 JSON of the Products type object needs to be sent as post data. Id field is mandatory for update.
1186 )))
1187 |(((
sonish 3.1 1188 (% class="western" %)
sonish 1.1 1189 POST
1190 )))|(((
sonish 3.1 1191 (% class="western" %)
sonish 1.1 1192 /products/attachResource
1193 )))|(((
sonish 3.1 1194 (% class="western" %)
1195 JSON of the Product and Resource ids to be sent as post data.
1196
1197 (% class="western" %)
1198 Both fields are mandatory.
1199
1200 (% class="western" %)
1201 Example:
1202
1203 (% class="western" %)
1204 {"ProductID":"65","ResourceID":”121"}
sonish 1.1 1205 )))
1206
sonish 3.1 1207
sonish 1.1 1208
sonish 3.1 1209 (% class="western" %)
1210 **GET method should be used to lookup products.**
sonish 1.1 1211
1212 |(((
sonish 3.1 1213 (% class="western" %)
sonish 1.1 1214 **Request**
1215 )))|(((
sonish 3.1 1216 (% class="western" %)
sonish 1.1 1217 **Type**
1218 )))|(((
sonish 3.1 1219 (% class="western" %)
sonish 1.1 1220 **Description**
1221 )))
1222 |(((
sonish 3.1 1223 (% class="western" %)
sonish 1.1 1224 Lookup params
1225 )))|(((
sonish 3.1 1226 (% class="western" %)
sonish 1.1 1227 String
1228 )))|(((
sonish 3.1 1229 (% class="western" %)
1230 URL encoded key value string parameter for the lookup.
1231
1232 (% class="western" %)
1233 Params:
1234
1235 (% class="western" %)
sonish 1.1 1236 Name: Name of the Product for lookup (String)
1237 )))
1238
sonish 3.1 1239 |(((
1240 (% class="western" %)
1241 **Response**
1242 )))|(((
1243 (% class="western" %)
1244 **Type**
1245 )))|(((
1246 (% class="western" %)
1247 **Description**
1248 )))
1249 |(((
1250 (% class="western" %)
1251 Products
1252 )))|(((
1253 (% class="western" %)
1254 Products
1255 )))|(((
1256 (% class="western" %)
1257 Returns found product details.
1258 )))
sonish 1.1 1259
1260
1261
sonish 3.1 1262 (% class="western" %)
1263 **POST method should be used to create products.**
1264
sonish 1.1 1265 |(((
sonish 3.1 1266 (% class="western" %)
sonish 1.1 1267 **Request**
1268 )))|(((
sonish 3.1 1269 (% class="western" %)
sonish 1.1 1270 **Type**
1271 )))|(((
sonish 3.1 1272 (% class="western" %)
sonish 1.1 1273 **Description**
1274 )))
1275 |(((
sonish 3.1 1276 (% class="western" %)
sonish 1.1 1277 Products
1278 )))|(((
sonish 3.1 1279 (% class="western" %)
sonish 1.1 1280 Products
1281 )))|(((
sonish 3.1 1282 (% class="western" %)
1283 Product details in json to be sent as post data. Id should not be set.
1284
1285 (% class="western" %)
1286 Example:
1287
1288 (% class="western" %)
sonish 1.1 1289 {"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
1290 )))
1291
1292 |(((
sonish 3.1 1293 (% class="western" %)
sonish 1.1 1294 **Response**
1295 )))|(((
sonish 3.1 1296 (% class="western" %)
sonish 1.1 1297 **Type**
1298 )))|(((
sonish 3.1 1299 (% class="western" %)
sonish 1.1 1300 **Description**
1301 )))
1302 |(((
sonish 3.1 1303 (% class="western" %)
sonish 1.1 1304 ProductId
1305 )))|(((
sonish 3.1 1306 (% class="western" %)
sonish 1.1 1307 int
1308 )))|(((
sonish 3.1 1309 (% class="western" %)
sonish 1.1 1310 Product Id of the newly created product.
1311 )))
1312
sonish 3.1 1313
sonish 1.1 1314
sonish 3.1 1315 (% class="western" %)
1316 PUT method should be used to update an individual product given the product info.
sonish 1.1 1317
1318 |(((
sonish 3.1 1319 (% class="western" %)
sonish 1.1 1320 **Request**
1321 )))|(((
sonish 3.1 1322 (% class="western" %)
sonish 1.1 1323 **Type**
1324 )))|(((
sonish 3.1 1325 (% class="western" %)
sonish 1.1 1326 **Description**
1327 )))
1328 |(((
sonish 3.1 1329 (% class="western" %)
sonish 1.1 1330 Products
1331 )))|(((
sonish 3.1 1332 (% class="western" %)
sonish 1.1 1333 Product
1334 )))|(((
sonish 3.1 1335 (% class="western" %)
1336 Product details to be updated in json format to be sent with request. Id property needs to be set to identify the product to be updated. If you send term and resource along with product creation then it will automatically attach term to product and resource to product.
1337
1338 (% class="western" %)
1339 **Possible Request Params**: Title, Description, PrimaryFormId, ResourceID
1340
1341 (% class="western" %)
1342 **Example**:
1343
1344 (% class="western" %)
1345 {"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
sonish 1.1 1346 )))
1347
1348 |(((
sonish 3.1 1349 (% class="western" %)
sonish 1.1 1350 **Response**
1351 )))|(((
sonish 3.1 1352 (% class="western" %)
sonish 1.1 1353 **Type**
1354 )))|(((
sonish 3.1 1355 (% class="western" %)
sonish 1.1 1356 **Description**
1357 )))
1358 |(((
sonish 3.1 1359 (% class="western" %)
sonish 1.1 1360 ProductId
1361 )))|(((
sonish 3.1 1362 (% class="western" %)
sonish 1.1 1363 Int
1364 )))|(((
sonish 3.1 1365 (% class="western" %)
sonish 1.1 1366 Product id of the updated product.
1367 )))
1368
sonish 3.1 1369
sonish 1.1 1370
sonish 3.1 1371 (% class="western" %)
1372 **Terms**
sonish 1.1 1373
sonish 3.1 1374 (% class="western" %)
1375 This resource is for manipulating terms resource. A term can be created, updated or searched.
1376
sonish 1.1 1377 |(((
sonish 3.1 1378 (% class="western" %)
sonish 1.1 1379 **Method**
1380 )))|(((
sonish 3.1 1381 (% class="western" %)
sonish 1.1 1382 **Url**
1383 )))|(((
sonish 3.1 1384 (% class="western" %)
sonish 1.1 1385 **Action**
1386 )))
1387 |(((
sonish 3.1 1388 (% class="western" %)
sonish 1.1 1389 GET
1390 )))|(((
sonish 3.1 1391 (% class="western" %)
sonish 1.1 1392 /terms/5
1393 )))|(((
sonish 3.1 1394 (% class="western" %)
sonish 1.1 1395 Get term id 5
1396 )))
1397 |(((
sonish 3.1 1398 (% class="western" %)
sonish 1.1 1399 GET
1400 )))|(((
sonish 3.1 1401 (% class="western" %)
sonish 1.1 1402 /terms/lookup?Name=termname
1403 )))|(((
sonish 3.1 1404 (% class="western" %)
sonish 1.1 1405 Lookup terms by Name
1406 )))
1407 |(((
sonish 3.1 1408 (% class="western" %)
sonish 1.1 1409 POST
1410 )))|(((
sonish 3.1 1411 (% class="western" %)
sonish 1.1 1412 /terms
1413 )))|(((
sonish 3.1 1414 (% class="western" %)
sonish 1.1 1415 JSON of the terms type object needs to be sent as post data. Id field should not be sent.
1416 )))
1417 |(((
sonish 3.1 1418 (% class="western" %)
sonish 1.1 1419 PUT
1420 )))|(((
sonish 3.1 1421 (% class="western" %)
sonish 1.1 1422 /terms/5
1423 )))|(((
sonish 3.1 1424 (% class="western" %)
sonish 1.1 1425 JSON of the terms type object needs to be sent as post data. Id field is mandatory for update.
1426 )))
1427
sonish 3.1 1428
sonish 1.1 1429
sonish 3.1 1430 (% class="western" %)
1431 **GET method should be used to lookup products.**
sonish 1.1 1432
1433 |(((
sonish 3.1 1434 (% class="western" %)
sonish 1.1 1435 **Request**
1436 )))|(((
sonish 3.1 1437 (% class="western" %)
sonish 1.1 1438 **Type**
1439 )))|(((
sonish 3.1 1440 (% class="western" %)
sonish 1.1 1441 **Description**
1442 )))
1443 |(((
sonish 3.1 1444 (% class="western" %)
sonish 1.1 1445 Lookup params
1446 )))|(((
sonish 3.1 1447 (% class="western" %)
sonish 1.1 1448 String
1449 )))|(((
sonish 3.1 1450 (% class="western" %)
1451 URL encoded key value string parameter for the lookup.
1452
1453 (% class="western" %)
1454 Params:
1455
1456 (% class="western" %)
sonish 1.1 1457 Name: Name of the term for lookup (String)
1458 )))
1459
1460 |(((
sonish 3.1 1461 (% class="western" %)
sonish 1.1 1462 **Response**
1463 )))|(((
sonish 3.1 1464 (% class="western" %)
sonish 1.1 1465 **Type**
1466 )))|(((
sonish 3.1 1467 (% class="western" %)
sonish 1.1 1468 **Description**
1469 )))
1470 |(((
sonish 3.1 1471 (% class="western" %)
sonish 1.1 1472 Terms
1473 )))|(((
sonish 3.1 1474 (% class="western" %)
sonish 1.1 1475 Terms
1476 )))|(((
sonish 3.1 1477 (% class="western" %)
sonish 1.1 1478 Returns found term details.
1479 )))
1480
sonish 3.1 1481
sonish 1.1 1482
sonish 3.1 1483 (% class="western" %)
1484 **POST method should be used to create products.**
1485
sonish 1.1 1486 |(((
sonish 3.1 1487 (% class="western" %)
sonish 1.1 1488 **Request**
1489 )))|(((
sonish 3.1 1490 (% class="western" %)
sonish 1.1 1491 **Type**
1492 )))|(((
sonish 3.1 1493 (% class="western" %)
sonish 1.1 1494 **Description**
1495 )))
1496 |(((
sonish 3.1 1497 (% class="western" %)
sonish 1.1 1498 Terms
1499 )))|(((
sonish 3.1 1500 (% class="western" %)
sonish 1.1 1501 Terms
1502 )))|(((
sonish 3.1 1503 (% class="western" %)
1504 Term details in json to be sent as post data. Id should not be set.
1505
1506 (% class="western" %)
1507 **Possible Request Params**: Name, Description, Duration, DurationUnit, Price, ProductId, Active, ProductStatusId, Quantity, QuantityTxt
1508
1509 (% class="western" %)
1510 **Example**:
1511
1512 (% class="western" %)
1513 {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
sonish 1.1 1514 )))
1515
1516 |(((
sonish 3.1 1517 (% class="western" %)
sonish 1.1 1518 **Response**
1519 )))|(((
sonish 3.1 1520 (% class="western" %)
sonish 1.1 1521 **Type**
1522 )))|(((
sonish 3.1 1523 (% class="western" %)
sonish 1.1 1524 **Description**
1525 )))
1526 |(((
sonish 3.1 1527 (% class="western" %)
sonish 1.1 1528 TermId
1529 )))|(((
sonish 3.1 1530 (% class="western" %)
sonish 1.1 1531 int
1532 )))|(((
sonish 3.1 1533 (% class="western" %)
sonish 1.1 1534 Term Id of the newly created term.
1535 )))
1536
sonish 3.1 1537
sonish 1.1 1538
sonish 3.1 1539 (% class="western" %)
1540 PUT method should be used to update an individual term given the term info.
sonish 1.1 1541
1542 |(((
sonish 3.1 1543 (% class="western" %)
sonish 1.1 1544 **Request**
1545 )))|(((
sonish 3.1 1546 (% class="western" %)
sonish 1.1 1547 **Type**
1548 )))|(((
sonish 3.1 1549 (% class="western" %)
sonish 1.1 1550 **Description**
1551 )))
1552 |(((
sonish 3.1 1553 (% class="western" %)
sonish 1.1 1554 Terms
1555 )))|(((
sonish 3.1 1556 (% class="western" %)
sonish 1.1 1557 Term
1558 )))|(((
sonish 3.1 1559 (% class="western" %)
1560 Term details to be updated in json format to be sent with request. Id property needs to be set to identify the term to be updated.
1561
1562 (% class="western" %)
1563
1564
1565 (% class="western" %)
1566 **Example**:
1567
1568 (% class="western" %)
1569 {"Name":"Test123","Description":Testss","Duration":10,"ProductId":17}
sonish 1.1 1570 )))
1571
1572 |(((
sonish 3.1 1573 (% class="western" %)
sonish 1.1 1574 **Response**
1575 )))|(((
sonish 3.1 1576 (% class="western" %)
sonish 1.1 1577 **Type**
1578 )))|(((
sonish 3.1 1579 (% class="western" %)
sonish 1.1 1580 **Description**
1581 )))
1582 |(((
sonish 3.1 1583 (% class="western" %)
sonish 1.1 1584 TermId
1585 )))|(((
sonish 3.1 1586 (% class="western" %)
sonish 1.1 1587 Int
1588 )))|(((
sonish 3.1 1589 (% class="western" %)
sonish 1.1 1590 term id of the updated term.
1591 )))
1592
sonish 3.1 1593
sonish 1.1 1594
sonish 3.1 1595 (% class="western" %)
1596 **Resources**
sonish 1.1 1597
sonish 3.1 1598 (% class="western" %)
1599 This resource is for manipulating resources resource. A resource can be created, updated or searched.
1600
sonish 1.1 1601 |(((
sonish 3.1 1602 (% class="western" %)
sonish 1.1 1603 **Method**
1604 )))|(((
sonish 3.1 1605 (% class="western" %)
sonish 1.1 1606 **Url**
1607 )))|(((
sonish 3.1 1608 (% class="western" %)
sonish 1.1 1609 **Action**
1610 )))
1611 |(((
sonish 3.1 1612 (% class="western" %)
sonish 1.1 1613 GET
1614 )))|(((
sonish 3.1 1615 (% class="western" %)
sonish 1.1 1616 /resources/5
1617 )))|(((
sonish 3.1 1618 (% class="western" %)
sonish 1.1 1619 Get resource id 5
1620 )))
1621 |(((
sonish 3.1 1622 (% class="western" %)
sonish 1.1 1623 GET
1624 )))|(((
sonish 3.1 1625 (% class="western" %)
sonish 1.1 1626 /resources/lookup?Name=resourcename
1627 )))|(((
sonish 3.1 1628 (% class="western" %)
sonish 1.1 1629 Lookup resources by Name
1630 )))
1631 |(((
sonish 3.1 1632 (% class="western" %)
sonish 1.1 1633 POST
1634 )))|(((
sonish 3.1 1635 (% class="western" %)
sonish 1.1 1636 /resources
1637 )))|(((
sonish 3.1 1638 (% class="western" %)
sonish 1.1 1639 JSON of the resources type object needs to be sent as post data. Id field should not be sent.
1640 )))
1641 |(((
sonish 3.1 1642 (% class="western" %)
sonish 1.1 1643 PUT
1644 )))|(((
sonish 3.1 1645 (% class="western" %)
sonish 1.1 1646 /resources/5
1647 )))|(((
sonish 3.1 1648 (% class="western" %)
sonish 1.1 1649 JSON of the resources type object needs to be sent as post data. Id field is mandatory for update.
1650 )))
1651
sonish 3.1 1652
sonish 1.1 1653
sonish 3.1 1654 (% class="western" %)
1655 **GET method should be used to lookup products.**
sonish 1.1 1656
1657 |(((
sonish 3.1 1658 (% class="western" %)
sonish 1.1 1659 **Request**
1660 )))|(((
sonish 3.1 1661 (% class="western" %)
sonish 1.1 1662 **Type**
1663 )))|(((
sonish 3.1 1664 (% class="western" %)
sonish 1.1 1665 **Description**
1666 )))
1667 |(((
sonish 3.1 1668 (% class="western" %)
sonish 1.1 1669 Lookup params
1670 )))|(((
sonish 3.1 1671 (% class="western" %)
sonish 1.1 1672 String
1673 )))|(((
sonish 3.1 1674 (% class="western" %)
1675 URL encoded key value string parameter for the lookup.
1676
1677 (% class="western" %)
1678 Params:
1679
1680 (% class="western" %)
sonish 1.1 1681 Name: Name of the resource for lookup (String)
1682 )))
1683
1684 |(((
sonish 3.1 1685 (% class="western" %)
sonish 1.1 1686 **Response**
1687 )))|(((
sonish 3.1 1688 (% class="western" %)
sonish 1.1 1689 **Type**
1690 )))|(((
sonish 3.1 1691 (% class="western" %)
sonish 1.1 1692 **Description**
1693 )))
1694 |(((
sonish 3.1 1695 (% class="western" %)
sonish 1.1 1696 Resources
1697 )))|(((
sonish 3.1 1698 (% class="western" %)
sonish 1.1 1699 Resources
1700 )))|(((
sonish 3.1 1701 (% class="western" %)
sonish 1.1 1702 Returns found resource details.
1703 )))
1704
sonish 3.1 1705
sonish 1.1 1706
sonish 3.1 1707 (% class="western" %)
1708 **POST method should be used to create products.**
1709
sonish 1.1 1710 |(((
sonish 3.1 1711 (% class="western" %)
sonish 1.1 1712 **Request**
1713 )))|(((
sonish 3.1 1714 (% class="western" %)
sonish 1.1 1715 **Type**
1716 )))|(((
sonish 3.1 1717 (% class="western" %)
sonish 1.1 1718 **Description**
1719 )))
1720 |(((
sonish 3.1 1721 (% class="western" %)
sonish 1.1 1722 Resources
1723 )))|(((
sonish 3.1 1724 (% class="western" %)
sonish 1.1 1725 Resources
1726 )))|(((
sonish 3.1 1727 (% class="western" %)
1728 resource details in json to be sent as post data. Id should not be set.
1729
1730 (% class="western" %)
1731 **Possible Request Params**: Name, Description, Type, Value
1732
1733 (% class="western" %)
1734 **Example**:
1735
1736 (% class="western" %)
1737 {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
sonish 1.1 1738 )))
1739
1740 |(((
sonish 3.1 1741 (% class="western" %)
sonish 1.1 1742 **Response**
1743 )))|(((
sonish 3.1 1744 (% class="western" %)
sonish 1.1 1745 **Type**
1746 )))|(((
sonish 3.1 1747 (% class="western" %)
sonish 1.1 1748 **Description**
1749 )))
1750 |(((
sonish 3.1 1751 (% class="western" %)
sonish 1.1 1752 ResourceId
1753 )))|(((
sonish 3.1 1754 (% class="western" %)
sonish 1.1 1755 int
1756 )))|(((
sonish 3.1 1757 (% class="western" %)
sonish 1.1 1758 Resource Id of the newly created resource.
1759 )))
1760
sonish 3.1 1761
sonish 1.1 1762
sonish 3.1 1763 (% class="western" %)
1764 PUT method should be used to update an individual resource given the resource info.
sonish 1.1 1765
1766 |(((
sonish 3.1 1767 (% class="western" %)
sonish 1.1 1768 **Request**
1769 )))|(((
sonish 3.1 1770 (% class="western" %)
sonish 1.1 1771 **Type**
1772 )))|(((
sonish 3.1 1773 (% class="western" %)
sonish 1.1 1774 **Description**
1775 )))
1776 |(((
sonish 3.1 1777 (% class="western" %)
sonish 1.1 1778 Resources
1779 )))|(((
sonish 3.1 1780 (% class="western" %)
sonish 1.1 1781 Resource
1782 )))|(((
sonish 3.1 1783 (% class="western" %)
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.
1785
1786 (% class="western" %)
1787
1788
1789 (% class="western" %)
1790 Example:
1791
1792 (% class="western" %)
1793 {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
sonish 1.1 1794 )))
1795
1796 |(((
sonish 3.1 1797 (% class="western" %)
sonish 1.1 1798 **Response**
1799 )))|(((
sonish 3.1 1800 (% class="western" %)
sonish 1.1 1801 **Type**
1802 )))|(((
sonish 3.1 1803 (% class="western" %)
sonish 1.1 1804 **Description**
1805 )))
1806 |(((
sonish 3.1 1807 (% class="western" %)
sonish 1.1 1808 ResourceId
1809 )))|(((
sonish 3.1 1810 (% class="western" %)
sonish 1.1 1811 Int
1812 )))|(((
sonish 3.1 1813 (% class="western" %)
sonish 1.1 1814 resource id of the updated resource.
1815 )))
1816
sonish 3.1 1817
sonish 1.1 1818
sonish 3.1 1819 (% class="western" %)
1820
sonish 1.1 1821
sonish 3.1 1822 (% class="western" %)
1823
1824
1825 (% class="western" %)
1826 **Sources**
1827
1828 (% class="western" %)
1829 This resource is for manipulating sources resource. A source can be created, updated or searched.
1830
sonish 1.1 1831 |(((
sonish 3.1 1832 (% class="western" %)
sonish 1.1 1833 **Method**
1834 )))|(((
sonish 3.1 1835 (% class="western" %)
sonish 1.1 1836 **Url**
1837 )))|(((
sonish 3.1 1838 (% class="western" %)
sonish 1.1 1839 **Action**
1840 )))
1841 |(((
sonish 3.1 1842 (% class="western" %)
sonish 1.1 1843 GET
1844 )))|(((
sonish 3.1 1845 (% class="western" %)
sonish 1.1 1846 /sources/1
1847 )))|(((
sonish 3.1 1848 (% class="western" %)
sonish 1.1 1849 Get source id 1.
1850 )))
1851 |(((
sonish 3.1 1852 (% class="western" %)
sonish 1.1 1853 GET
1854 )))|(((
sonish 3.1 1855 (% class="western" %)
sonish 1.1 1856 /sources/lookup?Source=sourcename
1857 )))|(((
sonish 3.1 1858 (% class="western" %)
sonish 1.1 1859 Lookup sources by source.
1860 )))
1861 |(((
sonish 3.1 1862 (% class="western" %)
sonish 1.1 1863 POST
1864 )))|(((
sonish 3.1 1865 (% class="western" %)
sonish 1.1 1866 /sources
1867 )))|(((
sonish 3.1 1868 (% class="western" %)
sonish 1.1 1869 JSON of the Sources type object needs to be sent as post data. Id field should not be sent.
1870 )))
1871 |(((
sonish 3.1 1872 (% class="western" %)
sonish 1.1 1873 PUT
1874 )))|(((
sonish 3.1 1875 (% class="western" %)
sonish 1.1 1876 /sources
1877 )))|(((
sonish 3.1 1878 (% class="western" %)
sonish 1.1 1879 JSON of the Sources type object needs to be sent as post data. Id field is mandatory for update.
1880 )))
1881
sonish 3.1 1882
sonish 1.1 1883
sonish 3.1 1884 (% class="western" %)
1885 **Sources can be looked up given the code or Id. GET method should be used for lookup.**
sonish 1.1 1886
1887 |(((
sonish 3.1 1888 (% class="western" %)
sonish 1.1 1889 **Request**
1890 )))|(((
sonish 3.1 1891 (% class="western" %)
sonish 1.1 1892 **Type**
1893 )))|(((
sonish 3.1 1894 (% class="western" %)
sonish 1.1 1895 **Description**
1896 )))
1897 |(((
sonish 3.1 1898 (% class="western" %)
sonish 1.1 1899 Lookup params
1900 )))|(((
sonish 3.1 1901 (% class="western" %)
sonish 1.1 1902 String
1903 )))|(((
sonish 3.1 1904 (% class="western" %)
1905 URL encoded key value string parameter for the lookup.
1906
1907 (% class="western" %)
1908 Params:
1909
1910 (% class="western" %)
sonish 1.1 1911 Source: Source value (String)
1912 )))
1913
1914 |(((
sonish 3.1 1915 (% class="western" %)
sonish 1.1 1916 **Response**
1917 )))|(((
sonish 3.1 1918 (% class="western" %)
sonish 1.1 1919 **Type**
1920 )))|(((
sonish 3.1 1921 (% class="western" %)
sonish 1.1 1922 **Description**
1923 )))
1924 |(((
sonish 3.1 1925 (% class="western" %)
sonish 1.1 1926 Sources
1927 )))|(((
sonish 3.1 1928 (% class="western" %)
sonish 1.1 1929 Sources
1930 )))|(((
sonish 3.1 1931 (% class="western" %)
sonish 1.1 1932 Returns found source details.
1933 )))
1934
sonish 3.1 1935
sonish 1.1 1936
sonish 3.1 1937 (% class="western" %)
1938
sonish 1.1 1939
sonish 3.1 1940 (% class="western" %)
1941 POST method should be used to create an individual source given the source parameters.
1942
sonish 1.1 1943 |(((
sonish 3.1 1944 (% class="western" %)
sonish 1.1 1945 **Request**
1946 )))|(((
sonish 3.1 1947 (% class="western" %)
sonish 1.1 1948 **Type**
1949 )))|(((
sonish 3.1 1950 (% class="western" %)
sonish 1.1 1951 **Description**
1952 )))
1953 |(((
sonish 3.1 1954 (% class="western" %)
sonish 1.1 1955 Sources
1956 )))|(((
sonish 3.1 1957 (% class="western" %)
sonish 1.1 1958 Sources
1959 )))|(((
sonish 3.1 1960 (% class="western" %)
sonish 1.1 1961 Defines the contents that makes up the source. Id parameters should not be set.
1962 )))
1963
1964 |(((
sonish 3.1 1965 (% class="western" %)
sonish 1.1 1966 **Response**
1967 )))|(((
sonish 3.1 1968 (% class="western" %)
sonish 1.1 1969 **Type**
1970 )))|(((
sonish 3.1 1971 (% class="western" %)
sonish 1.1 1972 **Description**
1973 )))
1974 |(((
sonish 3.1 1975 (% class="western" %)
sonish 1.1 1976 SourceId
1977 )))|(((
sonish 3.1 1978 (% class="western" %)
sonish 1.1 1979 int
1980 )))|(((
sonish 3.1 1981 (% class="western" %)
sonish 1.1 1982 Returns created source code id.
1983 )))
1984
sonish 3.1 1985
sonish 1.1 1986
sonish 3.1 1987 (% class="western" %)
1988 **PUT method can be used to update an individual source given the id.**
sonish 1.1 1989
1990 |(((
sonish 3.1 1991 (% class="western" %)
sonish 1.1 1992 **Request**
1993 )))|(((
sonish 3.1 1994 (% class="western" %)
sonish 1.1 1995 **Type**
1996 )))|(((
sonish 3.1 1997 (% class="western" %)
sonish 1.1 1998 **Description**
1999 )))
2000 |(((
sonish 3.1 2001 (% class="western" %)
sonish 1.1 2002 Sources
2003 )))|(((
sonish 3.1 2004 (% class="western" %)
sonish 1.1 2005 Sources
2006 )))|(((
sonish 3.1 2007 (% class="western" %)
sonish 1.1 2008 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.
2009 )))
2010
2011 |(((
sonish 3.1 2012 (% class="western" %)
sonish 1.1 2013 **Response**
2014 )))|(((
sonish 3.1 2015 (% class="western" %)
sonish 1.1 2016 **Type**
2017 )))|(((
sonish 3.1 2018 (% class="western" %)
sonish 1.1 2019 **Description**
2020 )))
2021 |(((
sonish 3.1 2022 (% class="western" %)
sonish 1.1 2023 SourceId
2024 )))|(((
sonish 3.1 2025 (% class="western" %)
sonish 1.1 2026 int
2027 )))|(((
sonish 3.1 2028 (% class="western" %)
sonish 1.1 2029 Returns updated source id.
2030 )))
2031
sonish 3.1 2032
sonish 1.1 2033
sonish 3.1 2034 (% class="western" %)
2035
sonish 1.1 2036
sonish 3.1 2037 (% class="western" %)
2038 **Transactions**
2039
2040 (% class="western" %)
2041 This resource is for manipulating transactions resource. A transaction can be created or searched.
2042
sonish 1.1 2043 |(((
sonish 3.1 2044 (% class="western" %)
sonish 1.1 2045 **Method**
2046 )))|(((
sonish 3.1 2047 (% class="western" %)
sonish 1.1 2048 **Url**
2049 )))|(((
sonish 3.1 2050 (% class="western" %)
sonish 1.1 2051 **Action**
2052 )))
2053 |(((
sonish 3.1 2054 (% class="western" %)
sonish 1.1 2055 GET
2056 )))|(((
sonish 3.1 2057 (% class="western" %)
sonish 1.1 2058 /transactions
2059 )))|(((
sonish 3.1 2060 (% class="western" %)
sonish 1.1 2061 List all transactions
2062 )))
2063 |(((
sonish 3.1 2064 (% class="western" %)
sonish 1.1 2065 GET
2066 )))|(((
sonish 3.1 2067 (% class="western" %)
sonish 1.1 2068 /transactions/lookup?UserId=1
2069 )))|(((
sonish 3.1 2070 (% class="western" %)
sonish 1.1 2071 Lookup all transaction of UserId = 1
2072 )))
2073 |(((
sonish 3.1 2074 (% class="western" %)
sonish 1.1 2075 POST
2076 )))|(((
sonish 3.1 2077 (% class="western" %)
sonish 1.1 2078 /transactions
2079 )))|(((
sonish 3.1 2080 (% class="western" %)
sonish 1.1 2081 JSON of the Transactions type object needs to be sent as post data. Id field should not be sent.
2082 )))
2083
sonish 3.1 2084
sonish 1.1 2085
sonish 3.1 2086 (% class="western" %)
2087
sonish 1.1 2088
sonish 3.1 2089 (% class="western" %)
2090 Transactions can be looked up using transactionId, date range, userid. Use GET method to do lookup.
2091
sonish 1.1 2092 |(((
sonish 3.1 2093 (% class="western" %)
sonish 1.1 2094 **Request**
2095 )))|(((
sonish 3.1 2096 (% class="western" %)
sonish 1.1 2097 **Type**
2098 )))|(((
sonish 3.1 2099 (% class="western" %)
sonish 1.1 2100 **Description**
2101 )))
2102 |(((
sonish 3.1 2103 (% class="western" %)
sonish 1.1 2104 Lookup params
2105 )))|(((
sonish 3.1 2106 (% class="western" %)
sonish 1.1 2107 String
2108 )))|(((
sonish 3.1 2109 (% class="western" %)
2110 URL encoded key value string parameter for the lookup.
2111
2112 (% class="western" %)
2113 Params:
2114
2115 (% class="western" %)
2116 UserId: Id of the user whose transaction is to be looked up (Int)
2117
2118 (% class="western" %)
2119 StartDate: Date from which the start should happen. Only valid when UserId is set. (Date)
2120
2121 (% class="western" %)
2122 EndDate: When the search should end. Only valid when UserId is set. (Date)
sonish 1.1 2123 )))
2124
sonish 3.1 2125
sonish 1.1 2126
sonish 3.1 2127
sonish 1.1 2128
2129 |(((
sonish 3.1 2130 (% class="western" %)
sonish 1.1 2131 **Response**
2132 )))|(((
sonish 3.1 2133 (% class="western" %)
sonish 1.1 2134 **Type**
2135 )))|(((
sonish 3.1 2136 (% class="western" %)
sonish 1.1 2137 **Description**
2138 )))
2139 |(((
sonish 3.1 2140 (% class="western" %)
sonish 1.1 2141 Transactions
2142 )))|(((
sonish 3.1 2143 (% class="western" %)
sonish 1.1 2144 Transactions
2145 )))|(((
sonish 3.1 2146 (% class="western" %)
sonish 1.1 2147 Returns all transaction that satisfies the search criteria.
2148 )))
2149
sonish 3.1 2150
sonish 1.1 2151
sonish 3.1 2152 (% class="western" %)
2153 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.
sonish 1.1 2154
2155 |(((
sonish 3.1 2156 (% class="western" %)
sonish 1.1 2157 **Request**
2158 )))|(((
sonish 3.1 2159 (% class="western" %)
sonish 1.1 2160 **Type**
2161 )))|(((
sonish 3.1 2162 (% class="western" %)
sonish 1.1 2163 **Description**
2164 )))
2165 |(((
sonish 3.1 2166 (% class="western" %)
sonish 1.1 2167 Transactions
2168 )))|(((
sonish 3.1 2169 (% class="western" %)
sonish 1.1 2170 Transactions
2171 )))|(((
sonish 3.1 2172 (% class="western" %)
sonish 1.1 2173 Contains fields that define a transaction. Id field should not be set.
2174 )))
2175
2176 |(((
sonish 3.1 2177 (% class="western" %)
sonish 1.1 2178 **Response**
2179 )))|(((
sonish 3.1 2180 (% class="western" %)
sonish 1.1 2181 **Type**
2182 )))|(((
sonish 3.1 2183 (% class="western" %)
sonish 1.1 2184 **Description**
2185 )))
2186 |(((
sonish 3.1 2187 (% class="western" %)
sonish 1.1 2188 TransactionId
2189 )))|(((
sonish 3.1 2190 (% class="western" %)
sonish 1.1 2191 int
2192 )))|(((
sonish 3.1 2193 (% class="western" %)
sonish 1.1 2194 Returns transactionId of the newly created transaction.
2195 )))
2196
sonish 3.1 2197
sonish 1.1 2198
sonish 3.1 2199 (% class="western" %)
2200 **Stats**
sonish 1.1 2201
sonish 3.1 2202 (% class="western" %)
2203 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.
2204
2205 (% class="western" %)
2206
2207
2208 (% class="western" %)
2209
2210
2211 (% class="western" %)
2212
2213
2214 (% class="western" %)
2215
2216
2217 (% class="western" %)
2218
2219
2220 (% class="western" %)
2221 **Telemarketing**
2222
2223 (% class="western" %)
2224
2225 This resource is for manipulating telemarketing stat resource. A telemarketing stat can be created or listed.
2226
sonish 1.1 2227 |(((
sonish 3.1 2228 (% class="western" %)
sonish 1.1 2229 **Method**
2230 )))|(((
sonish 3.1 2231 (% class="western" %)
sonish 1.1 2232 **Url**
2233 )))|(((
sonish 3.1 2234 (% class="western" %)
sonish 1.1 2235 **Action**
2236 )))
2237 |(((
sonish 3.1 2238 (% class="western" %)
sonish 1.1 2239 GET
2240 )))|(((
sonish 3.1 2241 (% class="western" %)
sonish 1.1 2242 /stats/telemarketing
2243 )))|(((
sonish 3.1 2244 (% class="western" %)
sonish 1.1 2245 List telemarketing stats
2246 )))
2247 |(((
sonish 3.1 2248 (% class="western" %)
sonish 1.1 2249 GET
2250 )))|(((
sonish 3.1 2251 (% class="western" %)
sonish 1.1 2252 /stats/telemarketing/1000
2253 )))|(((
sonish 3.1 2254 (% class="western" %)
sonish 1.1 2255 Get telemarketing stat whose id is 1000 in the system.
2256 )))
2257 |(((
sonish 3.1 2258 (% class="western" %)
sonish 1.1 2259 POST
2260 )))|(((
sonish 3.1 2261 (% class="western" %)
sonish 1.1 2262 /stats/telemarketing
2263 )))|(((
sonish 3.1 2264 (% class="western" %)
sonish 1.1 2265 JSON of the Telemarketing type object needs to be sent as post data. Id field should not be sent.
2266 )))
2267
sonish 3.1 2268
sonish 1.1 2269
sonish 3.1 2270 (% class="western" %)
2271 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.
sonish 1.1 2272
2273 |(((
sonish 3.1 2274 (% class="western" %)
2275 **Request**
sonish 1.1 2276 )))|(((
sonish 3.1 2277 (% class="western" %)
2278 **Type**
sonish 1.1 2279 )))|(((
sonish 3.1 2280 (% class="western" %)
2281 **Description**
sonish 1.1 2282 )))
2283 |(((
sonish 3.1 2284 (% class="western" %)
2285 Telemarketing
sonish 1.1 2286 )))|(((
sonish 3.1 2287 (% class="western" %)
2288 Telemarketing
sonish 1.1 2289 )))|(((
sonish 3.1 2290 (% class="western" %)
2291 Contains fields that define a telemarketing stat. Id field should not be set. Refer to telemarketing object in references section.
2292
2293 (% class="western" %)
sonish 1.1 2294 Workflow: OCID: This id is required field. This represents the unique id of the user in onecount system. This id can be looked up from the /user/lookup resource if the ocid is not known by providing user demographic questions, if not found new user needs to be created in the onecount system by posting the user demographic from /user resource. If the ocid is found send the demo data to user resource (PUT) to update the demographic information.
sonish 3.1 2295
2296 (% class="western" %)
sonish 1.1 2297 E.g
sonish 3.1 2298
2299 (% class="western" %)
sonish 1.1 2300 {
sonish 3.1 2301
2302 (% class="western" %)
sonish 1.1 2303 "Telemarketing":[
sonish 3.1 2304
2305 (% class="western" %)
sonish 1.1 2306 {
sonish 3.1 2307
2308 (% class="western" %)
sonish 1.1 2309 "OCID":"5000",
sonish 3.1 2310
2311 (% class="western" %)
sonish 1.1 2312 "Date": "2016-01-01",
sonish 3.1 2313
2314 (% class="western" %)
sonish 1.1 2315 "Time": "10:10:10",
sonish 3.1 2316
2317 (% class="western" %)
sonish 1.1 2318 "ResourceId":"250",
sonish 3.1 2319
2320 (% class="western" %)
2321 "PageUrl": "[[http:~~/~~/www.one-count.com/detail/a.php>>url:http://www.one-count.com/detail/a.php||shape="rect" class="western"]]",
2322
2323 (% class="western" %)
sonish 1.1 2324 "PageTitle":"tests"
sonish 3.1 2325
2326 (% class="western" %)
sonish 1.1 2327 }
sonish 3.1 2328
2329 (% class="western" %)
sonish 1.1 2330 ]
sonish 3.1 2331
2332 (% class="western" %)
2333 }
sonish 1.1 2334 )))
2335 |(((
sonish 3.1 2336 (% class="western" %)
sonish 1.1 2337
2338 )))|(((
sonish 3.1 2339 (% class="western" %)
sonish 1.1 2340
2341 )))|(((
sonish 3.1 2342 (% class="western" %)
sonish 1.1 2343
2344 )))
2345
2346 |(((
sonish 3.1 2347 (% class="western" %)
sonish 1.1 2348 **Response**
2349 )))|(((
sonish 3.1 2350 (% class="western" %)
sonish 1.1 2351 **Type**
2352 )))|(((
sonish 3.1 2353 (% class="western" %)
sonish 1.1 2354 **Description**
2355 )))
2356 |(((
sonish 3.1 2357 (% class="western" %)
sonish 1.1 2358 Ids
2359 )))|(((
sonish 3.1 2360 (% class="western" %)
sonish 1.1 2361 String
2362 )))|(((
sonish 3.1 2363 (% class="western" %)
sonish 1.1 2364 Returns telemarketing ids of the newly created transaction. If multiple stats are sent, multiple ids are returned in cvs format.
2365 )))
2366
sonish 3.1 2367
sonish 1.1 2368
sonish 3.1 2369 (% class="western" %)
2370 **Reference**
sonish 1.1 2371
sonish 3.1 2372 (% class="western" %)
2373 **Type: Questions**
2374
sonish 1.1 2375 |(((
sonish 3.1 2376 (% class="western" %)
2377 **Property Name**
sonish 1.1 2378 )))|(((
sonish 3.1 2379 (% class="western" %)
sonish 1.1 2380 **Type**
2381 )))|(((
sonish 3.1 2382 (% class="western" %)
sonish 1.1 2383 **Description**
2384 )))
2385 |(((
sonish 3.1 2386 (% class="western" %)
sonish 1.1 2387 Id
2388 )))|(((
sonish 3.1 2389 (% class="western" %)
sonish 1.1 2390 Int
2391 )))|(((
sonish 3.1 2392 (% class="western" %)
sonish 1.1 2393 Id of the question.
2394 )))
2395 |(((
sonish 3.1 2396 (% class="western" %)
sonish 1.1 2397 Text
2398 )))|(((
sonish 3.1 2399 (% class="western" %)
sonish 1.1 2400 String
2401 )))|(((
sonish 3.1 2402 (% class="western" %)
sonish 1.1 2403 Text of the question.
2404 )))
2405 |(((
sonish 3.1 2406 (% class="western" %)
sonish 1.1 2407 Type
2408 )))|(((
sonish 3.1 2409 (% class="western" %)
sonish 1.1 2410 Int
2411 )))|(((
sonish 3.1 2412 (% class="western" %)
2413 Determines which type of question it is. Textbox, checkbox, select, radio.
2414 There can be 6 types of questions.
2415 type=1 means textbox type questions or short response type question. The response length needs to be less than 255 characters.
2416 type=2 means textarea type question or long response type question.
2417 type=3 means password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *
2418 type = 4 means 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.
2419 type=5 means 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.
2420 type=6 means 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.
sonish 1.1 2421 )))
2422 |(((
sonish 3.1 2423 (% class="western" %)
sonish 1.1 2424 Choices
2425 )))|(((
sonish 3.1 2426 (% class="western" %)
sonish 1.1 2427 choices
2428 )))|(((
sonish 3.1 2429 (% class="western" %)
sonish 1.1 2430 If multiple choice question this field will have the choices.
2431 )))
2432 |(((
sonish 3.1 2433 (% class="western" %)
sonish 1.1 2434 Alias
2435 )))|(((
sonish 3.1 2436 (% class="western" %)
sonish 1.1 2437 String
2438 )))|(((
sonish 3.1 2439 (% class="western" %)
sonish 1.1 2440 Alias for admin purpose.
2441 )))
2442
sonish 3.1 2443
sonish 1.1 2444
sonish 3.1 2445 (% class="western" %)
2446
sonish 1.1 2447
sonish 3.1 2448 (% class="western" %)
2449
2450
2451 (% class="western" %)
2452 **Type: Choices**
2453
sonish 1.1 2454 |(((
sonish 3.1 2455 (% class="western" %)
2456 **Property Name**
sonish 1.1 2457 )))|(((
sonish 3.1 2458 (% class="western" %)
sonish 1.1 2459 **Type**
2460 )))|(((
sonish 3.1 2461 (% class="western" %)
sonish 1.1 2462 **Description**
2463 )))
2464 |(((
sonish 3.1 2465 (% class="western" %)
sonish 1.1 2466 Id
2467 )))|(((
sonish 3.1 2468 (% class="western" %)
sonish 1.1 2469 int
2470 )))|(((
sonish 3.1 2471 (% class="western" %)
sonish 1.1 2472 Id of the choice.
2473 )))
2474 |(((
sonish 3.1 2475 (% class="western" %)
sonish 1.1 2476 Text
2477 )))|(((
sonish 3.1 2478 (% class="western" %)
sonish 1.1 2479 string
2480 )))|(((
sonish 3.1 2481 (% class="western" %)
sonish 1.1 2482 Display text of choice.
2483 )))
2484 |(((
sonish 3.1 2485 (% class="western" %)
sonish 1.1 2486 Value
2487 )))|(((
sonish 3.1 2488 (% class="western" %)
sonish 1.1 2489 String
2490 )))|(((
sonish 3.1 2491 (% class="western" %)
sonish 1.1 2492 Value stored in db.
2493 )))
2494 |(((
sonish 3.1 2495 (% class="western" %)
sonish 1.1 2496 Order
2497 )))|(((
sonish 3.1 2498 (% class="western" %)
sonish 1.1 2499 Int
2500 )))|(((
sonish 3.1 2501 (% class="western" %)
sonish 1.1 2502 Display order.
2503 )))
2504 |(((
sonish 3.1 2505 (% class="western" %)
sonish 1.1 2506 QuestionId
2507 )))|(((
sonish 3.1 2508 (% class="western" %)
sonish 1.1 2509 Int
2510 )))|(((
sonish 3.1 2511 (% class="western" %)
sonish 1.1 2512 Tied to which question id.
2513 )))
2514
sonish 3.1 2515
sonish 1.1 2516
sonish 3.1 2517 (% class="western" %)
2518 **Type: Users**
sonish 1.1 2519
2520 |(((
sonish 3.1 2521 (% class="western" %)
2522 **Property Name**
sonish 1.1 2523 )))|(((
sonish 3.1 2524 (% class="western" %)
sonish 1.1 2525 **Type**
2526 )))|(((
sonish 3.1 2527 (% class="western" %)
sonish 1.1 2528 **Description**
2529 )))
2530 |(((
sonish 3.1 2531 (% class="western" %)
sonish 1.1 2532 Id
2533 )))|(((
sonish 3.1 2534 (% class="western" %)
sonish 1.1 2535 Int
2536 )))|(((
sonish 3.1 2537 (% class="western" %)
sonish 1.1 2538 ID of the user in ONEcount.
2539 )))
2540 |(((
sonish 3.1 2541 (% class="western" %)
sonish 1.1 2542 PartnerId
2543 )))|(((
sonish 3.1 2544 (% class="western" %)
sonish 1.1 2545 Int
2546 )))|(((
sonish 3.1 2547 (% class="western" %)
sonish 1.1 2548 ID of the user in partners system (e.g. id of your system).
2549 )))
2550 |(((
sonish 3.1 2551 (% class="western" %)
sonish 1.1 2552 Demo
2553 )))|(((
sonish 3.1 2554 (% class="western" %)
sonish 1.1 2555 Demo
2556 )))|(((
sonish 3.1 2557 (% class="western" %)
sonish 1.1 2558 Object of user's demo question ids and respective response values.
2559 )))
2560 |(((
sonish 3.1 2561 (% class="western" %)
sonish 1.1 2562 RequestDate
2563 )))|(((
sonish 3.1 2564 (% class="western" %)
sonish 1.1 2565 Date
2566 )))|(((
sonish 3.1 2567 (% class="western" %)
sonish 1.1 2568 Request date.
2569 )))
2570
sonish 3.1 2571
sonish 1.1 2572
sonish 3.1 2573 (% class="western" %)
2574 **Type: Demo**
sonish 1.1 2575
2576 |(((
sonish 3.1 2577 (% class="western" %)
2578 **Property Name**
sonish 1.1 2579 )))|(((
sonish 3.1 2580 (% class="western" %)
sonish 1.1 2581 **Type**
2582 )))|(((
sonish 3.1 2583 (% class="western" %)
sonish 1.1 2584 **Description**
2585 )))
2586 |(((
sonish 3.1 2587 (% class="western" %)
sonish 1.1 2588 QuestionId (e.g 6)
2589 )))|(((
sonish 3.1 2590 (% class="western" %)
sonish 1.1 2591 String
2592 )))|(((
sonish 3.1 2593 (% class="western" %)
2594 6 is the value of “Id” property of question resource(Text = “First Name”)
sonish 1.1 2595 )))
2596 |(((
sonish 3.1 2597 (% class="western" %)
sonish 1.1 2598 QuestionId (e.g 7)
2599 )))|(((
sonish 3.1 2600 (% class="western" %)
sonish 1.1 2601 String
2602 )))|(((
sonish 3.1 2603 (% class="western" %)
2604 7 is the value of “Id” property of question resource(Text = “Last Name”)
sonish 1.1 2605 )))
2606 |(((
sonish 3.1 2607 (% class="western" %)
sonish 1.1 2608 ...
2609 )))|(((
sonish 3.1 2610 (% class="western" %)
sonish 1.1 2611 ...
2612 )))|(((
sonish 3.1 2613 (% class="western" %)
sonish 1.1 2614 ...
2615 )))
2616
sonish 3.1 2617
sonish 1.1 2618
sonish 3.1 2619 (% class="western" %)
2620 **Type: Transactions**
sonish 1.1 2621
2622 |(((
sonish 3.1 2623 (% class="western" %)
2624 **Property Name**
sonish 1.1 2625 )))|(((
sonish 3.1 2626 (% class="western" %)
sonish 1.1 2627 **Type**
2628 )))|(((
sonish 3.1 2629 (% class="western" %)
sonish 1.1 2630 **Description**
2631 )))
2632 |(((
sonish 3.1 2633 (% class="western" %)
sonish 1.1 2634 Id
2635 )))|(((
sonish 3.1 2636 (% class="western" %)
sonish 1.1 2637 Int
2638 )))|(((
sonish 3.1 2639 (% class="western" %)
sonish 1.1 2640 ID of the transaction.
2641 )))
2642 |(((
sonish 3.1 2643 (% class="western" %)
sonish 1.1 2644 UserId
2645 )))|(((
sonish 3.1 2646 (% class="western" %)
sonish 1.1 2647 Int
2648 )))|(((
sonish 3.1 2649 (% class="western" %)
sonish 1.1 2650 Id of user in ONEcount.
2651 )))
2652 |(((
sonish 3.1 2653 (% class="western" %)
sonish 1.1 2654 TermId
2655 )))|(((
sonish 3.1 2656 (% class="western" %)
sonish 1.1 2657 Int
2658 )))|(((
sonish 3.1 2659 (% class="western" %)
sonish 1.1 2660 TermId in ONEcount.
2661 )))
2662 |(((
sonish 3.1 2663 (% class="western" %)
sonish 1.1 2664 ProductStatus
2665 )))|(((
sonish 3.1 2666 (% class="western" %)
sonish 1.1 2667 Int
2668 )))|(((
sonish 3.1 2669 (% class="western" %)
sonish 1.1 2670 Status ID.
2671 )))
2672 |(((
sonish 3.1 2673 (% class="western" %)
sonish 1.1 2674 SubscriptionType
2675 )))|(((
sonish 3.1 2676 (% class="western" %)
sonish 1.1 2677 Char
2678 )))|(((
sonish 3.1 2679 (% class="western" %)
sonish 1.1 2680 Can be n,r or u for new, renew or unsubscribe.
2681 )))
2682 |(((
sonish 3.1 2683 (% class="western" %)
sonish 1.1 2684 TransactionDate
2685 )))|(((
sonish 3.1 2686 (% class="western" %)
sonish 1.1 2687 Date
2688 )))|(((
sonish 3.1 2689 (% class="western" %)
sonish 1.1 2690 Date when the transaction occurred.
2691 )))
2692 |(((
sonish 3.1 2693 (% class="western" %)
sonish 1.1 2694 TransactionTime
2695 )))|(((
sonish 3.1 2696 (% class="western" %)
sonish 1.1 2697 Time
2698 )))|(((
sonish 3.1 2699 (% class="western" %)
sonish 1.1 2700 Time of transaction.
2701 )))
2702 |(((
sonish 3.1 2703 (% class="western" %)
sonish 1.1 2704 RequestDate
2705 )))|(((
sonish 3.1 2706 (% class="western" %)
sonish 1.1 2707 Date
2708 )))|(((
sonish 3.1 2709 (% class="western" %)
sonish 1.1 2710 The effective request date for the transaction.
2711 )))
2712 |(((
sonish 3.1 2713 (% class="western" %)
sonish 1.1 2714 UserIP
2715 )))|(((
sonish 3.1 2716 (% class="western" %)
sonish 1.1 2717 String
2718 )))|(((
sonish 3.1 2719 (% class="western" %)
sonish 1.1 2720 IP of the user.
2721 )))
2722 |(((
sonish 3.1 2723 (% class="western" %)
sonish 1.1 2724 Source
2725 )))|(((
sonish 3.1 2726 (% class="western" %)
sonish 1.1 2727 String
2728 )))|(((
sonish 3.1 2729 (% class="western" %)
sonish 1.1 2730 The transaction needs to be tied to a source code this will define it.
2731 )))
2732 |(((
sonish 3.1 2733 (% class="western" %)
sonish 1.1 2734 MediaFilePath
2735 )))|(((
sonish 3.1 2736 (% class="western" %)
sonish 1.1 2737 String
2738 )))|(((
sonish 3.1 2739 (% class="western" %)
sonish 1.1 2740 The url of media associated with that transaction. Eg image, audio.
2741 )))
2742 |(((
sonish 3.1 2743 (% class="western" %)
sonish 1.1 2744 ExpireDate
2745 )))|(((
sonish 3.1 2746 (% class="western" %)
sonish 1.1 2747 Date
2748 )))|(((
sonish 3.1 2749 (% class="western" %)
sonish 1.1 2750 Date when the subscription expires.
2751 )))
2752 |(((
sonish 3.1 2753 (% class="western" %)
sonish 1.1 2754 Amount
2755 )))|(((
sonish 3.1 2756 (% class="western" %)
sonish 1.1 2757 Float
2758 )))|(((
sonish 3.1 2759 (% class="western" %)
sonish 1.1 2760 If there is amount (USD) included in transaction.
2761 )))
2762
sonish 3.1 2763
sonish 1.1 2764
sonish 3.1 2765 (% class="western" %)
2766 **Type: Sources**
sonish 1.1 2767
2768 |(((
sonish 3.1 2769 (% class="western" %)
2770 **Property Name**
sonish 1.1 2771 )))|(((
sonish 3.1 2772 (% class="western" %)
sonish 1.1 2773 **Type**
2774 )))|(((
sonish 3.1 2775 (% class="western" %)
sonish 1.1 2776 **Description**
2777 )))
2778 |(((
sonish 3.1 2779 (% class="western" %)
sonish 1.1 2780 Id
2781 )))|(((
sonish 3.1 2782 (% class="western" %)
sonish 1.1 2783 Int
2784 )))|(((
sonish 3.1 2785 (% class="western" %)
sonish 1.1 2786 Id of the source.
2787 )))
2788 |(((
sonish 3.1 2789 (% class="western" %)
sonish 1.1 2790 Source
2791 )))|(((
sonish 3.1 2792 (% class="western" %)
sonish 1.1 2793 String
2794 )))|(((
sonish 3.1 2795 (% class="western" %)
sonish 1.1 2796 Value of the source.
2797 )))
2798 |(((
sonish 3.1 2799 (% class="western" %)
sonish 1.1 2800 Description
2801 )))|(((
sonish 3.1 2802 (% class="western" %)
sonish 1.1 2803 Text
2804 )))|(((
sonish 3.1 2805 (% class="western" %)
sonish 1.1 2806 Description of the source.
2807 )))
2808 |(((
sonish 3.1 2809 (% class="western" %)
sonish 1.1 2810 ParentId
2811 )))|(((
sonish 3.1 2812 (% class="western" %)
sonish 1.1 2813 int
2814 )))|(((
sonish 3.1 2815 (% class="western" %)
sonish 1.1 2816 If this is a child source then list the parent source id.
2817 )))
2818
sonish 3.1 2819
sonish 1.1 2820
sonish 3.1 2821 (% class="western" %)
2822
sonish 1.1 2823
sonish 3.1 2824 (% class="western" %)
2825 **Type: Products**
2826
sonish 1.1 2827 |(((
sonish 3.1 2828 (% class="western" %)
2829 **Property Name**
sonish 1.1 2830 )))|(((
sonish 3.1 2831 (% class="western" %)
sonish 1.1 2832 **Type**
2833 )))|(((
sonish 3.1 2834 (% class="western" %)
sonish 1.1 2835 **Description**
2836 )))
2837 |(((
sonish 3.1 2838 (% class="western" %)
sonish 1.1 2839 Id
2840 )))|(((
sonish 3.1 2841 (% class="western" %)
sonish 1.1 2842 Int
2843 )))|(((
sonish 3.1 2844 (% class="western" %)
sonish 1.1 2845 Specify only for update.
2846 )))
2847 |(((
sonish 3.1 2848 (% class="western" %)
sonish 1.1 2849 Name
2850 )))|(((
sonish 3.1 2851 (% class="western" %)
sonish 1.1 2852 String
2853 )))|(((
sonish 3.1 2854 (% class="western" %)
sonish 1.1 2855 Name of the Product.
2856 )))
2857 |(((
sonish 3.1 2858 (% class="western" %)
sonish 1.1 2859 Description
2860 )))|(((
sonish 3.1 2861 (% class="western" %)
sonish 1.1 2862 Text
2863 )))|(((
sonish 3.1 2864 (% class="western" %)
sonish 1.1 2865 Description of the product.
2866 )))
2867 |(((
sonish 3.1 2868 (% class="western" %)
sonish 1.1 2869 Terms
2870 )))|(((
sonish 3.1 2871 (% class="western" %)
sonish 1.1 2872 Terms
2873 )))|(((
sonish 3.1 2874 (% class="western" %)
sonish 1.1 2875 (Array of) Terms associated with the product.
2876 )))
2877
sonish 3.1 2878
sonish 1.1 2879
sonish 3.1 2880 (% class="western" %)
2881 **Type: Terms**
sonish 1.1 2882
2883 |(((
sonish 3.1 2884 (% class="western" %)
2885 **Property Name**
sonish 1.1 2886 )))|(((
sonish 3.1 2887 (% class="western" %)
sonish 1.1 2888 **Type**
2889 )))|(((
sonish 3.1 2890 (% class="western" %)
sonish 1.1 2891 **Description**
2892 )))
2893 |(((
sonish 3.1 2894 (% class="western" %)
sonish 1.1 2895 Id
2896 )))|(((
sonish 3.1 2897 (% class="western" %)
sonish 1.1 2898 int
2899 )))|(((
sonish 3.1 2900 (% class="western" %)
sonish 1.1 2901 Id of the term.
2902 )))
2903 |(((
sonish 3.1 2904 (% class="western" %)
sonish 1.1 2905 Name
2906 )))|(((
sonish 3.1 2907 (% class="western" %)
sonish 1.1 2908 string
2909 )))|(((
sonish 3.1 2910 (% class="western" %)
sonish 1.1 2911 Name of the Term.
2912 )))
2913 |(((
sonish 3.1 2914 (% class="western" %)
sonish 1.1 2915 Description
2916 )))|(((
sonish 3.1 2917 (% class="western" %)
sonish 1.1 2918 text
2919 )))|(((
sonish 3.1 2920 (% class="western" %)
sonish 1.1 2921 Description of the term.
2922 )))
2923 |(((
sonish 3.1 2924 (% class="western" %)
sonish 1.1 2925 Duration
2926 )))|(((
sonish 3.1 2927 (% class="western" %)
sonish 1.1 2928 int
2929 )))|(((
sonish 3.1 2930 (% class="western" %)
sonish 1.1 2931 Duration of term validity.
2932 )))
2933 |(((
sonish 3.1 2934 (% class="western" %)
sonish 1.1 2935 DurationUnit
2936 )))|(((
sonish 3.1 2937 (% class="western" %)
sonish 1.1 2938 sting
2939 )))|(((
sonish 3.1 2940 (% class="western" %)
sonish 1.1 2941 Y (year), M (Month), D (Days).
2942 )))
2943 |(((
sonish 3.1 2944 (% class="western" %)
sonish 1.1 2945 ProductId
2946 )))|(((
sonish 3.1 2947 (% class="western" %)
sonish 1.1 2948 int
2949 )))|(((
sonish 3.1 2950 (% class="western" %)
sonish 1.1 2951 Id of the product the term is tied to.
2952 )))
2953 |(((
sonish 3.1 2954 (% class="western" %)
sonish 1.1 2955 Price
2956 )))|(((
sonish 3.1 2957 (% class="western" %)
sonish 1.1 2958 float
2959 )))|(((
sonish 3.1 2960 (% class="western" %)
sonish 1.1 2961 If there is price (USD) for the term.
2962 )))
2963
sonish 3.1 2964
sonish 1.1 2965
sonish 3.1 2966 (% class="western" %)
2967 **Type: Resources**
sonish 1.1 2968
2969 |(((
sonish 3.1 2970 (% class="western" %)
2971 **Property Name**
sonish 1.1 2972 )))|(((
sonish 3.1 2973 (% class="western" %)
sonish 1.1 2974 **Type**
2975 )))|(((
sonish 3.1 2976 (% class="western" %)
sonish 1.1 2977 **Description**
2978 )))
2979 |(((
sonish 3.1 2980 (% class="western" %)
sonish 1.1 2981 Id
2982 )))|(((
sonish 3.1 2983 (% class="western" %)
sonish 1.1 2984 Int
2985 )))|(((
sonish 3.1 2986 (% class="western" %)
sonish 1.1 2987 Specify only for update.
2988 )))
2989 |(((
sonish 3.1 2990 (% class="western" %)
sonish 1.1 2991 Name
2992 )))|(((
sonish 3.1 2993 (% class="western" %)
sonish 1.1 2994 String
2995 )))|(((
sonish 3.1 2996 (% class="western" %)
sonish 1.1 2997 Name of the Resource.
2998 )))
2999 |(((
sonish 3.1 3000 (% class="western" %)
sonish 1.1 3001 Description
3002 )))|(((
sonish 3.1 3003 (% class="western" %)
sonish 1.1 3004 Text
3005 )))|(((
sonish 3.1 3006 (% class="western" %)
sonish 1.1 3007 Description of the Resource.
3008 )))
3009 |(((
sonish 3.1 3010 (% class="western" %)
sonish 1.1 3011 Type
3012 )))|(((
sonish 3.1 3013 (% class="western" %)
sonish 1.1 3014 Int
3015 )))|(((
sonish 3.1 3016 (% class="western" %)
3017 Type Options
3018
3019 (% class="western" %)
3020 **0** : File
3021
3022 (% class="western" %)
3023 **2 : **Newsletter
3024
3025 (% class="western" %)
3026 **3 : **Section
3027
3028 (% class="western" %)
3029 **4 : **Page
3030
3031 (% class="western" %)
3032 **5 : **Function
sonish 1.1 3033 )))
3034 |(((
sonish 3.1 3035 (% class="western" %)
sonish 1.1 3036 Value
3037 )))|(((
sonish 3.1 3038 (% class="western" %)
sonish 1.1 3039 String
3040 )))|(((
sonish 3.1 3041 (% class="western" %)
3042 Value of Resource Type.
3043
3044 (% class="western" %)
3045 Example : if the Type sent is 3 then Value would be **/digital/**
3046
3047 (% class="western" %)
3048 For Function type resource leave it blank.
sonish 1.1 3049 )))
sonish 3.1 3050 |(((
3051 (% class="western" %)
3052 limit
3053 )))|(((
3054 (% class="western" %)
3055 Int
3056 )))|(((
3057 (% class="western" %)
3058 Default limit is 25 but all the data needs to be pulled then pass limit=0.
3059 )))
sonish 1.1 3060
sonish 3.1 3061
sonish 1.1 3062
sonish 3.1 3063 (% class="western" %)
3064 **Type: Telemarketing**
sonish 1.1 3065
3066 |(((
sonish 3.1 3067 (% class="western" %)
3068 **Property Name**
sonish 1.1 3069 )))|(((
sonish 3.1 3070 (% class="western" %)
sonish 1.1 3071 **Type**
3072 )))|(((
sonish 3.1 3073 (% class="western" %)
sonish 1.1 3074 **Description**
3075 )))
3076 |(((
sonish 3.1 3077 (% class="western" %)
sonish 1.1 3078 Id
3079 )))|(((
sonish 3.1 3080 (% class="western" %)
sonish 1.1 3081 int
3082 )))|(((
sonish 3.1 3083 (% class="western" %)
sonish 1.1 3084 Id of the telemarketing stat. This is autogenerated from the system and can be used to lookup the stat.
3085 )))
3086 |(((
sonish 3.1 3087 (% class="western" %)
sonish 1.1 3088 OCID
3089 )))|(((
sonish 3.1 3090 (% class="western" %)
sonish 1.1 3091 int
3092 )))|(((
sonish 3.1 3093 (% class="western" %)
sonish 1.1 3094 Onecount ID of the user.
3095 )))
3096 |(((
sonish 3.1 3097 (% class="western" %)
sonish 1.1 3098 Date
3099 )))|(((
sonish 3.1 3100 (% class="western" %)
sonish 1.1 3101 Date
3102 )))|(((
sonish 3.1 3103 (% class="western" %)
sonish 1.1 3104 Date when the stat occurred. Format: yyyy-mm-dd
3105 )))
3106 |(((
sonish 3.1 3107 (% class="western" %)
sonish 1.1 3108 Time
3109 )))|(((
sonish 3.1 3110 (% class="western" %)
sonish 1.1 3111 Time
3112 )))|(((
sonish 3.1 3113 (% class="western" %)
sonish 1.1 3114 Time of stat. Format: h:m:s (24 hour format)
3115 )))
3116 |(((
sonish 3.1 3117 (% class="western" %)
sonish 1.1 3118 ResourceId
3119 )))|(((
sonish 3.1 3120 (% class="western" %)
sonish 1.1 3121 int
3122 )))|(((
sonish 3.1 3123 (% class="western" %)
3124 Id of resource currently being sent for the sat. If the resource type is page type resource then need to send
3125
3126 (% class="western" %)
sonish 1.1 3127 PageTitle otherwise it will follow the process described in PageTitle.
3128 )))
3129 |(((
sonish 3.1 3130 (% class="western" %)
sonish 1.1 3131 PageUrl
3132 )))|(((
sonish 3.1 3133 (% class="western" %)
sonish 1.1 3134 string
3135 )))|(((
sonish 3.1 3136 (% class="western" %)
sonish 1.1 3137 Page Url belongs to resource that is being sent with this request. If the resource is file type then it needs to be path to that file and if the resource is section it needs to be section. Basically the value here needs to exact what is defined while creating resource.
3138 )))
3139 |(((
sonish 3.1 3140 (% class="western" %)
sonish 1.1 3141 PageTitle
3142 )))|(((
sonish 3.1 3143 (% class="western" %)
sonish 1.1 3144 string
3145 )))|(((
sonish 3.1 3146 (% class="western" %)
3147 Page title that belongs to the page url that is being sent. If not provided it try to pull the title from the page but if unsuccessful then it will set it as blank.
3148
3149 (% class="western" %)
3150
3151
3152 (% class="western" %)
3153 If the page url already exists and it doesn't match with the one that is being sent then it will throw conflict error with the title in our system.
sonish 1.1 3154 )))