Changes for page OLD-ONEcount API Documentation

Last modified by Admin on 2025/06/27 12:14

From 4.1 to 5.1 From 17.1 to 18.1

From version 5.1

edited by Admin
on 2017/04/05 10:32

Change comment: There is no comment for this version

To version 17.1

edited by shravya@one-count_com
on 2020/02/26 12:41

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Author

@@ -1,1 +1,1 @@
--XWiki.Admin
++XWiki.shravya@one-count_com

Content

@@ -2,7 +2,7 @@
  **Introduction**
  (% class="western" %)
--ONEcount REST API is designed to allow you to directly manipulate the underlying data within the ONEcount application. his API can be used to lookup, create and updated different ONEcount resources which are listed below.
++ONEcount REST API is designed to allow you to directly manipulate the underlying data within the ONEcount application. This API can be used to lookup, create and update different ONEcount data components which are listed below.
  (% class="western" %)
  REST takes advantage of the HTTP request methods to layer itself into the existing HTTP architecture. These operations consist of the following:
@@ -9,7 +9,7 @@
 . (((
  (% class="western" %)
--**GET** - Used for lookup of resources
++**GET** - Used for lookup of resourcesresources
  )))
 . (((
  (% class="western" %)
@@ -21,151 +21,42 @@
  )))
  (% class="western" %)
--Specifically, the ONEcount API provides following functionalities:
++Specifically, the ONEcount API provides to the following components:
--1. (((
--(% class="western" %)
--**Lookup**
++1. User data
++11. List users
++11. Lookup users
++11. Create users
++11. Update users
++1. Questions
++11. Lookup questions
++11. List questions
++11. Create questions
++1. Product data
++11. Lookup products
++11. Create products
++11. Update products
++1. Term Data
++11. Lookup terms
++11. Create terms
++11. Update terms
++1. Resource Data
++11. Lookup resources
++11. Create resources
++11. Update resources
++1. Transaction data
++11. Lookup transactions
++11. Create transactions
++1. Source Codes
++11. Lookup source code
++11. Create source codes
++11. Update source codes
++1. Attach a resource to a product
++1. Leads
++11. Create a lead
++\\\\\\
--*
--
  (% class="western" %)
--User lookup
--
--*
--
--(% class="western" %)
--Transaction lookup
--
--*
--
--(% class="western" %)
--Question lookup
--
--*
--
--(% class="western" %)
--Source code lookup
--
--*
--
--(% class="western" %)
--Product lookup
--
--*
--
--(% class="western" %)
--Term lookup
--
--*
--
--(% class="western" %)
--Resource lookup
--)))
--1. (((
--(% class="western" %)
--**Create**
--
--*
--
--(% class="western" %)
--Add a user/demo
--
--*
--
--(% class="western" %)
--Add a question
--
--*
--
--(% class="western" %)
--Add user transaction
--
--*
--
--(% class="western" %)
--Add source code
--
--*
--
--(% class="western" %)
--Add Product
--
--*
--
--(% class="western" %)
--Add Term
--
--*
--
--(% class="western" %)
--Add Resource
--
--*
--
--(% class="western" %)
--Stats – Telemarketing
--)))
--1. (((
--(% class="western" %)
--**Update**
--
--*
--
--(% class="western" %)
--Update a user/demo
--
--*
--
--(% class="western" %)
--Update a question
--
--*
--
--(% class="western" %)
--Update source code
--
--*
--
--(% class="western" %)
--Update product
--
--*
--
--(% class="western" %)
--Update term
--
--*
--
--(% class="western" %)
--Update resource
--)))
--1. (((
--(% class="western" %)
--**List**
--
--*
--
--(% class="western" %)
--ListQuestions
--
--*
--
--(% class="western" %)
--ListSourceCodes
--)))
--1. **Attach**
--
--*
--** (((
--(% class="western" %)
--Attach resource to product
--)))
--
--(% class="western" %)
--
--
--(% class="western" %)
  **Accessing API**
  (% class="western" %)
@@ -199,10 +199,10 @@
  )))
  (% class="western" %)
--
++\\
  (% class="western" %)
--**API Usage**
++**General API Usage**
  (% class="western" %)
  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.
@@ -211,7 +211,7 @@
  For lookup, the parameter list will be part of the request url.
  (% class="western" %)
--
++\\
  (% class="western" %)
  **Response**
@@ -274,7 +274,7 @@
  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.
  (% class="western" %)
--
++\\
  (% class="western" %)
  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.
@@ -330,148 +330,103 @@
              ]}]}}}}
  (% class="western" %)
--
++\\
  (% class="western" %)
  **
  **
--(% class="western" %)
--**
--**
++**COMPONENT: Users**
  (% class="western" %)
--**
--**
++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.
  (% class="western" %)
--**Resources**
++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.
  (% class="western" %)
