Changes for page OLD-ONEcount API Documentation

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

From 6.1 to 7.1 From 16.1 to 17.1

From version 7.1

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

Change comment: There is no comment for this version

To version 16.1

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

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. This API can be used to lookup, create and updated different ONEcount data components 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" %)
@@ -90,7 +90,7 @@
  )))
  (% class="western" %)
--
++\\
  (% class="western" %)
  **General API Usage**
@@ -102,7 +102,7 @@
  For lookup, the parameter list will be part of the request url.
  (% class="western" %)
--
++\\
  (% class="western" %)
  **Response**
@@ -165,7 +165,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.
@@ -221,7 +221,7 @@
              ]}]}}}}
  (% class="western" %)
--
++\\
  (% class="western" %)
  **
@@ -247,8 +247,9 @@
  (% 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="wrapped" %)
  |(((
  (% class="western" %)
  **Method**
@@ -363,11 +363,12 @@
  **OUTPUT** : Should get ocid of the user if it finds it otherwise get and error with msg user not found.
  )))
--
++\\
  (% class="western" %)
  **GET method should be used to lookup users.**
++(% class="wrapped" %)
  |(((
  (% class="western" %)
  **Request**
@@ -393,12 +393,16 @@
  (% class="western" %)
  return: csv of question id that is requested back. The Users object returned will only have these properties plus UserId (String)
++
++(% class="western" %)
++If return is not provided, all the demographics will be returned.
  )))
--
++\\
--
++\\
++(% class="wrapped" %)
  |(((
  (% class="western" %)
  **Response**
@@ -420,11 +420,35 @@
  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(%%)**
++
++(% class="relative-table" 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="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 users.**
++(% class="wrapped" %)
  |(((
  (% class="western" %)
  **Request**
@@ -476,6 +476,7 @@
  CSV of ONEcount QuestionId's requested back in Users object in response.
  )))
++(% class="wrapped" %)
  |(((
  (% class="western" %)
  **Response**
@@ -497,11 +497,12 @@
  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" %)
  **Request**
@@ -543,6 +543,7 @@
  RequestDate to use for the demo update. If not provided current date will be used.
  )))
++(% class="wrapped" %)
  |(((
  (% class="western" %)
  **Response**
@@ -565,10 +565,10 @@
  )))
  (% class="western" %)
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
  Create new users. Here in this example the JSON for request is passed in userFile.json file.
@@ -583,7 +583,7 @@
  **
  **
--
++\\
  (% class="western" %)
  **COMPONENT: Questions**
@@ -719,7 +719,7 @@
  JSON of the Questions type object needs to be sent as post data. Id field is mandatory for update.
  )))
--
++\\
  (% class="western" %)
  **GET method can be used to lookup questions.**
@@ -777,7 +777,7 @@
  Returns found question details.
  )))
--
++\\
  (% 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).**
@@ -826,7 +826,7 @@
  Returns ONEcount question id on successful creation of the question.
  )))
--
++\\
  (% class="western" %)
  PUT method should be used to update question.
@@ -876,7 +876,7 @@
  )))
  (% class="western" %)
--
++\\
  (% class="western" %)
  Example: Get list of questions from api which has FirstName in text
@@ -1024,7 +1024,7 @@
  {"ProductID":"65","ResourceID":”121"}
  )))
--
++\\
  (% class="western" %)
  **GET method should be used to lookup products.**
@@ -1079,7 +1079,7 @@
  Returns found product details.
  )))
--
++\\
  (% class="western" %)
  **POST method should be used to create products.**
@@ -1109,7 +1109,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" %)
@@ -1134,7 +1134,7 @@
  Product Id of the newly created product.
  )))
--
++\\
  (% class="western" %)
  PUT method should be used to update an individual product given the product info.
@@ -1167,7 +1167,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" %)
@@ -1192,7 +1192,7 @@
  Product id of the updated product.
  )))
--
++\\
  (% class="western" %)
  **COMPONENT: Terms**
@@ -1252,7 +1252,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.**
@@ -1307,7 +1307,7 @@
  Returns found term details.
  )))
