Skip to Content

Wiki source code of OC-API-04032017

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