--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.
++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.
--* (((
  (% class="western" %)
--questions
--)))
--* (((
--(% class="western" %)
--users
--)))
--* (((
--(% class="western" %)
--products
--)))
--* (((
--(% class="western" %)
--terms
--)))
--* (((
--(% class="western" %)
--resources
--)))
--* (((
--(% class="western" %)
--sources
--)))
--* (((
--(% class="western" %)
--transactions
--)))
++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.
  (% class="western" %)
--**Questions**
++Return parameter will have the comma separated list of question Ids that is requested back from the API.
  (% class="western" %)
--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.
++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.
--(% class="western" %)
--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)
++\\
--(% class="western" %)
--There can be 6 types of questions:
--
  (% class="wrapped" %)
  |(((
--(% class="western" align="center" %)
--**Type**
--)))|(((
  (% class="western" %)
--**Description**
--)))
--|(((
--(% class="western" align="center" %)
--1
++**Method**
  )))|(((
  (% class="western" %)
--Textbox type questions or short response type question. The response length needs to be less than 255 characters.
--)))
--|(((
--(% class="western" align="center" %)
--2
++**Url**
  )))|(((
  (% class="western" %)
--Textarea type question or long response type question.
++**Action**
  )))
  |(((
--(% class="western" align="center" %)
--3
++(% class="western" %)
++GET
  )))|(((
  (% class="western" %)
--Password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *.
--)))
--|(((
--(% class="western" align="center" %)
--4
++/users
  )))|(((
  (% class="western" %)
--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.
++Get users data limiting 25.
  )))
  |(((
--(% class="western" align="center" %)
--5
++(% class="western" %)
++GET
  )))|(((
  (% class="western" %)
--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.
--)))
--|(((
--(% class="western" align="center" %)
--6
++/users/1
  )))|(((
  (% class="western" %)
--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.
++Get data for user id 1. The user id can be a numeric value or a hash
  )))
