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