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