--
++\\
  (% class="western" %)
  **POST method should be used to create products.**
@@ -1365,7 +1365,7 @@
  Term Id of the newly created term.
  )))
--
++\\
  (% class="western" %)
  PUT method should be used to update an individual term given the term info.
@@ -1392,7 +1392,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**:
@@ -1423,7 +1423,7 @@
  term id of the updated term.
  )))
--
++\\
  (% class="western" %)
  **COMPONENT: Resources**
@@ -1519,7 +1519,7 @@
  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 resources.**
@@ -1574,7 +1574,7 @@
  Returns found resource details.
  )))
--
++\\
  (% class="western" %)
  **POST method should be used to create resources.**
@@ -1601,7 +1601,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**:
@@ -1608,6 +1608,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" %)
@@ -1632,7 +1632,7 @@
  Resource Id of the newly created resource.
  )))
--
++\\
  (% class="western" %)
  PUT method should be used to update an individual resource given the resource info.
@@ -1656,16 +1656,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" %)
@@ -1690,12 +1690,12 @@
  resource id of the updated resource.
  )))
--
++\\
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
  **COMPONENT: Source Codes
@@ -1756,7 +1756,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.**
@@ -1811,10 +1811,10 @@
  Returns found source details.
  )))
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
  POST method should be used to create an individual source given the source parameters.
@@ -1863,7 +1863,7 @@
  Returns created source code id.
  )))
--
++\\
  (% class="western" %)
  **PUT method can be used to update an individual source given the id.**
@@ -1912,10 +1912,10 @@
  Returns updated source id.
  )))
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
  **COMPONENT: Transactions**
@@ -1965,10 +1965,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.
@@ -2007,11 +2007,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**
@@ -2030,11 +2030,22 @@
  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="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.
@@ -2082,9 +2082,9 @@
  Returns transactionId of the newly created transaction.
  )))
--
++\\
--
++\\
  (% class="western" %)
  **COMPONENT: Leads
@@ -2094,19 +2094,19 @@
  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 Leads
@@ -2158,7 +2158,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.
@@ -2228,13 +2228,13 @@
  )))
  |(((
  (% class="western" %)
--
++\\
  )))|(((
  (% class="western" %)
--
++\\
  )))|(((
  (% class="western" %)
--
++\\
  )))
  (% class="wrapped" %)
@@ -2259,15 +2259,15 @@
  Returns telemarketing ids of the newly created transaction. If multiple stats are sent, multiple ids are returned in cvs format.
  )))
--
++\\
--
++\\
--
++\\
--
++\\
--
++\\
  (% class="western" %)
  **API REFERENCE**
@@ -2316,12 +2316,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" %)
@@ -2344,13 +2344,13 @@
  Alias for admin purpose.
  )))
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
  **Type: Choices**
@@ -2417,7 +2417,7 @@
  Tied to which question id.
  )))
--
++\\
  (% class="western" %)
  **Type: Users**
@@ -2474,7 +2474,7 @@
  Request date.
  )))
--
++\\
  (% class="western" %)
  **Type: Demo**
@@ -2521,7 +2521,7 @@
  ...
  )))
--
++\\
  (% class="western" %)
  **Type: Transactions**
@@ -2668,7 +2668,7 @@
  If there is amount (USD) included in transaction.
  )))
--
++\\
  (% class="western" %)
  **Type: Sources**
@@ -2725,10 +2725,10 @@
  If this is a child source then list the parent source id.
  )))
--
++\\
  (% class="western" %)
--
++\\
  (% class="western" %)
  **Type: Products**
@@ -2785,7 +2785,7 @@
  (Array of) Terms associated with the product.
  )))
--
++\\
  (% class="western" %)
  **Type: Terms**
@@ -2872,7 +2872,7 @@
  If there is price (USD) for the term.
  )))
--
++\\
  (% class="western" %)
  **Type: Resources**
@@ -2949,14 +2949,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.
  )))
  |(((
@@ -2967,10 +2967,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**
@@ -3060,8 +3060,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 @@
--3539010
++23331813

url

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