API
Introduction
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″?>
1
bi.api
bi.api.get
bi.api.getAffiliateList
bi.api.getAPICallList
bi.api.getPermissionList
bi.affiliate
bi.affiliate.create
bi.affiliate.get
bi.affiliate.getBlogList
bi.affiliate.getBlogCommentList
bi.affiliate.getBlogTagList
bi.affiliate.getCampaignList
bi.affiliate.getCampaignStatusList
bi.affiliate.getCategoryList
bi.affiliate.getCommunityList
bi.affiliate.getIdeaList
bi.affiliate.getIdeaChipVoteList
bi.affiliate.getIdeaCommentList
bi.affiliate.getIdeaTagList
bi.affiliate.getIdeaViewList
bi.affiliate.getIdeaVoteList
bi.affiliate.getMemberList
bi.affiliate.getMemberLoginList
bi.affiliate.getMemberTransactionList
bi.affiliate.getProjectList
bi.affiliate.getProjectStageList
bi.affiliate.getProjectStatusList
bi.affiliate.getStatusList
bi.affiliate.getTworkList
bi.affiliate.getBusinessUnitList
bi.affiliate.getEvaluationFormList
bi.affiliate.getEvaluatorList
bi.affiliate.getGroupList
bi.affiliate.getPoolList
bi.affiliate.getProposalList
bi.affiliate.getRandomIdeaList
bi.affiliate.getFile
bi.affiliate.getActionItemList
bi.affiliate.member
bi.affiliate.member.authenticate
bi.affiliate.member.create
bi.affiliate.member.createSession
bi.affiliate.member.getByEmail
bi.affiliate.member.getByID
bi.affiliate.member.getByEmployeeID
bi.affiliate.member.getByScreenName
bi.affiliate.member.getAccessibleAffiliateList
bi.affiliate.member.getAccessibleCampaignList
bi.affiliate.member.getBlogList
bi.affiliate.member.getBlogCommentList
bi.affiliate.member.getBlogTagList
bi.affiliate.member.getChip
bi.affiliate.member.getIdeaList
bi.affiliate.member.getIdeaChipVoteList
bi.affiliate.member.getIdeaCommentList
bi.affiliate.member.getIdeaTagList
bi.affiliate.member.getIdeaViewList
bi.affiliate.member.getIdeaVoteList
bi.affiliate.member.getLoginList
bi.affiliate.member.getTransactionList
bi.affiliate.member.getTworkList
bi.affiliate.member.update
bi.affiliate.member.getActionItemList
bi.affiliate.member.getActivityFeed
bi.affiliate.member.getNewItems
bi.affiliate.member.forgotPassword
bi.affiliate.member.getAccessibleCampaignListExtraInfo
bi.affiliate.member.transaction
bi.affiliate.member.transaction.get
bi.affiliate.campaign
bi.affiliate.campaign.create.basic
bi.affiliate.campaign.create.advanced
bi.affiliate.campaign.get
bi.affiliate.campaign.getBlogList
bi.affiliate.campaign.getBlogCommentList
bi.affiliate.campaign.getBlogTagList
bi.affiliate.campaign.getCategoryList
bi.affiliate.campaign.getIdeaList
bi.affiliate.campaign.getIdeaChipVoteList
bi.affiliate.campaign.getIdeaCommentList
bi.affiliate.campaign.getIdeaTagList
bi.affiliate.campaign.getIdeaViewList
bi.affiliate.campaign.getIdeaVoteList
bi.affiliate.campaign.getIdeaAttachmentList
bi.affiliate.campaign.getIdeaDetailList
bi.affiliate.campaign.getMemberTransactionList
bi.affiliate.campaign.getStatusList
bi.affiliate.campaign.addGroup
bi.affiliate.campaign.getGroupList
bi.affiliate.campaign.getEvaluationTeamList
bi.affiliate.campaign.getEvaluatorList
bi.affiliate.campaign.category
bi.affiliate.campaign.category.create
bi.affiliate.campaign.category.get
bi.affiliate.campaign.submissionForm
bi.affiliate.campaign.submissionForm.get
bi.affiliate.community
bi.affiliate.community.getCampaignList
bi.affiliate.status
bi.affiliate.status.create
bi.affiliate.status.get
bi.affiliate.twork
bi.affiliate.twork.create
bi.affiliate.twork.get
bi.affiliate.twork.getCommentList
bi.affiliate.twork.comment
bi.affiliate.twork.comment.create
bi.affiliate.twork.comment.delete
bi.affiliate.twork.hifive
bi.affiliate.twork.hifive.create
bi.affiliate.blogtopic
bi.affiliate.blogtopic.create
bi.affiliate.blogtopic.get
bi.affiliate.blogtopic.getBlogList
bi.affiliate.blogtopic.blog
bi.affiliate.blogtopic.blog.create
bi.affiliate.blogtopic.blog.get
bi.affiliate.blogtopic.blog.getCommentList
bi.affiliate.blogtopic.blog.getTagList
bi.affiliate.campaign.idea
bi.affiliate.campaign.idea.create
bi.affiliate.campaign.idea.update
bi.affiliate.campaign.idea.get
bi.affiliate.campaign.idea.getChipVoteList
bi.affiliate.campaign.idea.getCommentList
bi.affiliate.campaign.idea.getTagList
bi.affiliate.campaign.idea.getViewList
bi.affiliate.campaign.idea.getVoteList
bi.affiliate.campaign.idea.updateStatus
bi.affiliate.campaign.idea.getCompletedSubmissionForm
bi.affiliate.campaign.idea.getCompletedEvaluation
bi.affiliate.campaign.idea.getEvaluationFormScoreList
bi.affiliate.campaign.idea.getHistoryRecordList
bi.affiliate.campaign.idea.getPrivateCommentList
bi.affiliate.campaign.idea.getScorecardList
bi.affiliate.blogtopic.blog.comment
bi.affiliate.blogtopic.blog.comment.create
bi.affiliate.blogtopic.blog.comment.get
bi.affiliate.campaign.idea.comment
bi.affiliate.campaign.idea.comment.create
bi.affiliate.campaign.idea.comment.get
bi.affiliate.campaign.idea.evaluationForm
bi.affiliate.campaign.idea.evalutionForm.getMemberEvalutionList
bi.affiliate.campaign.idea.evaluationForm.getCompletedEvaluation
bi.affiliate.campaign.idea.evaluationForm.memberEvaluation
bi.affiliate.campaign.idea.evalutionForm.memberEvaluation.getCompletedEvaluation
bi.affiliate.blogtopic.blog.tag
bi.affiliate.blogtopic.blog.tag.create
bi.affiliate.blogtopic.blog.tag.get
bi.affiliate.campaign.idea.tag
bi.affiliate.campaign.idea.tag.create
bi.affiliate.campaign.idea.tag.get
bi.affiliate.campaign.idea.view
bi.affiliate.campaign.idea.view.create
bi.affiliate.campaign.idea.chipvote
bi.affiliate.campaign.idea.chipvote.create
bi.affiliate.campaign.idea.Chipvote.clear
bi.affiliate.campaign.idea.vote
bi.affiliate.campaign.idea.vote.create
bi.affiliate.campaign.idea.vote.clear
bi.affiliate.project2
bi.affiliate.getProject2List
bi.affiliate.getProject2MilestoneList
bi.affiliate.project2.getMilestoneList
bi.affiliate.getProject2ProjectionList
bi.affiliate.project2.getProjectionList
bi.affiliate.project2.getTeamMemberList
bi.affiliate.project2.getRelatedProposalList
bi.affiliate.getProject2InvestmentList
bi.affiliate.project2.getInvestmentList
bi.affiliate.getProject2ResultList
bi.affiliate.project2.getResultList
bi.affiliate.getProject2ToDoList
bi.affiliate.project2.getToDoList
bi.affiliate.evaluationTeam
bi.affiliate.evaluationTeam.getMemberList
bi.affiliate.group
bi.affiliate.group.addMember
bi.affiliate.group.get
bi.affiliate.group.removeMember
bi.affiliate.label
bi.affiliate.proposal
bi.affiliate.proposal.getRelatedIdeaList
bi.affiliate.proposal.get
bi.affiliate.proposal.getAttachmentsList
bi.affiliate.proposal.getCommentsList
bi.affiliate.proposal.getTeamList
bi.affiliate.proposal.getEvaluationList
bi.affiliate.apns
bi.apns.unregister
bi.apns.setActiveAccount
bi.apns.enableBadgeNotification
bi.apns.resetBadgeCount
bi.api.get
Description
Returns all data for this BI API Key.
HTTP Request Method: GET
Required Permission: bi.api – Get
Arguments
none
Example Response
< ?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
<![CDATA[Title of the new blog.]]>
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
11111111-1111-1111-1111-111111111111
3
<![CDATA[Title of the new idea.]]>
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
D101Errors
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.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
1
11111111-1111-1111-1111-111111111111
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 affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getIdeaCommentList
Description
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.
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
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.getIdeaVoteList
Description
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.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
Promote
11111111-1111-1111-1111-111111111111
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 affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getMemberList
Description
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.
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
<![CDATA[Title of the project.]]>
8/29/2008 12:05:29 PM
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.getProjectStageList
Description
Returns a list of stages for project.
HTTP Request Method: GET
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
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
3
<![CDATA[Title of the new idea.]]>
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
D101Errors
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
<![CDATA[New Milestone 001]]>
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
1111111111111
11/12/2012
11/12/2012
1111111111111
1111111111111
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.getInvestmentList
Description
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.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
11111111-1111-1111-1111-111111111111
<100>
<100>
100
100
100
100
<8/29/2008>
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
bi.affiliate.getProject2List
Description
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.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
11111111-1111-1111-1111-111111111111
[CDATA[Title goes here]]
11111111-1111-1111-1111-111111111111
2011-01-08 9:36:42 PM
< 2011-01-08 >
100
100
100
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.project2.getRelatedProposalList
Description
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
[CDATA[Template goes here]]
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
Arguments
a (Affiliate ID): Required
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
<![CDATA[New Idea 001]]>
testuser@brightidea.com
john@brightidea.com
Scorecard/Proposal
8/29/2008 12:05:29 PM
8/29/2008
8/29/2008
11111111-1111-1111-1111-111111111111Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
bi.affiliate.member.authenticate
Description
Verifies a member’s login credentials.
HTTP Request Method: POST
Required Permission: bi.affiliate.member – Authenticate
Arguments
affiliate_id (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
email (Email): Required
This is the email of the member account.
password (Password): Required
This is the password of the member account.
apns_token (APNS device token): Optional
This is the APNS device token to be stored for this member account.
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.
Authentication failed.
Required data not supplied.
bi.affiliate.member.create
Description
Creates a new member under a given affiliate.
HTTP Request Method: POST
Required Permission: bi.affiliate.member – Create
Arguments
affiliate_id (Affiliate ID): Required
This is the affiliate ID under which the new member account will be created.
email (Email): Required
This is the email for the new member account.
password (Password): Required
This is the password for the new member account.
screen_name (Screen Name): Required
This is the screen name for the new member account.
first_name (First Name): Optional
This is the first name of the new member.
last_name (Last Name): Optional
This is the last name of the new member.
photo (Photo): Optional
This is a file object which will be uploaded and used as the photo for the new member account.
employee_id (External Employee ID): Optional
This is the external employee ID for the new member account if you have an existing member system. (Typically used only for SSO accounts.)
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.
Requested email or screen name is not avaliable or is invalid.
Member licenses exceeded.
Required data not supplied.
Screen name must be at least 3 characters.
bi.affiliate.member.createSession
Description
Creates a validated session token for use with custom SSO.
HTTP Request Method: POST
Required Permission: bi.affiliate.member – Create Session
Arguments
affiliate_id (Affiliate ID): Required
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
<![CDATA[Title of the new blog.]]>
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.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
1
11111111-1111-1111-1111-111111111111
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.getIdeaList
Description
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
11111111-1111-1111-1111-111111111111
3
<![CDATA[Title of the new idea.]]>
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
D101Errors
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.
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
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.getIdeaVoteList
Description
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.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
Promote
11111111-1111-1111-1111-111111111111
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.getLoginList
Description
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.
HTTP Request Method: POST
Required Permission: bi.affiliate.member – Update
Arguments
affiliate_id (Affiliate ID): Required
This is the ID (i.e. OD1234) of the affiliate.
email (Email): Required
This is the email of the member.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
Success
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.getAccessibleCampaignListExtraInfo
Description
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
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
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid transaction id.
Required data not supplied.
bi.affiliate.campaign.create.basic
Description
Creates a new campaign under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign – Create
Arguments
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
n (Campaign Name): Required
This is the name of the new campaign.
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 affiliate id.
Required data not supplied.
bi.affiliate.campaign.create.advanced
Description
Creates a new campaign under a given affiliate.
HTTP Request Method: POST
Required Permission: bi.affiliate.campaign – Create
Arguments
affiliate_id (Affiliate ID): Optional
This is the ID (i.e. OD111) of the affiliate (Leave blank if you wish to create a new affiliate).
demo_code (Demo Code): Optional
This is the demo code given to you by Brightidea (Leave blank if you do not have one).
admin_email (Administrator Email): Optional
This is the email of the administrator account (Leave blank if you are using an existing affiliate).
admin_screen_name (Administrator Screen Name): Optional
This is the screen name of the administrator account (Leave blank if you are using an existing affiliate).
admin_password (Administrator Password): Optional
This is the password of the administrator account (Leave blank if you are using an existing affiliate).
affiliate_name (Affiliate Name): Optional
This is the name of the affiliate (Leave blank if you are using an existing affiliate).
campaign_name (Campaign Name): Required
This is the name of the new campaign.
campaign_description (Campaign Description): Optional
This is the description of the new campaign.
campaign_url (Campaign URL): Required
This is the vanity URL for the new campaign (e.g. testcampaign).
privacy (Public or Private Campaign?): Optional
This variable should be sent as either “Private” or “Public“. By default, this option will be set to Private.
registration (Open or Closed Registration?): Optional
This variable should be sent as either “Open” or “Closed“. By default, this option will be set to Open.
category_1 – category_25 (Category Titles): Optional
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
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
<![CDATA[Title of the new blog.]]>
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
3
<![CDATA[Title of the new idea.]]>
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
D101Errors
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.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
1
11111111-1111-1111-1111-111111111111
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 campaign id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.getIdeaCommentList
Description
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.
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
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.getIdeaVoteList
Description
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.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
Promote
11111111-1111-1111-1111-111111111111
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 campaign id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.getIdeaAttachmentList
Description
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
<![CDATA[Title of the new idea.]]>
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
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.getMemberTransactionList
Description
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″?>
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
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.campaign.category.create
Description
Creates a new category under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.category – Create
Arguments
c (Campaign ID): Required
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
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.comment.create
Description
Creates a new comment under a given update.
HTTP Request Method: POST
Required Permission: bi.affiliate.twork.comment – Create
Arguments
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member posting the comment.
t (Activity Item ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the activity item to be commented.
c (Comment text): Required
This is content of the comment.
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.comment.delete
Description
Delete a given comment.
HTTP Request Method: POST
Required Permission: bi.affiliate.twork.comment – Delete
Arguments
c (Comment ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the comment to be deleted.
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.hifive.create
Description
Creates a new hifive under a given update.
HTTP Request Method: GET
Required Permission: bi.affiliate.twork.hifive – Create
Arguments
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member posting the hifive.
t (Activity Item ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the activity item to be hifived.
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.blogtopic.create
Description
Creates a new blog topic under a given affiliate.
HTTP Request Method: POST
Required Permission: bi.affiliate.blogtopic – Create
Arguments
member_id (Member ID): Required
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
<![CDATA[Title of the new blog.]]>
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.
Invalid SQL query.
bi.affiliate.blogtopic.blog.create
Description
Creates a new blog under a given campaign.
HTTP Request Method: POST
Required Permission: bi.affiliate.blogtopic.blog – Create
Arguments
topic_id (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).
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
<![CDATA[Title of the new blog.]]>
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
<![CDATA[Title of the new blog.]]>
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
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.campaign.idea.create
Description
Creates a new idea under a given campaign.
HTTP Request Method: POST
Required Permission: bi.affiliate.campaign.idea – Create
Arguments
campaign_id (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
member_id (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member creating the idea.
category_id (Category ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the category the idea should be added to.
title (Title): Required
This is the title of the new idea.
body (Body): Required
This is the body of the new idea.
tag_1 – tag_5 (Tags): Optional
These are optional tags which can be attached to the idea.
attachment (File Attachment): Optional
This is an optional file which will be uploaded and attached to 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:
Answer to this question
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
11111111-1111-1111-1111-111111111111
3
<![CDATA[Title of the new idea.]]>
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.update
Description
Update a new idea under a given campaign.
HTTP Request Method: POST
Required Permission: bi.affiliate.campaign.idea – Update
Arguments
idea_id (Campaign ID): Required
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:
Answer to this question
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
11111111-1111-1111-1111-111111111111
3
<![CDATA[Title of the new idea.]]>
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
3
<![CDATA[Title of the new idea.]]>
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
D101Errors
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.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
1
11111111-1111-1111-1111-111111111111
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 idea id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.idea.getCompletedSubmissionForm
Description
Get the result of a completed submission form under a given idea.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.submissionForm – 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
Test Body
Test Body
Test Body
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.getCompletedEvaluation
Description
Get the result of all completed evaluation forms under a given idea.
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.
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
Test Body
11111111-1111-1111-1111-111111111111
Test Body
Test Body
Test Body
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.getEvaluationFormScoreList
Description
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.
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
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.getVoteList
Description
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.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
Promote
11111111-1111-1111-1111-111111111111
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 idea id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.idea.updateStatus
Description
Updates the status of a given idea.
HTTP Request Method: GET or POST
Required Permission: bi.affiliate.campaign.idea – Update Status
Arguments
idea_id (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
status_id (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
<![CDATA[Title of the new idea.]]>
11/12/2008 9:21:47 AM
11111111-1111-1111-1111-111111111111
11111111-1111-1111-1111-111111111111
11111111-1111-1111-1111-111111111111
False
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.campaign.idea.getScorecardList
Description
Get a list of exising idea scorecards under a given idea.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.scorecard – 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″?>
General Evaluaton
11111111-1111-1111-1111-111111111111
11111111-1111-1111-1111-111111111111
Batch1
11111111-1111-1111-1111-111111111111
1
11/12/2008 9:21:47 AM
abc
11111111-1111-1111-1111-111111111111
xyz
xyz@brightida.com
11/12/2008 9:21:47 AM
Question1
Answer1
Question2
Answer2
33.33%
2
0
1
55.55%
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid idea id.
Required data not supplied.
bi.affiliate.blogtopic.blog.comment.create
Description
Create a new comment under a given blog.
HTTP Request Method: POST
Required Permission: bi.affiliate.blogtopic.blog.comment – Create
Arguments
blog_id (Blog ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the blog.
member_id (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member creating the comment.
body (Body): Required
This is the body of the comment.
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.
Invalid member id.
Required data not supplied.
bi.affiliate.blogtopic.blog.comment.get
Description
Get an existing blog comment.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog.comment – Get
Arguments
c (Comment ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the comment.
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 comment id.
Required data not supplied.
bi.affiliate.campaign.idea.comment.create
Description
Create a new comment under a given idea.
HTTP Request Method: POST
Required Permission: bi.affiliate.campaign.idea.comment – Create
Arguments
idea_id (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
member_id (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member creating the comment.
body (Body): Required
This is the body of the comment.
comment_id (Comment ID): Optional
the comment id that is being replied to .
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.
Invalid member id.
Required data not supplied.
bi.affiliate.campaign.idea.comment.get
Description
Get an existing idea comment.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.comment – Get
Arguments
c (Comment ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the comment.
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 comment id.
Required data not supplied.
bi.affiliate.campaign.idea.evaluationForm.getMemberEvaluationList
Description
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
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid comment id.
Required data not supplied.
bi.affiliate.campaign.idea.evaluationForm.getCompletedEvaluation
Description
Get the result of all completed evaluation forms under a given idea 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 (Evaluation Form ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the evaluation form.
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
Test Body
11111111-1111-1111-1111-111111111111
Test Body
Test Body
Test Body
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.evaluationForm.memberEvaluation.getCompletedEvaluation
Description
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
Test Body
Test Body
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid comment id.
Required data not supplied.
bi.affiliate.blogtopic.blog.tag.create
Description
Create a new blog tag under an existing blog.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog.tag – Create
Arguments
b (Blog ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the blog.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member creating the tag.
n (Tag Name): Required
This is the tag name.
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 blog id.
Invalid member id.
Required data not supplied.
bi.affiliate.blogtopic.blog.tag.get
Description
Get an existing blog tag under a given blog.
HTTP Request Method: GET
Required Permission: bi.affiliate.blogtopic.blog.tag – Get
Arguments
t (Tag ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the tag.
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 tag id.
Required data not supplied.
bi.affiliate.campaign.idea.tag.create
Description
Create a new idea tag under an existing idea.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.tag.create – Create
Arguments
i (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member creating the tag.
n (Tag Name): Required
This is the tag name.
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.
Invalid member id.
Required data not supplied.
bi.affiliate.campaign.idea.tag.get
Description
Get an existing idea tag under a given idea.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.tag – Get
Arguments
t (Tag ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the tag.
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 tag id.
Required data not supplied.
bi.affiliate.campaign.idea.view.create
Description
Create a new idea view under a given idea.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.view – Create
Arguments
i (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
m (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member viewing the idea.
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
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid idea id.
Invalid member id.
Required data not supplied.
bi.affiliate.campaign.idea.chipvote.create
Description
Create a new idea chip vote under a given idea.
HTTP Request Method: POST
Required Permission: bi.affiliate.campaign.idea.vote – Create
Arguments
idea_id (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
member_id (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member creating the vote.
chips (Chips): Required
This is the number of chips to assign to the vote.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
1
10
11111111-1111-1111-1111-111111111111
11
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.
Vote exists. – (only one promote/demote per idea is allowed)
Required data not supplied.
bi.affiliate.campaign.idea.Chipvote.clear
Description
Clear chip votes for a given idea.
HTTP Request Method: POST
Required Permission: bi.affiliate.campaign.idea.vote – Delete
Arguments
idea_id (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
member_id (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member creating the vote.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
0
10
11111111-1111-1111-1111-111111111111
11
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.
Vote exists. – (only one promote/demote per idea is allowed)
Required data not supplied.
bi.affiliate.campaign.idea.vote.create
Description
Create a new idea vote under a given idea.
HTTP Request Method: POST
Required Permission: bi.affiliate.campaign.idea.vote – Create
Arguments
idea_id (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
member_id (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member creating the vote.
type (Vote Type): Required
This is the type of vote to create, and should be sent as either “Promote” or “Demote”.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
Promote
11111111-1111-1111-1111-111111111111
11
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.
Vote exists. – (only one promote/demote per idea is allowed)
Required data not supplied.
bi.affiliate.campaign.idea.vote.clear
Description
Clear opinion for a given idea.
HTTP Request Method: POST
Required Permission: bi.affiliate.campaign.idea.vote – Delete
Arguments
idea_id (Idea ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the idea.
member_id (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member creating the vote.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
Promote
11111111-1111-1111-1111-111111111111
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.
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
<![CDATA[New Milestone 001]]>
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.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
11111111-1111-1111-1111-111111111111
<100>
<100>
100
100
100
100
<8/29/2008>
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.getResultList
Description
Returns a list of results of the given project.
HTTP Request Method: GET
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[To Do Title]]>
![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
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.group.addMember
Description
Add a member to a group.
HTTP Request Method: POST
Required Permission: bi.affiliate.group – AddMember
Arguments
member_id (Member ID): Required
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.group.get
Description
Get the information of a group.
HTTP Request Method: GET
Required Permission: bi.affiliate.member – Get
Arguments
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
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.group.removeMember
Description
Remove a member from a group.
HTTP Request Method: POST
Required Permission: bi.affiliate.group – RemoveMember
Arguments
member_id (Member ID): Required
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
3
<![CDATA[Title of the new idea.]]>
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
D101Errors
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.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
11111111-1111-1111-1111-111111111111
![CDATA[Proposal Name]]
![CDATA[Proposal Description]]
06/28/2012 12:46:50 PM
![CDATA[Test User]]
testuser@brightidea.com
![CDATA[Active]]
![CDATA[Active]]
30.65
![CDATA[Test Template]]
2.5
![CDATA[Test User]]
testuser@brightidea.com
06/28/2012 03:10:00 PM
![CDATA[Field Title]]
![CDATA[Field Data]]
P1104![CDATA[Test Template]]
![CDATA[Field Data]]
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.proposal.getAttachmentsList
Description
Returns the related attachments for a given proposal.
HTTP Request Method: GET
Required Permission: bi.affiliate.proposal.getAttachmentsList – Get
Arguments
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
![CDATA[image01.jpg]]
![CDATA[Attachment Name]]
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.proposal.getCommentsList
Description
Returns the related comments for a given proposal.
HTTP Request Method: GET
Required Permission: bi.affiliate.proposal.getCommentsList – Get
Arguments
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
![CDATA[Comment]]
06/28/2012 05:22:35 PM
<11111111-1111-1111-1111-111111111111>
![CDATA[Test User]]
testuser@brightidea.com
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.proposal.getTeamList
Description
Returns the team members for a given proposal.
HTTP Request Method: GET
Required Permission: bi.affiliate.proposal.getTeamList – Get
Arguments
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
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.proposal.getEvaluationList
Description
Returns the list of evaluators and their related data for a given proposal.
HTTP Request Method: GET
Required Permission: bi.affiliate.proposal.getEvaluationList – Get
Arguments
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
11111111-1111-1111-1111-111111111111
![CDATA[Batch Name]
11111111-1111-1111-1111-111111111111
![CDATA[Round 1]
![CDATA[Template Name]
![CDATA[Requestor Name]
testuser@brightidea.com
11/12/2008 9:21:47 AM
11111111-1111-1111-1111-111111111111
11/12/2008 9:21:47 AM
![CDATA[Test user]
testuser@brightida.com
Question
Answer
11111111-1111-1111-1111-111111111111
Question
Answer
11111111-1111-1111-1111-111111111111
63.33
2
63.33
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.apns.unregister
Description
Unregister the given device from apns.
HTTP Request Method: POST
Required Permission: bi.apns – Delete
Arguments
device_token (Device Token): Required
The device ID to unregister.
member_id (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″?>
OK
OK
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.apns.setActiveAccount
Description
Update status of the given device for apns.
HTTP Request Method: POST
Required Permission: bi.apns – Update
Arguments
device_token (Device Token): Required
The device ID to unregister.
member_id (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
status (Status): Required
The status for apns.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
OK
OK
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.apns.enableBadgeNotification
Description
Enable badget notification of the given device for apns.
HTTP Request Method: POST
Required Permission: bi.apns – Update
Arguments
device_token (Device Token): Required
The device ID to unregister.
member_id (Member ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the member.
badge (Badge): Required
The badge notification flag for apns.
Example Response
< ?xml version = “1.0” encoding=”UTF-8″?>
updated
updated
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.apns.resetBadgeCount
Description
Reset badget notification of the given device for apns.
HTTP Request Method: POST
Required Permission: bi.apns – Update
Arguments
device_token (Device Token): Required
The device ID to unregister.
member_id (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″?>
reset
reset
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
* Note that the API_FUNCTION and API_KEY parameters may be passed as POST parameters or HTTP headers.
PHP with cURL
// Make the API call using cURL
///////////////////////////////////////////////////
$ch = curl_init();
curl_setopt($ch, CURLOPT_HTTPHEADER, array(“API_FUNCTION: bi.affiliate.getMemberList”, “API_KEY: XXXXXXXX”));
curl_setopt($ch, CURLOPT_URL, “https://na5.brightidea.com/BIP/API/api.bix?a=ODXXX”);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, 0);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_str);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
$api_return_str = curl_exec($ch);
curl_close($ch);
///////////////////////////////////////////////////
$ch = curl_init();
curl_setopt($ch, CURLOPT_HTTPHEADER, array(“API_FUNCTION: bi.affiliate.getMemberList”, “API_KEY: XXXXXXXX”));
curl_setopt($ch, CURLOPT_URL, “https://na5.brightidea.com/BIP/API/api.bix?a=ODXXX”);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, 0);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_str);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, 0);
$api_return_str = curl_exec($ch);
curl_close($ch);
// Create DOM Document
///////////////////////////////////////////////////
$doc = new DOMDocument();
$doc->loadXML($api_return_str);
// Check to see if an error was returned
///////////////////////////////////////////////////
$error = $doc->getElementsByTagName(‘ERROR’);
if($error->length > 0)
{
echo “API Error: ” . $error->item(0)->firstChild->nodeValue . ‘
’;
’;
}
else
{
$members = $doc->getElementsByTagName(‘MEMBER’);
foreach($members as $member)
{
$id = $member->getElementsByTagName(‘ID’);
$affiliate_id = $member->getElementsByTagName(‘AFFILIATE_ID’);
$email = $member->getElementsByTagName(‘EMAIL’);
$screen_name = $member->getElementsByTagName(‘SCREEN_NAME’);
$first_name = $member->getElementsByTagName(‘FIRST_NAME’);
$last_name = $member->getElementsByTagName(‘LAST_NAME’);
$photo_url = $member->getElementsByTagName(‘PHOTO_URL’);
$affiliate_id = $member->getElementsByTagName(‘AFFILIATE_ID’);
$email = $member->getElementsByTagName(‘EMAIL’);
$screen_name = $member->getElementsByTagName(‘SCREEN_NAME’);
$first_name = $member->getElementsByTagName(‘FIRST_NAME’);
$last_name = $member->getElementsByTagName(‘LAST_NAME’);
$photo_url = $member->getElementsByTagName(‘PHOTO_URL’);
echo $id->item(0)->firstChild->nodeValue . ‘
’;
echo $affiliate_id->item(0)->firstChild->nodeValue . ‘
’;
echo $email->item(0)->firstChild->nodeValue . ‘
’;
echo $screen_name->item(0)->firstChild->nodeValue . ‘
’;
echo $first_name->item(0)->firstChild->nodeValue . ‘
’;
echo $last_name->item(0)->firstChild->nodeValue . ‘
’;
echo $photo_url->item(0)->firstChild->nodeValue . ‘
’;
echo ‘
’;
}
}
?>
PHP with sockets
// Define API call variables
///////////////////////////////////////////////////
$function = “bi.affiliate.getMemberList”;
$key = “XXXXXXXX”;
$affiliate = “ODXXX”;
$host = “na5.brightidea.com”; // This host much match your systems host
$port = 443;
$scheme = “ssl://”;
$api_return_str = “”;
///////////////////////////////////////////////////
$function = “bi.affiliate.getMemberList”;
$key = “XXXXXXXX”;
$affiliate = “ODXXX”;
$host = “na5.brightidea.com”; // This host much match your systems host
$port = 443;
$scheme = “ssl://”;
$api_return_str = “”;
// Define the headers for this call
///////////////////////////////////////////////////
$header = “GET /BIP/API/api.bix?a=” . urlencode($affiliate) . ” HTTP/1.1\r\n”;
$header .= “Host: $host\r\n”;
$header .= “API_KEY: $key\r\n”;
$header .= “API_FUNCTION: $function\r\n”;
$header .= “Connection: Close\r\n\r\n”;
// Open socket connection
///////////////////////////////////////////////////
$sock = fsockopen($scheme . $host, $port);
if(!$sock)
{
// Could not connect to the server
die(“The Brightidea API is unavailable at this time.”);
die(“The Brightidea API is unavailable at this time.”);
}
else
{
$xml_begin = false;
fwrite($sock, $header);
while(!feof($sock))
{
fwrite($sock, $header);
while(!feof($sock))
{
// Get this line
$response = fgets($sock, 1000);
$response = fgets($sock, 1000);
// Only get XML data, exclude headers
if(strpos($response, “
$xml_begin = true;
// Append this line to the response string
if($xml_begin)
$api_return_str .= $response;
}
fclose($sock);
}
// Create DOM Object
///////////////////////////////////////////////////
$doc = new DOMDocument();
$doc->loadXML($api_return_str);
// Check to see if an error was returned
///////////////////////////////////////////////////
$error = $doc->getElementsByTagName(‘ERROR’);
if($error->length > 0)
{
echo “API Error: ” . $error->item(0)->firstChild->nodeValue . ‘
’;
’;
}
else
{
$members = $doc->getElementsByTagName(‘MEMBER’);
foreach($members as $member)
{
$id = $member->getElementsByTagName(‘ID’);
$affiliate_id = $member->getElementsByTagName(‘AFFILIATE_ID’);
$email = $member->getElementsByTagName(‘EMAIL’);
$screen_name = $member->getElementsByTagName(‘SCREEN_NAME’);
$first_name = $member->getElementsByTagName(‘FIRST_NAME’);
$last_name = $member->getElementsByTagName(‘LAST_NAME’);
$photo_url = $member->getElementsByTagName(‘PHOTO_URL’);
$affiliate_id = $member->getElementsByTagName(‘AFFILIATE_ID’);
$email = $member->getElementsByTagName(‘EMAIL’);
$screen_name = $member->getElementsByTagName(‘SCREEN_NAME’);
$first_name = $member->getElementsByTagName(‘FIRST_NAME’);
$last_name = $member->getElementsByTagName(‘LAST_NAME’);
$photo_url = $member->getElementsByTagName(‘PHOTO_URL’);
echo $id->item(0)->firstChild->nodeValue . ‘
’;
echo $affiliate_id->item(0)->firstChild->nodeValue . ‘
’;
echo $email->item(0)->firstChild->nodeValue . ‘
’;
echo $screen_name->item(0)->firstChild->nodeValue . ‘
’;
echo $first_name->item(0)->firstChild->nodeValue . ‘
’;
echo $last_name->item(0)->firstChild->nodeValue . ‘
’;
echo $photo_url->item(0)->firstChild->nodeValue . ‘
’;
echo ‘
’;
}
}
?>