--
--(% class="wrapped" %)
  |(((
  (% class="western" %)
--**Method**
++GET
  )))|(((
  (% class="western" %)
--**Url**
++/users/lookup?1=user1@[[email.com>>url:http://email.com||shape="rect"]]&return=1,2
  )))|(((
  (% class="western" %)
--**Action**
++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.
++
++(% class="western" %)
++Return parameter defines a csv of question id that are requested back in response.
  )))
  |(((
  (% class="western" %)
--GET
++POST
  )))|(((
  (% class="western" %)
--/questions
++/users
  )))|(((
  (% class="western" %)
--List all questions
++Create a new users
++
++(% class="western" %)
++Parameters required to create the user needs to be sent as post data in JSON format.
  )))
  |(((
  (% class="western" %)
--GET
++PUT
  )))|(((
  (% class="western" %)
--/questions/1
++/users/1
  )))|(((
  (% class="western" %)
--Returns question id 1
++Update user id 1. The user id can be a numeric value or a hash
++
++(% class="western" %)
++Parameters required to update the user needs to be sent as post data in JSON format.
  )))
  |(((
  (% class="western" %)
@@ -478,10 +478,10 @@
  GET
  )))|(((
  (% class="western" %)
--/questions/lookup?Text=Email
++/users/1/partners/2
  )))|(((
  (% class="western" %)
--Returns all questions with “Email" in question text
++Get user id 1 and partner id 2's ONEcount hash. The user id can be a numeric value or a hash.
  )))
  |(((
  (% class="western" %)
@@ -488,32 +488,40 @@
  POST
  )))|(((
  (% class="western" %)
--/questions
++/users/login
  )))|(((
  (% class="western" %)
--Create a new question
++Check to see user exist with username/email and password.
  (% class="western" %)
--JSON of the Questions type object needs to be sent as post data. Id field should not be sent.
--)))
--|(((
++Parameters required to create JSON object with **u** as username, **e** as email and **p** as password and sent is as POST param.
++
  (% class="western" %)
--PUT
--)))|(((
++Example:
++
  (% class="western" %)
--/questions
--)))|(((
++{"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"}
++
  (% class="western" %)
--Update a question
++OR
  (% class="western" %)
--JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
++{"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
++
++(% class="western" %)
++OR
++
++(% class="western" %)
++{"e":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
++
++(% class="western" %)
++**OUTPUT** : Should get ocid of the user if it finds it otherwise get and error with msg user not found.
  )))
--
++\\
  (% class="western" %)
--**GET method can be used to lookup questions.**
++**GET method should be used to lookup users.**
  (% class="wrapped" %)
  |(((
@@ -534,18 +534,22 @@
  String
  )))|(((
  (% class="western" %)
--URL encoded key value string parameters for the question that a user is trying to search.
++URL encoded key value string parameters for the lookup. Return property has csv of questions id requested back in Users object.
  (% class="western" %)
--Params:
++Params: Value of question Ids: Key value for Lookup question ids for e.g. 1=user1@[[email.com>>url:http://email.com||shape="rect"]]
  (% class="western" %)
--Text: Word or phrase that should be present in the question text (String)
++return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String)
  (% class="western" %)
--Type: Look up the question type.
++If return is not provided, all the demographics will be returned.
  )))
++\\
++
++\\
++
  (% class="wrapped" %)
  |(((
  (% class="western" %)
@@ -559,19 +559,45 @@
  )))
  |(((
  (% class="western" %)
--Questions
++Users
++)))|=(((
++(% class="western" align="left" %)
++Users
  )))|(((
  (% class="western" %)
--Questions
--)))|(((
--(% class="western" %)
--Returns found question details.
++Found users returned with the demo field requested in return parameter in json format
  )))
--
++\\
++**Sample response for /users/(% style="color: rgb(80,80,80);" %)25255449(%%)**
++
++Along with the demo in json format, the active packages and products of the user referred to as products and resources respectively are also returned.
++
++(% class="relative-table wrapped" style="width: 100.0%;" %)
++|=(((
++(% class="content-wrapper" %)
++(((
++[[image:attach:Screen Shot 2020-02-26 at 11.15.52 AM.png||width="1407"]]
++)))
++)))
++
++\\
++
++**Sample response for /users/lookup?(% style="color: rgb(80,80,80);" %)11=santosh@[[one-count.com>>url:http://one-count.com||shape="rect"]]&return=2,3(%%)**
++
++(% class="wrapped" %)
++|=(((
++(% class="content-wrapper" %)
++(((
++[[image:attach:Screen Shot 2020-02-26 at 11.22.13 AM.png||height="250"]]
++)))
++)))
++
++\\
++
  (% class="western" %)
--**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).**
++**POST method should be used to create users.**
  (% class="wrapped" %)
  |(((
@@ -586,46 +586,49 @@
  )))
  |(((
  (% class="western" %)
--Questions
++Users
  )))|(((
  (% class="western" %)
--Questions
++Users
  )))|(((
  (% class="western" %)
--This defines the question contents and possible responses.
++Users object that contains information about user to create. PartnerId Needs to be specified.
  )))
--
--(% class="wrapped" %)
  |(((
  (% class="western" %)
--**Response**
++Transactions
  )))|(((
  (% class="western" %)
--**Type**
++Transactions
  )))|(((
  (% class="western" %)
--**Description**
++(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.
  )))
  |(((
  (% class="western" %)
--QuestionId
++DedupeColumns
  )))|(((
  (% class="western" %)
--Int
++String
  )))|(((
  (% class="western" %)
--Returns ONEcount question id on successful creation of the question.
++CSV of question id's that should be considered to find duplicate.
  )))
--
--
--
++|(((
  (% class="western" %)
--PUT method should be used to update question.
++Return
++)))|(((
++(% class="western" %)
++String
++)))|(((
++(% class="western" %)
++CSV of ONEcount QuestionId's requested back in Users object in response.
++)))
  (% class="wrapped" %)
  |(((
  (% class="western" %)
--**Request**
++**Response**
  )))|(((
  (% class="western" %)
  **Type**
@@ -635,19 +635,24 @@
  )))
  |(((
  (% class="western" %)
--Questions
++Users
++)))|=(((
++(% class="western" align="left" %)
++Users
  )))|(((
  (% class="western" %)
--Questions
--)))|(((
--(% class="western" %)
--This defines the question contents and responses.
++Created users returned with the demo field requested in return parameter in json format. If return was not specified only UserId will be returned.
  )))
++\\
++
++(% class="western" %)
++**PUT method should be used to update users.**
++
  (% class="wrapped" %)
  |(((
  (% class="western" %)
--**Response**
++**Request**
  )))|(((
  (% class="western" %)
  **Type**
@@ -657,168 +657,174 @@
  )))
  |(((
  (% class="western" %)
--QuestionId
++Users
  )))|(((
  (% class="western" %)
--Int
++Users
  )))|(((
  (% class="western" %)
--Returns ONEcount question id on successful update of the question.
++Users object with update fields. Return property has csv of questions id requested back in Users object.
  )))
--
++|(((
  (% class="western" %)
--
--
++Return
++)))|(((
  (% class="western" %)
--Example: Get list of questions from api which has FirstName in text
--
--{{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions/lookup?Text=FirstName}}}
--
++String
++)))|(((
  (% class="western" %)
--{
--
++CSV of ONEcount QuestionId's requested back in Users object in response
++)))
++|(((
  (% class="western" %)
--"result": {
--
++RequestDate
++)))|(((
  (% class="western" %)
--"success": "1",
--
++Date
++)))|(((
  (% class="western" %)
--"error": {
++RequestDate to use for the demo update. If not provided current date will be used.
++)))
++(% class="wrapped" %)
++|(((
  (% class="western" %)
--"code": "0",
--
++**Response**
++)))|(((
  (% class="western" %)
--"message": ""
--
++**Type**
++)))|(((
  (% class="western" %)
--}
--
++**Description**
++)))
++|(((
  (% class="western" %)
--},
--
++Users
++)))|=(((
++(% class="western" align="left" %)
++Users
++)))|(((
  (% class="western" %)
--"Questions": [
++Updated user returned with the demo field requested in return parameter in json format.
++)))
  (% class="western" %)
--{
++\\
  (% class="western" %)
--"Id": "6",
++\\
  (% class="western" %)
--"Text": "FirstName",
++Create new users. Here in this example the JSON for request is passed in userFile.json file.
--(% class="western" %)
--"Type": "1",
++{{{curl -X POST -H “Appkey: xxx” -H "Content-Type: application/json" –data-binary -d '@userFile.json' https://api.onecount.net/v2/users}}}
  (% class="western" %)
--"Alias": "FName"
++**
++**
  (% class="western" %)
--}
++**
++**
--(% class="western" %)
--]
++\\
  (% class="western" %)
--}
++**COMPONENT: Questions**
  (% class="western" %)
++All data fields in ONEcount are made up of questions. Questions are configurable on a per-client basis, and no two customer installations will have the same question (ie., field) layout. Therefore, before querying or updating any ONEcount installation, you'll need to get an understanding of the question layout of the installation. This API segment will allow you to query ONEcount to determine the question layout for the installation. It will also allow you to create new questions within the system. This resource does not allow you to update the data for a specific user (see User section).
--**Users**
--
  (% class="western" %)
--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.
++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.
  (% class="western" %)
--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.
++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)
  (% class="western" %)
--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.
++There can be 6 types of questions:
--(% class="western" %)
--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.
--
--(% class="western" %)
--Return parameter will have the comma separated list of question Ids that is requested back from the API.
--
--(% class="western" %)
--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.
--
--(% class="western" %)
--
--
  (% class="wrapped" %)
  |(((
--(% class="western" %)
--**Method**
++(% class="western" align="center" %)
++**Type**
  )))|(((
  (% class="western" %)
--**Url**
++**Description**
++)))
++|(((
++(% class="western" align="center" %)
++1
  )))|(((
  (% class="western" %)
--**Action**
++Textbox type questions or short response type question. The response length needs to be less than 255 characters.
  )))
  |(((
--(% class="western" %)
--GET
++(% class="western" align="center" %)
++2
  )))|(((
  (% class="western" %)
--/users
++Textarea type question or long response type question.
++)))
++|(((
++(% class="western" align="center" %)
++3
  )))|(((
  (% class="western" %)
--Get users data limiting 25.
++Password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *.
  )))
  |(((
++(% class="western" align="center" %)
++4
++)))|(((
  (% class="western" %)
--GET
++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.
++)))
++|(((
++(% class="western" align="center" %)
++5
  )))|(((
  (% class="western" %)
--/users/1
++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.
++)))
++|(((
++(% class="western" align="center" %)
++6
  )))|(((
  (% class="western" %)
--Get data for user id 1. The user id can be a numeric value or a hash
++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.
  )))
++
++(% class="wrapped" %)
  |(((
  (% class="western" %)
--GET
++**Method**
  )))|(((
  (% class="western" %)
--/users/lookup?1=user1@[[email.com>>url:http://email.com||shape="rect"]]&return=1,2
++**Url**
  )))|(((
  (% class="western" %)
--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.
--
--(% class="western" %)
--Return parameter defines a csv of question id that are requested back in response.
++**Action**
  )))
  |(((
  (% class="western" %)
--POST
++GET
  )))|(((
  (% class="western" %)
--/users
++/questions
  )))|(((
  (% class="western" %)
--Create a new users
--
--(% class="western" %)
--Parameters required to create the user needs to be sent as post data in JSON format.
++List all questions
  )))
  |(((
  (% class="western" %)
--PUT
++GET
  )))|(((
  (% class="western" %)
--/users/1
++/questions/1
  )))|(((
  (% class="western" %)
--Update user id 1. The user id can be a numeric value or a hash
--
--(% class="western" %)
--Parameters required to update the user needs to be sent as post data in JSON format.
++Returns question id 1
  )))
  |(((
  (% class="western" %)
@@ -825,10 +825,10 @@
  GET
  )))|(((
  (% class="western" %)
--/users/1/partners/2
++/questions/lookup?Text=Email
  )))|(((
  (% class="western" %)
--Get user id 1 and partner id 2's ONEcount hash. The user id can be a numeric value or a hash.
++Returns all questions with “Email" in question text
  )))
  |(((
  (% class="western" %)
@@ -835,40 +835,32 @@
  POST
  )))|(((
  (% class="western" %)
--/users/login
++/questions
  )))|(((
  (% class="western" %)
--Check to see user exist with username/email and password.
++Create a new question
  (% class="western" %)
--Parameters required to create JSON object with **u** as username, **e** as email and **p** as password and sent is as POST param.
--
++JSON of the Questions type object needs to be sent as post data. Id field should not be sent.
++)))
++|(((
  (% class="western" %)
--Example:
--
++PUT
++)))|(((
  (% class="western" %)
--{"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"}
--
++/questions
++)))|(((
  (% class="western" %)
--OR
++Update a question
  (% class="western" %)
--{"u":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
--
--(% class="western" %)
--OR
--
--(% class="western" %)
--{"e":"[[abc@one-count.com>>mailto:abc@one-count.com||shape="rect" class="western"]]","p":"1234"}
--
--(% class="western" %)
--**OUTPUT** : Should get ocid of the user if it finds it otherwise get and error with msg user not found.
++JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
  )))
--
++\\
  (% class="western" %)
--**GET method should be used to lookup users.**
++**GET method can be used to lookup questions.**
  (% class="wrapped" %)
  |(((
@@ -889,19 +889,18 @@
  String
  )))|(((
  (% class="western" %)
--URL encoded key value string parameters for the lookup. Return property has csv of questions id requested back in Users object.
++URL encoded key value string parameters for the question that a user is trying to search.
  (% class="western" %)
--Params: Value of question Ids: Key value for Lookup question ids for e.g. 1=user1@[[email.com>>url:http://email.com||shape="rect"]]
++Params:
  (% class="western" %)
--return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String)
++Text: Word or phrase that should be present in the question text (String)
++
++(% class="western" %)
++Type: Look up the question type.
  )))
--
--
--
--
  (% class="wrapped" %)
  |(((
  (% class="western" %)
@@ -915,19 +915,19 @@
  )))
  |(((
  (% class="western" %)
--Users
--)))|=(((
--(% class="western" align="left" %)
--Users
++Questions
  )))|(((
  (% class="western" %)
--Found users returned with the demo field requested in return parameter in json format.
++Questions
++)))|(((
++(% class="western" %)
++Returns found question details.
  )))
--
++\\
  (% class="western" %)
--**POST method should be used to create users.**
++**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).**
  (% class="wrapped" %)
  |(((
@@ -942,49 +942,46 @@
  )))
  |(((
  (% class="western" %)
--Users
++Questions
  )))|(((
  (% class="western" %)
--Users
++Questions
  )))|(((
  (% class="western" %)
--Users object that contains information about user to create. PartnerId Needs to be specified.
++This defines the question contents and possible responses.
  )))
++
++(% class="wrapped" %)
  |(((
  (% class="western" %)
--Transactions
++**Response**
  )))|(((
  (% class="western" %)
--Transactions
++**Type**
  )))|(((
  (% class="western" %)
--(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.
++**Description**
  )))
  |(((
  (% class="western" %)
--DedupeColumns
++QuestionId
  )))|(((
  (% class="western" %)
--String
++Int
  )))|(((
  (% class="western" %)
--CSV of question id's that should be considered to find duplicate.
++Returns ONEcount question id on successful creation of the question.
  )))
--|(((
++
++\\
++
  (% class="western" %)
--Return
--)))|(((
--(% class="western" %)
--String
--)))|(((
--(% class="western" %)
--CSV of ONEcount QuestionId's requested back in Users object in response.
--)))
++PUT method should be used to update question.
  (% class="wrapped" %)
  |(((
  (% class="western" %)
--**Response**
++**Request**
  )))|(((
  (% class="western" %)
  **Type**
@@ -994,24 +994,19 @@
  )))
  |(((
  (% class="western" %)
--Users
--)))|=(((
--(% class="western" align="left" %)
--Users
++Questions
  )))|(((
  (% class="western" %)
--Created users returned with the demo field requested in return parameter in json format. If return was not specified only UserId will be returned.
++Questions
++)))|(((
++(% class="western" %)
++This defines the question contents and responses.
  )))
--
--
--(% class="western" %)
--**PUT method should be used to update users.**
--
  (% class="wrapped" %)
  |(((
  (% class="western" %)
--**Request**
++**Response**
  )))|(((
  (% class="western" %)
  **Type**
@@ -1021,72 +1021,81 @@
  )))
  |(((
  (% class="western" %)
--Users
++QuestionId
  )))|(((
  (% class="western" %)
--Users
++Int
  )))|(((
  (% class="western" %)
--Users object with update fields. Return property has csv of questions id requested back in Users object.
++Returns ONEcount question id on successful update of the question.
  )))
--|(((
++
  (% class="western" %)
--Return
--)))|(((
++\\
++
  (% class="western" %)
--String
--)))|(((
++Example: Get list of questions from api which has FirstName in text
++
++{{{curl -X GET -H “Appkey: xxx” https://api.onecount.net/v2/questions/lookup?Text=FirstName}}}
++
  (% class="western" %)
--CSV of ONEcount QuestionId's requested back in Users object in response
--)))
--|(((
++{
++
  (% class="western" %)
--RequestDate
--)))|(((
++"result": {
++
  (% class="western" %)
--Date
--)))|(((
++"success": "1",
++
  (% class="western" %)
--RequestDate to use for the demo update. If not provided current date will be used.
--)))
++"error": {
--(% class="wrapped" %)
--|(((
  (% class="western" %)
--**Response**
--)))|(((
++"code": "0",
++
  (% class="western" %)
--**Type**
--)))|(((
++"message": ""
++
  (% class="western" %)
--**Description**
--)))
--|(((
++}
++
  (% class="western" %)
--Users
--)))|=(((
--(% class="western" align="left" %)
--Users
--)))|(((
++},
++
  (% class="western" %)
--Updated user returned with the demo field requested in return parameter in json format.
--)))
++"Questions": [
  (% class="western" %)
--
++{
  (% class="western" %)
--
++"Id": "6",
  (% class="western" %)
--Create new users. Here in this example the JSON for request is passed in userFile.json file.
++"Text": "FirstName",
--{{{curl -X POST -H “Appkey: xxx” -H "Content-Type: application/json" –data-binary -d '@userFile.json' https://api.onecount.net/v2/users}}}
++(% class="western" %)
++"Type": "1",
  (% class="western" %)
--**Products**
++"Alias": "FName"
  (% class="western" %)
++}
++
++(% class="western" %)
++]
++
++(% class="western" %)
++}
++
++(% class="western" %)
++\\
++
++(% class="western" %)
++**COMPONENT: Products**
++
++(% class="western" %)
  This resource is for manipulating products resource. A product can be created, updated or searched.
  (% class="wrapped" %)
@@ -1170,7 +1170,7 @@
  {"ProductID":"65","ResourceID":”121"}
  )))
--
++\\
  (% class="western" %)
  **GET method should be used to lookup products.**
@@ -1225,7 +1225,7 @@
  Returns found product details.
  )))
--
++\\
  (% class="western" %)
  **POST method should be used to create products.**
@@ -1255,7 +1255,7 @@
  Example:
  (% class="western" %)
--{"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
++{"Title":"Test123","Description": "Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
  )))
  (% class="wrapped" %)
@@ -1280,7 +1280,7 @@
  Product Id of the newly created product.
  )))
--
++\\
  (% class="western" %)
  PUT method should be used to update an individual product given the product info.
@@ -1313,7 +1313,7 @@
  **Example**:
  (% class="western" %)
--{"Title":"Test123","Description":Testss","Terms":{"Name":"Product123"},"PrimaryFormId":10,"ResourceID":17}
++{"Title":"Test123","Description": "Testss","PrimaryFormId":10,"ResourceID":17}
  )))
  (% class="wrapped" %)
@@ -1338,10 +1338,10 @@
  Product id of the updated product.
  )))
--
++\\
  (% class="western" %)
--**Terms**
++**COMPONENT: Terms**
  (% class="western" %)
  This resource is for manipulating terms resource. A term can be created, updated or searched.
@@ -1398,7 +1398,7 @@
  JSON of the terms type object needs to be sent as post data. Id field is mandatory for update.
  )))
--
++\\
  (% class="western" %)
  **GET method should be used to lookup products.**
@@ -1453,7 +1453,7 @@
  Returns found term details.
  )))
