Changes for page OLD-ONEcount API Documentation
Last modified by Admin on 2025/06/27 12:14
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Objects (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -21,151 +21,43 @@ 21 21 ))) 22 22 23 23 (% class="western" %) 24 -Specifically, the ONEcount API provides following functionalities:24 +Specifically, the ONEcount API provides to the following components: 25 25 26 -1. ((( 27 -(% class="western" %) 28 -**Lookup** 26 +1. User data 27 +11. List users 28 +11. Lookup users 29 +11. Create users 30 +11. Update users 31 +1. Transaction data 32 +11. Lookup transactions 33 +11. Create transactions 34 +\\ 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. Questions 48 +11. Lookup questions 49 +11. List questions 50 +11. Create questions 51 +1. Source Codes 52 +11. Lookup source code 53 +11. Create source codes 54 +11. Update source codes 55 +1. Attach a resource to a product 56 +1. Leads 57 +11. Create a lead 58 +\\\\\\ 29 29 30 -* 31 - 32 32 (% class="western" %) 33 -User lookup 34 - 35 -* 36 - 37 -(% class="western" %) 38 -Transaction lookup 39 - 40 -* 41 - 42 -(% class="western" %) 43 -Question lookup 44 - 45 -* 46 - 47 -(% class="western" %) 48 -Source code lookup 49 - 50 -* 51 - 52 -(% class="western" %) 53 -Product lookup 54 - 55 -* 56 - 57 -(% class="western" %) 58 -Term lookup 59 - 60 -* 61 - 62 -(% class="western" %) 63 -Resource lookup 64 -))) 65 -1. ((( 66 -(% class="western" %) 67 -**Create** 68 - 69 -* 70 - 71 -(% class="western" %) 72 -Add a user/demo 73 - 74 -* 75 - 76 -(% class="western" %) 77 -Add a question 78 - 79 -* 80 - 81 -(% class="western" %) 82 -Add user transaction 83 - 84 -* 85 - 86 -(% class="western" %) 87 -Add source code 88 - 89 -* 90 - 91 -(% class="western" %) 92 -Add Product 93 - 94 -* 95 - 96 -(% class="western" %) 97 -Add Term 98 - 99 -* 100 - 101 -(% class="western" %) 102 -Add Resource 103 - 104 -* 105 - 106 -(% class="western" %) 107 -Stats – Telemarketing 108 -))) 109 -1. ((( 110 -(% class="western" %) 111 -**Update** 112 - 113 -* 114 - 115 -(% class="western" %) 116 -Update a user/demo 117 - 118 -* 119 - 120 -(% class="western" %) 121 -Update a question 122 - 123 -* 124 - 125 -(% class="western" %) 126 -Update source code 127 - 128 -* 129 - 130 -(% class="western" %) 131 -Update product 132 - 133 -* 134 - 135 -(% class="western" %) 136 -Update term 137 - 138 -* 139 - 140 -(% class="western" %) 141 -Update resource 142 -))) 143 -1. ((( 144 -(% class="western" %) 145 -**List** 146 - 147 -* 148 - 149 -(% class="western" %) 150 -ListQuestions 151 - 152 -* 153 - 154 -(% class="western" %) 155 -ListSourceCodes 156 -))) 157 -1. **Attach** 158 - 159 -* 160 -** ((( 161 -(% class="western" %) 162 -Attach resource to product 163 -))) 164 - 165 -(% class="western" %) 166 - 167 - 168 -(% class="western" %) 169 169 **Accessing API** 170 170 171 171 (% class="western" %) ... ... @@ -202,7 +202,7 @@ 202 202 203 203 204 204 (% class="western" %) 205 -**API Usage** 97 +**General API Usage** 206 206 207 207 (% class="western" %) 208 208 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. ... ... @@ -344,45 +344,15 @@ 344 344 ** 345 345 ** 346 346 347 -(% class="western" %) 348 -**Resources** 239 + 349 349 350 350 (% class="western" %) 351 -R esources are the available entities that can be accessed/modified via API.Eachresourcecan be created, updated or requested by using the corresponding http method described above.242 +**RESOURCE: Questions** 352 352 353 -* ((( 354 354 (% class="western" %) 355 -questions 356 -))) 357 -* ((( 358 -(% class="western" %) 359 -users 360 -))) 361 -* ((( 362 -(% class="western" %) 363 -products 364 -))) 365 -* ((( 366 -(% class="western" %) 367 -terms 368 -))) 369 -* ((( 370 -(% class="western" %) 371 -resources 372 -))) 373 -* ((( 374 -(% class="western" %) 375 -sources 376 -))) 377 -* ((( 378 -(% class="western" %) 379 -transactions 380 -))) 245 +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). 381 381 382 382 (% class="western" %) 383 -**Questions** 384 - 385 -(% class="western" %) 386 386 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. 387 387 388 388 (% class="western" %) ... ... @@ -727,7 +727,7 @@ 727 727 728 728 (% class="western" %) 729 729 730 -**Users** 592 +**RESOURCE: Users** 731 731 732 732 (% class="western" %) 733 733 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. ... ... @@ -1803,9 +1803,41 @@ 1803 1803 1804 1804 1805 1805 (% class="western" %) 1806 - 1668 +**Resources** 1807 1807 1808 1808 (% class="western" %) 1671 +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. 1672 + 1673 +* ((( 1674 +(% class="western" %) 1675 +questions 1676 +))) 1677 +* ((( 1678 +(% class="western" %) 1679 +users 1680 +))) 1681 +* ((( 1682 +(% class="western" %) 1683 +products 1684 +))) 1685 +* ((( 1686 +(% class="western" %) 1687 +terms 1688 +))) 1689 +* ((( 1690 +(% class="western" %) 1691 +resources 1692 +))) 1693 +* ((( 1694 +(% class="western" %) 1695 +sources 1696 +))) 1697 +* ((( 1698 +(% class="western" %) 1699 +transactions 1700 +))) 1701 + 1702 +(% class="western" %) 1809 1809 1810 1810 1811 1811 (% class="western" %)
- Confluence.Code.ConfluencePageClass[0]
-
- id
-
... ... @@ -1,1 +1,1 @@ 1 -353900 71 +3539009 - url
-
... ... @@ -1,1 +1,1 @@ 1 -https://info.onecount.net//wiki/spaces/OD/pages/353900 7/ONEcount API Documentation1 +https://info.onecount.net//wiki/spaces/OD/pages/3539009/ONEcount API Documentation