The Brightidea Application Programming Interface (API) allows you to access your data that was created using Brightidea On Demand Products. The API can be used for creating advanced reports to creating and updating user profiles.
Our API uses a method known as Representational State Transfer (REST). It is a simple protocol based on requesting data in the form of an HTTP request, and receiving the data back in an XML format.
Security
All sensitive information including your key is encrypted using SSL during transmission between your network and Brightidea’s. Access is protected through the use of a key we issue to you. Please contact your Account Services representative for a key.
Rate Limiting
To ensure good response time for all requests, API accounts will be limited to the amount of data they can access in a given request and hour. There is a limit on the number of rows returned from each List call and the number of calls which can be made per hour. An API call using the method bi.api.get will return the number for both of these limits. If you need to access more data from a List call than the maximum rows allowed per call from your account, be sure to use the SQL query and perform multiple calls to ensure all data is retrieved.
Encoding
All API calls will return data using UTF-8 encoding. Additionally, all user entered data (i.e. screen names, idea descriptions, etc..) will be wrapped in CDATA tags to ensure that no user entered data will disrupt the XML formatting.
Errors
If the API has encountered an error, it will return the error message in XML format. Here is an example of a possible error:
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111 Active 11/12/2008 9:21:47 AM 1000 300
Errors
Invalid or expired BI API key.
API call limit exceeded.
Permission denied.
bi.api.getAffiliateList
Description
Returns a list of existing affiliates accessible with your BI API Key.
HTTP Request Method: GET
Required Permission: bi.affiliate – Get
Arguments
none
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> OD111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Permission denied.
bi.api.getAPICallList
Description
Returns a list of API calls made from your BI API account.
HTTP Request Method: GET
Required Permission: bi.api – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> bi.api.get success 11/12/2008 9:21:47 AM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Permission denied.
Invalid SQL query.
bi.api.getPermissionList
Description
Returns a list of permissions available to your BI API account.
HTTP Request Method: GET
Required Permission: bi.api.permission – Get
Arguments
none
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> bi.api – Get
Errors
Invalid or expired BI API key.
API call limit exceeded.
Permission denied.
bi.affiliate.create
Description
Creates a new affiliate.
HTTP Request Method: POST
Required Permission: bi.affiliate – Create
Arguments
n (System Name): Required
This will be the name of the new affiliate.
e (Admin Email): Required
This will be the email of the Admin account for the affiliate.
sn (Admin Screen Name): Required
This will be the screen name of the Admin account for the affiliate.
p (Admin Password): Required
This will be the password of the Admin account for the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> OD111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Affiliate licenses exceeded.
Required data not supplied.
bi.affiliate.get
Description
Returns an existing affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate – Get
Arguments
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> OD111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
bi.affiliate.getBlogList
Description
Gets a list of existing blogs under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getBlogCommentList
Description
Get a list of existing blog comments under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog.comment – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111
11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getBlogTagList
Description
Get a list of exising blog tags under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog.tag – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 TestTag 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getCampaignList
Description
Returns a list of existing campaigns belonging to an affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM 11/12/2008 9:21:47 AM 1 This is a test campaign 11111111-1111-1111-1111-111111111111 Test User 11111111-1111-1111-1111-111111111111 Test User Private
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getCampaignStatusList
Description
Returns a list of campaign level statuses under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.status – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 Test Status
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getCategoryList
Description
Returns a list of existing categories under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.category – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Test Category 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getCommunityList
Description
Returns a list of immediate child communities belonging to an affiliate or parent community.
HTTP Request Method: GET
Required Permission: bi.affiliate.community – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
l (Level ID): Optional
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getIdeaList
Description
Gets a list of existing ideas under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 D101 11111111-1111-1111-1111-111111111111 3 11/12/2008 9:21:47 AM 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 False True
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getIdeaChipVoteList
Description
Get a list of exising idea chip votes under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.vote – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Get a list of existing idea comments under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.comment – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111
11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 True
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getIdeaTagList
Description
Get a list of exising idea tags under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.tag – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 TestTag 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getIdeaViewList
Description
Get a list of exising idea views under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.view – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Get a list of exising idea votes under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.vote – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Returns a list of member accounts belonging to an affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.member – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 OD111 testuser@brightidea.com
Yes 8/29/2008 12:05:29 PM 8/29/2008 12:05:29 PM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getMemberLoginList
Description
Returns a list of member logins under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.member.login – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getMemberTransactionList
Description
Returns a list of member transactions under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.member.transaction – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 PROMOTE_IDEA 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 3
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getProjectList
Description
Returns a list of projects under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.project – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Required Permission: bi.affiliate.projectStage – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Test Stage
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getProjectStatusList
Description
Returns a list of statuses for project.
HTTP Request Method: GET
Required Permission: bi.affiliate.projectStatus – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Test Status
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getStatusList
Description
Returns a list of affiliate level statuses under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.status – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Test Status
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getTworkList
Description
Returns a list of tworks under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.twork – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111
11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getBusinessUnitList
Description
Returns a list of business units under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.businessUnit – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 Name Type 11/12/2008 9:21:47 AM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getEvaluationFormList
Description
Returns a list of evaluation forms under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.evaluationForm – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Name
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getEvaluatorList
Description
Returns a list of evaluators under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.member – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 OD111 testuser@brightidea.com
Yes 8/29/2008 12:05:29 PM 8/29/2008 12:05:29 PM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getGroupList
Description
Returns a list of groups under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.group – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Name 11/12/2008 9:21:47 AM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getPoolList
Description
Returns a list of pools under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Title 10
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getProposalList
Description
Returns a list of proposals under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.proposal – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
filter (Filter): Optional
One of the following filter: “ALL”,”MINE”,”PART”.
m (Member ID): Optional
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 8/29/2008 12:05:29 PM User Name Test Status Test Custom Status 100 Field Title
Field Data
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getRandomIdeaList
Description
Returns a list of random ideas under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10).
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member. Only ideas from campaigns this member could access will be included.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 D101 3 11/12/2008 9:21:47 AM 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 False True
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.getFile.getFile
Description
Returns the attachment file by file ID.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea – Get
Arguments
file_id (File ID): Required
This is the ID (i.e. OD111) of the file.
thumb (Thumbnail size): Optional
This is the thumbnail size of the file (i.e. 50).
Example Response
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getProject2MilestoneList
Description
Returns a list of milestones of all projects under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.getProject2MilestoneList – Get
Arguments
a (Affiliate ID): Required
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 8/29/2008 8/29/2008 ![CDATA[Related To Do’s count goes here.]] ![CDATA[Total Related To Do’s count goes here.]]
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
bi.affiliate.project2.getTeamMemberList
Description
Returns a list of members of project using given project id.
HTTP Request Method: GET
Required Permission: bi.affiliate.project2.members – Get
Arguments
p (Project ID): Required
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 ![CDATA[member’s email id goes here]] ![CDATA[Member’s screen name goes here.]] ![CDATA[Member’s first name goes here.]] ![CDATA[Member’s last name goes here.]] ![CDATA[Member’s photo url goes here.]] 1111111111111
Returns a list of Investments of projects under given affiliate id.
HTTP Request Method: GET
Required Permission: bi.affiliate.project2.investment – Get
Arguments
p (Project ID): Required
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 ![CDATA[Investment title goes here]] 100
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getProject2InvestmentList
Description
Returns a list of Investments of projects under given affiliate id.
HTTP Request Method: GET
Required Permission: bi.affiliate.project2investments – Get
Arguments
a (Affiliate ID): Required
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 ![CDATA[Investment title goes here]] 100
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getProject2ProjectionList
Description
Returns a list of projections of all projects under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.getProject2ProjectionList – Get
Arguments
a (Affiliate ID): Required
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Returns a list of projects and project information, under given affiliate id.
HTTP Request Method: GET
Required Permission: bi.affiliate.project2details.list – Get
Arguments
a (Affiliate ID): Required
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Returns a list of projects and project information, under given affiliate id.
HTTP Request Method: GET
Required Permission: bi.affiliate.project2details.list – Get
Arguments
p (Project ID): Required
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111
[CDATA[Template goes here]] 2012-11-15 11:01:48 AM 2012-11-15 11:01:48 AM 11111111-1111-1111-1111-111111111111 [CDATA[Status goes here]] 2012-11-15 11:01:48 AM 100
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getProject2ResultList
Description
Returns a list of results of all projects under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.getProject2ResultList – Get
Arguments
a (Affiliate ID): Required
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 <$10,000.00> Description of this result 1/1/2012 12/30/2012 1 11/14/2012
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
bi.affiliate.getActionItemList
Description
Returns a list of action items under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.getActionItemList – Get
This is the affiliate ID under which the member account exists.
campaign_id (Campaign ID): Optional
This is the campaign ID the member will be logging into.
email (Email): Required
This is the email for the member account.
screen_name (Screen Name): Optional
This is the screen name for the member account.
first_name (First Name): Optional
This is the first name of the member.
last_name (Last Name): Optional
This is the last name of the member.
employee_id (External Employee ID): Optional
This is the external employee ID for the member account if you have an existing member system.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.member.getByEmail
Description
Returns a member account given an email.
HTTP Request Method: GET
Required Permission: bi.affiliate.member – Get
Arguments
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
e (Email): Required
This is the URL encoded email address of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 OD111 testuser@brightidea.com
Yes 8/29/2008 12:05:29 PM 8/29/2008 12:05:29 PM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member email.
Required data not supplied.
bi.affiliate.member.getByID
Description
Returns a member account given a member ID.
HTTP Request Method: GET
Required Permission: bi.affiliate.member – Get
Arguments
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 OD111 testuser@brightidea.com
Yes 8/29/2008 12:05:29 PM 8/29/2008 12:05:29 PM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
bi.affiliate.member.getByEmployeeID
Description
Returns a member account given a employee ID.
HTTP Request Method: GET
Required Permission: bi.affiliate.member – Get
Arguments
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
x (Employee ID): Required
This is the Employee ID (External Employee ID) (i.e. XU15M) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 OD111 testuser@brightidea.com
Yes 8/29/2008 12:05:29 PM 8/29/2008 12:05:29 PM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
bi.affiliate.member.getByScreenName
Description
Returns a member account given a screen name.
HTTP Request Method: GET
Required Permission: bi.affiliate.member – Get
Arguments
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
n (Screen Name): Required
This is the screen name of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 OD111 testuser@brightidea.com
Yes 8/29/2008 12:05:29 PM 8/29/2008 12:05:29 PM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member screen name.
Required data not supplied.
bi.affiliate.member.getAccessibleAffiliateList
Description
Gets a list of existing affiliate that a member has access to.
HTTP Request Method: GET
Required Permission: bi.affiliate – Get
Arguments
e (Email): Required
This is the email of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> OD1234
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.getAccessibleCampaignList
Description
Gets a list of existing campaigns that a member has access to.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM 11/12/2008 9:21:47 AM 1 This is a test campaign 11111111-1111-1111-1111-111111111111 Test User 11111111-1111-1111-1111-111111111111 Test User Private
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.getBlogList
Description
Gets a list of existing blogs submitted by a given member.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.getBlogCommentList
Description
Returns a list of existing blog comments submitted by a given member.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog.comment – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111
11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.getBlogTagList
Description
Get a list of exising blog tags submitted by a given member.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog.tag – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 TestTag 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.getChip
Description
Returns Chip count for a given member.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.vote – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 200 100
22222222-2222-2222-2222-222222222222 400 150
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.getIdeaChipVoteList
Description
Get a list of exising idea chip votes submitted by a given member.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.vote – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Gets a list of existing ideas submitted by a given member.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 D101 11111111-1111-1111-1111-111111111111 3 11/12/2008 9:21:47 AM 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 False True
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.getIdeaCommentList
Description
Get a list of existing idea comments under a given member.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.comment – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111
11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 True
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.getIdeaTagList
Description
Get a list of exising idea tags submitted by a given member.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.tag – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 TestTag 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.getIdeaViewList
Description
Get a list of idea views by a given member.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.view – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Get a list of exising idea votes submitted by a given member.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.vote – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Get a list of successful logins by a given member.
HTTP Request Method: GET
Required Permission: bi.affiliate.member.login – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 8/29/2008 12:05:29 PM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.getTransactionList
Description
Get a list of transactions given and received by a given member.
HTTP Request Method: GET
Required Permission: bi.affiliate.member.transaction – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 PROMOTE_IDEA 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 3
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.getTworkList
Description
Returns a list of tworks under a given member.
HTTP Request Method: GET
Required Permission: bi.affiliate.twork – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111
11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.update
Description
Returns a member account given a member.
HTTP Request Method: POST
Required Permission: bi.affiliate.member – Update
Arguments
member_id (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
email (Email): Optional
his is the email for the new member account.
password (Password): Optional
This is the password for the member account.
first_name (First Name): Optional
This is the first name of the member.
last_name (Last Name): Optional
This is the last name of the member.
employee_id (External Employee ID): Optional
This is the external employee ID for the member account if you have an existing member system. (Typically used only for SSO accounts.)
job_title (Job Title): Optional
This is the job title of the member.
address (Address): Optional
This is the home address of the member.
phone (Primary Phone): Optional
This is the primary phone number of the member.
mobile_phone (Mobile Phone): Optional
This is the mobile phone number of the member.
work_history (Work History): Optional
This is a brief work histoy of the member.
skills (Skills): Optional
This is a list of job skills of the member.
active (Active): Optional
This is the true/false flag on user active state.
photo (Profile Photo): Optional
This is the profile photo of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 OD111 testuser@brightidea.com
Yes 8/29/2008 12:05:29 PM 8/29/2008 12:05:29 PM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid Email Address.
Email Address Already Taken by Another User.
bi.affiliate.member.getActionItemList
Description
Returns a list of action items under a given member.
HTTP Request Method: GET
Required Permission: bi.affiliate.member.actionItem – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM Test action 11111111-1111-1111-1111-111111111111 Test Status
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.getActivityFeed
Description
Returns activity feed the member has subscribed.
HTTP Request Method: GET
Required Permission: bi.affiliate.twork – Get
Arguments
member_id (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
last (Last update date): Optional
This is the date (i.e. 11/12/2008 9:21:47 AM) of the oldest update from last request.
oldest_id (Oldest update ID): Optional
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the oldest update id from last request.
limit (Limit): Optional
This is the limit of how many result could return one time.
all (Include All): Optional
This is flag to display either updates from the entire affiliate or only the subscribed member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> PROMOTE_IDEA 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 Test Campaign 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 Test Status
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.getNewItems
Description
Returns the number of new items for the give member.
HTTP Request Method: POST
Required Permission: bi.affiliate.member.newitems – Get
Arguments
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
t (Time): Required
This is the date (i.e. 11/12/2008 9:21:47 AM) to start calculating new items.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 20 11111111-1111-1111-1111-111111111111 20
11 11
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.forgotPassword
Description
Request reset password email for the given member.
Returns extra info for campaigns the give member has access to.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign – Get
Arguments
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111
This is a test campaign
0 0 0 1
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.member.transaction.get
Description
Returns a member’s transaction.
HTTP Request Method: GET
Required Permission: bi.affiliate.member.transaction – Get
Arguments
t (Transaction ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the transaction.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 PROMOTE_IDEA 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 3
These are the category titles if you wish to create categories.
status_1 – status_15 (Status Titles): Optional
These are the status titles if you wish to create statuses (Leave blank if you are using an existing affiliate).
banner (Banner Image): Optional
This is a file object which will be uploaded and used as the banner for the campaign. (Recommended width is 950 pixels.)
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid demo code.
Invalid affiliate id.
Required data not supplied.
bi.affiliate.campaign.get
Description
Returns an existing campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign – Get
Arguments
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM 11/12/2008 9:21:47 AM 1
This is a test campaign 11111111-1111-1111-1111-111111111111 Test User 11111111-1111-1111-1111-111111111111 Test User Private
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid campaign id.
Required data not supplied.
bi.affiliate.campaign.getBlogList
Description
Returns a list of existing blogs under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid campaign id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.getBlogCommentList
Description
Get a list of existing blog comments under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog.comment – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111
11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid campaign id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.getBlogTagList
Description
Get a list of exising blog tags under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog.tag – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 TestTag 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid campaign id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.getCategoryList
Description
Returns a list of existing categories under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.category – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Test Category 11/12/2008 9:21:47 AM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid campaign id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.getIdeaList
Description
Returns a list of existing ideas under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 D101 3 11/12/2008 9:21:47 AM 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 Test Category 11111111-1111-1111-1111-111111111111 Test Status False True 1
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid campaign id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.getIdeaChipVoteList
Description
Returns a list of idea chip votes under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.vote – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Get a list of existing idea comments under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.comment – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111
11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 True
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid campaign id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.getIdeaTagList
Description
Returns a list of existing idea tags under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.tag – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 TestTag 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid campaign id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.getIdeaViewList
Description
Returns a list of idea views under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.view – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Returns a list of idea votes under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.vote – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Returns a list of attachments under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.attachment – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 8/29/2008 12:05:29 PM 11111111-1111-1111-1111-111111111111 public
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid campaign id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.getIdeaDetailList
Description
Returns a list of ideas with detail information under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.vote – Get
Arguments
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 3 11/12/2008 9:21:47 AM 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 False
Returns a list of member transactions under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.member.transaction – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 PROMOTE_IDEA 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 3
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid campaign id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.getStatusList
Description
Returns a list of campaign level statuses under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.status – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Test Status
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.addGroup
Description
Grant access for a group to a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign – Add Group
Arguments
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
g (Group ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the group.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
11111111-1111-1111-1111-111111111111 Test Group Name 8/29/2008 12:05:29 PM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.campaign.getGroupList
Description
Returns a list of groups that has access to a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.group – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Test Group 8/29/2008 12:05:29 PM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.campaign.getEvaluationTeamList
Description
Returns a list of evaluation teams for a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.evaluationTeam – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Test Team
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.campaign.getEvaluatorList
Description
Returns a list of evaluators for a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.member – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 OD111 testuser@brightidea.com
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
t (Category Title): Required
This is the title of the new category.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Test Category 11/12/2008 9:21:47 AM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid campaign id.
Required data not supplied.
bi.affiliate.campaign.category.get
Description
Returns an existing category.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.category – Get
Arguments
c (Category ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the category.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Test Category 11/12/2008 9:21:47 AM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid category id.
Required data not supplied.
bi.affiliate.campaign.submissionForm.get
Description
Returns an existing submission form for a campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.submissionForm – Get
Arguments
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
SELECT 1 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.community.getCampaignList
Description
Returns a list of immediate child Campaigns belonging to a parent community.
HTTP Request Method: GET
Required Permission: bi.affiliate.community.campaign – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
l (Level ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of a parent Community.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM 11/12/2008 9:21:47 AM 1 This is a test campaign 11111111-1111-1111-1111-111111111111 Test User 11111111-1111-1111-1111-111111111111 Test User Private
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.status.create
Description
Creates a new status under a given affiliate.
HTTP Request Method: POST
Required Permission: bi.affiliate.status – Create
Arguments
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
t (Status Title): Required
This is the title of the new status.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Test Status
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
bi.affiliate.status.get
Description
Returns an existing status.
HTTP Request Method: GET
Required Permission: bi.affiliate.status – Get
Arguments
s (Status ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the status.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 Test Status
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid status id.
Required data not supplied.
bi.affiliate.twork.create
Description
Creates a new twork under a given affiliate.
HTTP Request Method: POST
Required Permission: bi.affiliate.twork – Create
Arguments
member_id (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member posting the twork.
body (Twork Body): Required
This is the body of the new twork.
attachment (Attachment): Optional
This is the attachment of the new twork.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111
11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid member id.
Required data not supplied.
bi.affiliate.twork.get
Description
Returns an existing status.
HTTP Request Method: GET
Required Permission: bi.affiliate.twork – Get
Arguments
t (Twork ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the twork.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111
11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid twork id.
Required data not supplied.
bi.affiliate.twork.getCommentList
Description
Returns a list of comment for the update.
HTTP Request Method: GET
Required Permission: bi.affiliate.twork – Get
Arguments
t (Twork ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the twork.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM 3
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member creating the blog topic.
name (Name): Required
This is the name of the new blog topic.
description (Description): Required
This is the description of the new blog topic.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
bi.affiliate.blogtopic.get
Description
Returns an existing blog topic.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic – Get
Arguments
t (Blog Topic ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the blog topic (campaign ID if for campaign admin blog).
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid blog topic id.
Required data not supplied.
bi.affiliate.blogtopic.getBlogList
Description
Returns a list of existing blogs under a given blog topic.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
t (Blog Topic ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the blog topic (campaign ID if for campaign admin blog).
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the blog topic (campaign ID if for campaign admin blog).
member_id (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member creating the blog.
title (Title): Required
This is the title of the new blog.
body (Body): Required
This is the body of the new blog.
tag_1 – tag_5 (Tags): Optional
These are optional tags which can be attached to the blog.
attachment (File Attachment): Optional
This is an optional file which will be uploaded and attached to the blog.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid campaign id.
Required data not supplied.
bi.affiliate.blogtopic.blog.get
Description
Gets an existing blog.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog – Get
Arguments
b (Blog ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the blog.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid blog id.
Required data not supplied.
bi.affiliate.blogtopic.blog.getCommentList
Description
Get a list of existing blog comments under a given blog.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog.comment – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
b (Blog ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the blog.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111
11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid blog id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.blogtopic.blog.getTagList
Description
Get a list of exising blog tags under a given blog.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog.tag – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
b (Blog ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the blog.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 TestTag
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea to edit.
category_id (Category ID): Optional
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the category the idea should be changed to.
title (Title): Optional
This is the title of the idea.
body (Body): Optional
This is the body of the idea.
submission_form (Submission Form): Optional
These are optional submission form answers in XML format.
Example:
11111111-1111-1111-1111-111111111111 Answer to this question
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 3 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 False True
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid campaign id.
Required data not supplied.
bi.affiliate.campaign.idea.get
Description
Gets an existing idea.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea – Get
Arguments
i (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 D101 3 11/12/2008 9:21:47 AM 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 False True
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid idea id.
Required data not supplied.
bi.affiliate.campaign.idea.getCommentList
Description
Get a list of existing idea comments under a given idea.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.comment – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
i (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111
11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 True
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid idea id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.idea.getChipVoteList
Description
Get a list of exising idea chip votes under a given idea.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.vote – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
i (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
Get a list of evaluation form score under a given idea.
HTTP Request Method: GET
Required Permission: bi.affiliate.evaluationForm – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
i (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 10
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid idea id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.idea.getHistoryRecordList
Description
Get a list of history records under a given idea.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.history – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
i (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 11/12/2008 9:21:47 AM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid idea id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.idea.getPrivateCommentList
Description
Get a list of private comments under a given idea.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.privateComment – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
i (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111
11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid idea id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.idea.getTagList
Description
Get a list of exising idea tags under a given idea.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.tag – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
i (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 TestTag
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid idea id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.idea.getViewList
Description
Get a list of exising idea views for a given idea.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.view – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
i (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
Get a list of exising idea votes under a given idea.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.vote – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
i (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
Returns a list of evaluators and scores for a given evaluation form.
HTTP Request Method: GET
Required Permission: bi.affiliate.evaluationForm – Get
Arguments
i (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
e (Form ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the evaluation form.
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 10
Returns the result of a completed evaluation form.
HTTP Request Method: GET
Required Permission: bi.affiliate.evaluationForm – Get
Arguments
i (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
e (Form ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the evaluation form.
m (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111
Test Body
Vote exists. – (only one promote/demote per idea is allowed)
Required data not supplied.
bi.affiliate.project2.getMilestoneList
Description
Returns a list of milestones under a given project.
HTTP Request Method: GET
Required Permission: bi.affiliate.project2.getMilestoneList – Get
Arguments
p (Project ID): Required
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 8/29/2008 8/29/2008 ![CDATA[Related To Do’s count goes here.]] ![CDATA[Total Related To Do’s count goes here.]]
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
bi.affiliate.project2.getProjectionList
Description
Returns a list of projections of the given project.
HTTP Request Method: GET
Required Permission: bi.affiliate.project2.getProjectionList – Get
Arguments
p (Project ID): Required
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Required Permission: bi.affiliate.project2.getResultList – Get
Arguments
p (Project ID): Required
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 <$10,000.00> Description of this result 1/1/2012 12/30/2012 1 11/14/2012
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
bi.affiliate.getProject2ToDoList
Description
Returns a list of todos of all projects under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.getProject2ToDoList – Get
Arguments
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 ![CDATA[Project Name]] 11111111-1111-1111-1111-111111111111 2 ![CDATA[Test User 1]] ![CDATA[Test User 2]] <11/14/2012 08:56:20 AM> <11/14/2012 08:56:20 AM> 3 4 Test User 1 Test User 2
5
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.project2.getToDoList
Description
Returns a list of todos for the given project.
HTTP Request Method: GET
Required Permission: bi.affiliate.project2.getToDoList – Get
Arguments
p (Project ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the project.
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 ![CDATA[Project Name]] 2 ![CDATA[Test User 1]] ![CDATA[Test User 2]] <11/14/2012 08:56:20 AM> <11/14/2012 08:56:20 AM> 3 4 Test User 1 Test User 2
5
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.evaluationTeam.getMemberList
Description
Get a list of evaluation team member.
HTTP Request Method: GET
Required Permission: bi.affiliate.member – Get
Arguments
e (Evaluation Team ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the evaluation team.
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 OD111 testuser@brightidea.com
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
group_id (Group ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the group.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 OD111 testuser@brightidea.com
Yes 8/29/2008 12:05:29 PM 8/29/2008 12:05:29 PM
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.label.update
Description
Update label in the given affiliate.
HTTP Request Method: POST
Required Permission: bi.affiliate.label – Update
Arguments
member_id (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
affiliate_id (Affiliate ID): Required
This is the ID (i.e. ODXXX) of the affiliate.
campaign_id (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
label_key (Label Key): Required
Label key: LBL_WS_SETUP.
label_value (New Value of Label): Required
New value of label: the setup.
language (Language Name): Required
Language name in test: Spanish.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.proposal.getRelatedIdeaList
Description
Returns the related ideas for a given proposal.
HTTP Request Method: GET
Required Permission: bi.affiliate.proposal.relatedIdea – Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > ’11/23/09′ ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
p (Proposal ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the proposal.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?> 11111111-1111-1111-1111-111111111111 D101 3 11/12/2008 9:21:47 AM 11/12/2008 9:21:47 AM 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 11111111-1111-1111-1111-111111111111 False True
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.proposal.get
Description
Returns the data related for a given proposal.
HTTP Request Method: GET
Required Permission: bi.affiliate.proposal – Get
Arguments
p (Proposal ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the proposal.
We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choice. By continuing to use this site you are giving us your consent to do this. Accept