--
++\\
  (% class="western" %)
  **POST method should be used to create products.**
@@ -1511,7 +1511,7 @@
  Term Id of the newly created term.
  )))
--
++\\
  (% class="western" %)
  PUT method should be used to update an individual term given the term info.
@@ -1538,7 +1538,7 @@
  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.
  (% class="western" %)
--
++\\
  (% class="western" %)
  **Example**:
@@ -1569,12 +1569,48 @@
  term id of the updated term.
  )))
--
++\\
  (% class="western" %)
--**Resources**
++**COMPONENT: Resources**
  (% class="western" %)
++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.
++
++* (((
++(% class="western" %)
++questions
++)))
++* (((
++(% class="western" %)
++users
++)))
++* (((
++(% class="western" %)
++products
++)))
++* (((
++(% class="western" %)
++terms
++)))
++* (((
++(% class="western" %)
++resources
++)))
++* (((
++(% class="western" %)
++sources
++)))
++* (((
++(% class="western" %)
++transactions
++)))
++
++(% class="western" %)
++**
++**
++
++(% class="western" %)
  This resource is for manipulating resources resource. A resource can be created, updated or searched.
  (% class="wrapped" %)
@@ -1629,10 +1629,10 @@
  JSON of the resources type object needs to be sent as post data. Id field is mandatory for update.
  )))
