Skip to Content

Wiki source code of ONEcount API Documentation

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