Changes for page OLD-ONEcount API Documentation

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

From 3.1 to 4.1 From 11.1 to 12.1

From version 4.1

edited by sonish
on 2017/04/03 16:45

Change comment: There is no comment for this version

To version 11.1

edited by omar
on 2017/04/13 11:59

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Title

@@ -1,1 +1,1 @@
--OC-API-04032017
++ONEcount API Documentation

Author

@@ -1,1 +1,1 @@
--XWiki.sonish
++XWiki.omar

Content

@@ -1,56 +49,8 @@
--(% class="western" align="center" %)
--
--
--(% class="western" align="center" %)
--
--
--(% class="western" align="center" %)
--
--
--(% class="western" align="center" %)
--
--
--(% class="western" align="center" %)
--
--
--(% class="western" align="center" %)
--
--
--(% class="western" align="center" %)
--ONEcount REST API Developer's Guide
--
--(% class="western" align="center" %)
--Version 2.1
--
--(% class="western" align="center" %)
--
--
--(% class="western" align="center" %)
--
--
--(% class="western" align="center" %)
--
--
--(% class="western" align="center" %)
--
--
--(% class="western" align="center" %)
--
--
--(% class="western" align="center" %)
--
--
--(% class="western" align="center" %)
--
--
--(% class="western" align="center" %)
--
--
  (% class="western" %)
  **Introduction**
  (% class="western" %)
--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.
++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:
@@ -58,14 +58,11 @@
 . (((
  (% class="western" %)
  **GET** - Used for lookup of resources
--
--* (((
++)))
 . (((
  (% class="western" %)
  **PUT** - Used to update a resource
  )))
--)))
--)))
 . (((
  (% class="western" %)
  **POST** - Used to create a new resource
@@ -72,178 +72,55 @@
  )))
  (% class="western" %)
--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
++**Accessing API**
--*
--
  (% class="western" %)
--Transaction lookup
++**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect"]]
--*
--
  (% class="western" %)
--Question lookup
++**Appkey**: THIS WILL BE PROVIDED TO YOU
--*
--
  (% 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
--)))
--
--(% class="western" %)
--
--
--1. (((
--(% class="western" %)
--**Attach**
--)))
--
--* (((
--(% class="western" %)
--Attach resource to product
--)))
--
--(% class="western" %)
--
--
--(% class="western" %)
--
--
--(% class="western" %)
--**REST API URL**: [[https:~~/~~/api.onecount.net/v2/>>url:https://api.onecount.net/v2/||shape="rect" class="western"]]
--
--(% class="western" %)
--**Appkey**: THIS WILL BE PROVIDED
--
--(% class="western" %)
--
--
--(% class="western" %)
--**Function**
--
--(% class="western" %)
--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.
--
--(% class="western" %)
--**Accessing API**
--
--(% class="western" %)
  Your HTTP requests to a REST API resource should contain the following information:
  * (((
@@ -264,9 +264,12 @@
  )))
  (% class="western" %)
--**Request**
++
  (% class="western" %)
++**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.
  (% class="western" %)
@@ -395,133 +395,100 @@
  (% class="western" %)
--**Resources**
++**
++**
++**COMPONENT: Users**
++
  (% 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.
++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" %)
--questions
--)))
--* (((
--(% class="western" %)
--users
--)))
--* (((
--(% class="western" %)
--products
--)))
--* (((
--(% class="western" %)
--terms
--)))
--* (((
--(% class="western" %)
--resources
--)))
--* (((
--(% class="western" %)
--sources
--)))
--* (((
--(% class="western" %)
--transactions
--)))
++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" %)
--**Questions**
++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" %)
--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.
++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" %)
--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)
++Return parameter will have the comma separated list of question Ids that is requested back from the API.
  (% class="western" %)
--There can be 6 types of questions:
++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="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" %)
@@ -528,10 +528,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" %)
@@ -538,32 +538,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" %)
  |(((
@@ -584,18 +584,19 @@
  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)
--
--(% class="western" %)
--Type: Look up the question type.
++return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String)
  )))
++
++
++
++
  (% class="wrapped" %)
  |(((
  (% class="western" %)
@@ -609,19 +609,19 @@
  )))
  |(((
  (% 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.
  )))
  (% 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" %)
  |(((
@@ -636,46 +636,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**
@@ -685,19 +685,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**
@@ -707,168 +707,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" %)
@@ -875,10 +875,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" %)
@@ -885,40 +885,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" %)
  |(((
@@ -939,19 +939,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" %)
@@ -965,19 +965,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" %)
  |(((
@@ -992,49 +992,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**
@@ -1044,24 +1044,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**
@@ -1071,72 +1071,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" %)
@@ -1305,7 +1305,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" %)
@@ -1363,7 +1363,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" %)
@@ -1391,7 +1391,7 @@
  (% class="western" %)
--**Terms**
++**COMPONENT: Terms**
  (% class="western" %)
  This resource is for manipulating terms resource. A term can be created, updated or searched.
@@ -1622,9 +1622,45 @@
  (% 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" %)
@@ -1682,7 +1682,7 @@
  (% class="western" %)
--**GET method should be used to lookup products.**
++**GET method should be used to lookup resources.**
  (% class="wrapped" %)
  |(((
@@ -1737,7 +1737,7 @@
  (% class="western" %)
--**POST method should be used to create products.**
++**POST method should be used to create resources.**
  (% class="wrapped" %)
  |(((
@@ -1768,6 +1768,9 @@
  (% class="western" %)
  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
++
++(% class="western" %)
++{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"]}
  )))
  (% class="wrapped" %)
@@ -1826,6 +1826,9 @@
  (% class="western" %)
  {"Name":"Test123","Description":Testss","Type":3,"Value":”/digital/”}
++
++(% class="western" %)
++{"Name":"Test123","Description":Testss","Type":3,"Value":[”/digital/”, "/article/"]}
  )))
  (% class="wrapped" %)
@@ -1852,7 +1852,6 @@
--(% class="western" %)
  (% class="western" %)
@@ -1859,10 +1859,11 @@
  (% 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" %)
  |(((
@@ -2078,7 +2078,7 @@
  (% class="western" %)
--**Transactions**
++**COMPONENT: Transactions**
  (% class="western" %)
  This resource is for manipulating transactions resource. A transaction can be created or searched.
@@ -2244,8 +2244,11 @@
++
++
  (% 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.
@@ -2266,7 +2266,8 @@
  (% class="western" %)
--**Telemarketing**
++**Telemarketing Leads
++**
  (% class="western" %)
@@ -2417,8 +2417,16 @@
++
++
++
++
++
++
++
++
  (% class="western" %)
--**Reference**
++**API REFERENCE**
  (% class="western" %)
  **Type: Questions**
@@ -3097,14 +3097,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.
  )))
  |(((

Confluence.Code.ConfluencePageClass[0]

id

@@ -1,1 +1,1 @@
--3539005
++3539019

url

@@ -1,1 +1,1 @@
--https://info.onecount.net//wiki/spaces/OD/pages/3539005/OC-API-04032017
++https://info.onecount.net//wiki/spaces/OD/pages/3539019/ONEcount API Documentation