--
++\\
  (% class="western" %)
--**GET method should be used to lookup products.**
++**GET method should be used to lookup resources.**
  (% class="wrapped" %)
  |(((
@@ -1684,10 +1684,10 @@
  Returns found resource details.
  )))
--
++\\
  (% class="western" %)
--**POST method should be used to create products.**
++**POST method should be used to create resources.**
  (% class="wrapped" %)
  |(((
@@ -1711,7 +1711,7 @@
  resource details in json to be sent as post data. Id should not be set.
  (% class="western" %)
--**Possible Request Params**: Name, Description, Type, Value
++**Possible Request Params**: Name, Description, Type, Value, FreePass
  (% class="western" %)
  **Example**:
@@ -1718,6 +1718,15 @@
  (% class="western" %)
  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
++
++(% class="western" %)
++{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"]}
++
++(% class="western" %)
++{"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”, "FreePass":1}
++
++(% class="western" %)
++{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"],"FreePass":1}
  )))
  (% class="wrapped" %)
@@ -1742,7 +1742,7 @@
  Resource Id of the newly created resource.
  )))
--
++\\
  (% class="western" %)
  PUT method should be used to update an individual resource given the resource info.
@@ -1766,16 +1766,25 @@
  Resource
  )))|(((
  (% class="western" %)
--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.
++Resource details to be updated injsonformat to be sent withrequest. Id property needs to be set to identify the resource to be updated.
  (% class="western" %)
--
++\\
  (% class="western" %)
--Example:
++Examples:
  (% class="western" %)
  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
++
++(% class="western" %)
++{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"]}
++
++(% class="western" %)
++{"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”,"FreePass":1}
++
++(% class="western" %)
++{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"],"FreePass":1}
  )))
  (% class="wrapped" %)
@@ -1800,19 +1800,19 @@
  resource id of the updated resource.
  )))
