Skip to Content

Wiki source code of ONEcount API Documentation

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