--
++\\
--(% class="western" %)
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
--**Sources**
++**COMPONENT: Source Codes
++**
  (% class="western" %)
--This resource is for manipulating sources resource. A source can be created, updated or searched.
++This resource is for manipulating source code for a resource. A source code can be created, updated or searched.
  (% class="wrapped" %)
  |(((
@@ -1866,7 +1866,7 @@
  JSON of the Sources type object needs to be sent as post data. Id field is mandatory for update.
  )))
--
++\\
  (% class="western" %)
  **Sources can be looked up given the code or Id. GET method should be used for lookup.**
@@ -1921,10 +1921,10 @@
  Returns found source details.
  )))
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
  POST method should be used to create an individual source given the source parameters.
@@ -1973,7 +1973,7 @@
  Returns created source code id.
  )))
--
++\\
  (% class="western" %)
  **PUT method can be used to update an individual source given the id.**
@@ -2022,13 +2022,13 @@
  Returns updated source id.
  )))
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
--**Transactions**
++**COMPONENT: Transactions**
  (% class="western" %)
  This resource is for manipulating transactions resource. A transaction can be created or searched.
@@ -2075,10 +2075,10 @@
  JSON of the Transactions type object needs to be sent as post data. Id field should not be sent.
  )))
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
  Transactions can be looked up using transactionId, date range, userid. Use GET method to do lookup.
@@ -2117,11 +2117,7 @@
  EndDate: When the search should end. Only valid when UserId is set. (Date)
  )))
--
--
--
--
--(% class="wrapped" %)
++(% class="wrapped" style="letter-spacing: 0.0px;" %)
  |(((
  (% class="western" %)
  **Response**
@@ -2140,11 +2140,23 @@
  Transactions
  )))|(((
  (% class="western" %)
--Returns all transaction that satisfies the search criteria.
++Returns all transaction that satisfies the search criteria. Returns all the package and product transactions of the user. Package Transactions are the one with TermId and ProductId. Product Transactions are the one with ResourceId.
  )))
--
++\\
++**Sample response for /(% style="color: rgb(80,80,80);" %)transactions/lookup?UserId=25255105:(%%)**
++
++(% class="wrapped" %)
++|=(((
++(% class="content-wrapper" %)
++(((
++[[image:attach:Screen Shot 2020-02-26 at 11.14.29 AM.png||width="1407"]]
++)))
++)))
++
++\\
++
  (% class="western" %)
  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.
@@ -2192,39 +2192,35 @@
  Returns transactionId of the newly created transaction.
  )))
--
++\\
--
++\\
--
--
--
--
--
--
  (% class="western" %)
--**Stats**
++**COMPONENT: Leads
++**
  (% class="western" %)
  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.
  (% class="western" %)
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
--**Telemarketing**
++**Telemarketing Leads
++**
  (% class="western" %)
@@ -2272,7 +2272,7 @@
  JSON of the Telemarketing type object needs to be sent as post data. Id field should not be sent.
  )))
--
++\\
  (% class="western" %)
  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.
@@ -2342,13 +2342,13 @@
  )))
  |(((
  (% class="western" %)
--
++\\
  )))|(((
  (% class="western" %)
--
++\\
  )))|(((
  (% class="western" %)
--
++\\
  )))
  (% class="wrapped" %)
@@ -2373,18 +2373,18 @@
  Returns telemarketing ids of the newly created transaction. If multiple stats are sent, multiple ids are returned in cvs format.
  )))
--
++\\
--
++\\
--
++\\
--
++\\
--
++\\
  (% class="western" %)
--**Reference**
++**API REFERENCE**
  (% class="western" %)
  **Type: Questions**
@@ -2430,12 +2430,12 @@
  (% class="western" %)
  Determines which type of question it is. Textbox, checkbox, select, radio.
  There can be 6 types of questions.
-- type=1 means textbox type questions or short response type question. The response length needs to be less than 255 characters.
-- type=2 means textarea type question or long response type question.
-- type=3 means password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *
-- 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.
-- 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.
-- 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.
++type=1 means textbox type questions or short response type question. The response length needs to be less than 255 characters.
++type=2 means textarea type question or long response type question.
++type=3 means password type question. This is basically same as type 1 but when displayed in ONEcount frontend forms typed characters appears as *
++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.
++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.
++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.
  )))
  |(((
  (% class="western" %)
@@ -2458,13 +2458,13 @@
  Alias for admin purpose.
  )))
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
  **Type: Choices**
@@ -2531,7 +2531,7 @@
  Tied to which question id.
  )))
--
++\\
  (% class="western" %)
  **Type: Users**
@@ -2588,7 +2588,7 @@
  Request date.
  )))
--
++\\
  (% class="western" %)
  **Type: Demo**
@@ -2635,7 +2635,7 @@
  ...
  )))
--
++\\
  (% class="western" %)
  **Type: Transactions**
@@ -2782,7 +2782,7 @@
  If there is amount (USD) included in transaction.
  )))
--
++\\
  (% class="western" %)
  **Type: Sources**
@@ -2839,10 +2839,10 @@
  If this is a child source then list the parent source id.
  )))
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
  **Type: Products**
@@ -2899,7 +2899,7 @@
  (Array of) Terms associated with the product.
  )))
--
++\\
  (% class="western" %)
  **Type: Terms**
@@ -2986,7 +2986,7 @@
  If there is price (USD) for the term.
  )))
--
++\\
  (% class="western" %)
  **Type: Resources**
@@ -3063,14 +3063,30 @@
  )))|(((
  (% class="western" %)
  String
++
++(% class="western" %)
++or
++
++(% class="western" %)
++Array
  )))|(((
  (% class="western" %)
--Value of Resource Type.
++Value of Resource Type:
  (% class="western" %)
--Example : if the Type sent is 3 then Value would be **/digital/**
++When requesting a resource (GET), you should expect a string if there is only one value. If there are multiple values, you should expect an array.
  (% class="western" %)
++For creating/updating a resource (POST/PUT), it is highly recommended to send an array - this will handle single and multiple value requests.
++
++(% class="western" %)
++Example :
++
++(% class="western" %)
++if the Type sent is 3 with one value then Value would be "**/digital/**" or **["/digital"/].** We recommend using the second approach of **["/digital"/].** **
++**if the Type sent is 3 with two values then Value would be ["**/digital/**", "**/articles/**"]
++
++(% class="western" %)
  For Function type resource leave it blank.
  )))
  |(((
@@ -3081,10 +3081,20 @@
  Int
  )))|(((
  (% class="western" %)
--Default limit is 25 but all the data needs to be pulled then pass limit=0.
++Default limit is 25 but if all the data needs to be pulled then pass limit=0.
  )))
++|(% colspan="1" %)(% colspan="1" %)
++(((
++FreePass
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Int
++)))|(% colspan="1" %)(% colspan="1" %)
++(((
++Default value is 0. This parameter is used to provide access to protected content.
++)))
--
++\\
  (% class="western" %)
  **Type: Telemarketing**
@@ -3174,8 +3174,12 @@
  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.
  (% class="western" %)
--
++\\
  (% class="western" %)
  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.
  )))
++
++\\
++
++\\

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--3539007
++66715790

url

@@ -1,1 +1,1 @@
--https://info.onecount.net//wiki/spaces/OD/pages/3539007/ONEcount API Documentation
++https://info.onecount.net//wiki/spaces/OD/pages/66715790/ONEcount API Documentation