bi.api.get
Description
Returns all data for this BI API Key.
HTTP Request Method: GET
Required Permission: bi.api - Get
Arguments
Example Response
< ?xml version = "1.0" encoding="UTF-8"?>
<API>
<KEY>11111111</KEY>
<STATUS>Active</STATUS>
<EXPIRATION_DATE>11/12/2008 9:21:47 AM</EXPIRATION_DATE>
<COMPANY_NAME><![CDATA[Brightidea]]></COMPANY_NAME>
<ROW_LIMIT>1000</ROW_LIMIT>
<CALL_LIMIT>300</CALL_LIMIT>
</API>
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
Example Response
< ?xml version = "1.0" encoding="UTF-8"?>
<AFFILIATES>
<AFFILIATE>
<ID>OD111</ID>
<NAME><![CDATA[Test Affiliate]]></NAME>
<LOGIN_URL><![CDATA[http://www.brightidea.com/ondemand/welcome.asp?a=OD111]]></LOGIN_URL>
</AFFILIATE>
</AFFILIATES>
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"?>
<API_CALLS>
<API_CALL>
<FUNCTION>bi.api.get</FUNCTION>
<RETURN_STATUS>success</RETURN_STATUS>
<DATE>11/12/2008 9:21:47 AM</DATE>
</API_CALL>
</API_CALLS>
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
Example Response
< ?xml version = "1.0" encoding="UTF-8"?>
<PERMISSIONS>
<PERMISSION>
<NAME>bi.api - Get</NAME>
</PERMISSION>
</PERMISSIONS>
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"?>
<AFFILIATE>
<ID>OD111</ID>
<NAME><![CDATA[Test Affiliate]]></NAME>
<LOGIN_URL><![CDATA[http://www.brightidea.com/ondemand/welcome.asp?a=OD111]]></LOGIN_URL>
</AFFILIATE>
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"?>
<AFFILIATE>
<ID>OD111</ID>
<NAME><![CDATA[Test Affiliate]]></NAME>
<LOGIN_URL><![CDATA[http://www.brightidea.com/ondemand/welcome.asp?a=OD111]]></LOGIN_URL>
</AFFILIATE>
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"?>
<BLOGS>
<BLOG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<TOPIC_ID>11111111-1111-1111-1111-111111111111</TOPIC_ID>
<TITLE><![CDATA[Title of the new blog.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new blog.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_blog.bix?c=11111111-1111-1111-1111-111111111111&bID=11111111-1111-1111-1111-111111111111]]></URL>
</BLOG>
</BLOGS>
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"?>
<TAGS>
<TAG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>TestTag</NAME>
<DATE>11/12/2008 9:21:47 AM</DATE>
<BLOG_ID>11111111-1111-1111-1111-111111111111</BLOG_ID>
</TAG>
</TAGS>
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"?>
<CAMPAIGNS>
<CAMPAIGN>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME><![CDATA[Test Campaign]]></NAME>
<DATE>11/12/2008 9:21:47 AM</DATE>
<END_DATE>11/12/2008 9:21:47 AM</END_DATE>
<ACTIVE>1</ACTIVE>
<LOGIN_URL><![CDATA[http://www.brightidea.com/ct/ct_login.bix?c=11111111-1111-1111-1111-111111111111]]></LOGIN_URL>
<DESCRIPTION>This is a test campaign</DESCRIPTION>
<CREATOR_ID>11111111-1111-1111-1111-111111111111</CREATOR_ID>
<CREATOR_NAME>Test User</CREATOR_NAME>
<SPONSOR_ID>11111111-1111-1111-1111-111111111111</SPONSOR_ID>
<SPONSOR_NAME>Test User</SPONSOR_NAME>
<PRIVACY>Private</PRIVACY>
</CAMPAIGN>
</CAMPAIGNS>
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"?>
<STATUSES>
<STATUS>
<ID>11111111-1111-1111-1111-111111111111</ID>
<CAMPAIGN_ID>11111111-1111-1111-1111-111111111111</CAMPAIGN_ID>
<NAME>Test Status</NAME>
</STATUS>
</STATUSES>
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"?>
<CATEGORIES>
<CATEGORY>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>Test Category</NAME>
<DATE>11/12/2008 9:21:47 AM</DATE>
<CAMPAIGN_ID>11111111-1111-1111-1111-111111111111</CAMPAIGN_ID>
</CATEGORY>
</CATEGORIES>
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"?>
<IDEAS>
<IDEA>
<ID>11111111-1111-1111-1111-111111111111</ID>
<CODE>D101</CODE>
<CAMPAIGN_ID>11111111-1111-1111-1111-111111111111</CAMPAIGN_ID>
<SCORE>3</SCORE>
<TITLE><![CDATA[Title of the new idea.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new idea.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<DATE_MODIFIED>11/12/2008 9:21:47 AM</DATE_MODIFIED>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<CATEGORY_ID>11111111-1111-1111-1111-111111111111</CATEGORY_ID>
<STATUS_ID>11111111-1111-1111-1111-111111111111</STATUS_ID>
<ANONYMOUS>False</ANONYMOUS>
<VISIBLE>True</VISIBLE>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_idea.bix?c=11111111-1111-1111-1111-111111111111&idea_id=11111111-1111-1111-1111-111111111111]]></URL>
<TEAM_MEMBERS>
<TEAM_MEMBER>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</TEAM_MEMBER>
<TEAM_MEMBER>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</TEAM_MEMBER>
<TEAM_MEMBER>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</TEAM_MEMBER>
</TEAM_MEMBERS>
</IDEA>
</IDEAS>
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getIdeaChipVoteList
Description
Get a list of exising idea chip votes under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.vote - Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > '11/23/09' ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
a (Affiliate ID): Required
This is the ID (i.e. OD111) of the affiliate.
Example Response
< ?xml version = "1.0" encoding="UTF-8"?>
<CHIP_VOTES>
<CHIP_VOTE>
<CHIPS>1</CHIPS>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</CHIP_VOTE>
</CHIP_VOTES>
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"?>
<TAGS>
<TAG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>TestTag</NAME>
<DATE>11/12/2008 9:21:47 AM</DATE>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
</TAG>
</TAGS>
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"?>
<VIEWS>
<VIEW>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</VIEW>
</VIEWS>
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"?>
<VOTES>
<VOTE>
<TYPE>Promote</TYPE>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</VOTE>
</VOTES>
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"?>
<MEMBERS>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
</MEMBERS>
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"?>
<LOGINS>
<LOGIN>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>11/12/2008 9:21:47 AM</DATE>
</LOGIN>
</LOGINS>
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"?>
<TRANSACTIONS>
<TRANSACTION>
<ID>11111111-1111-1111-1111-111111111111</ID>
<CAMPAIGN_ID>11111111-1111-1111-1111-111111111111</CAMPAIGN_ID>
<MEMBER_ID_GIVER>11111111-1111-1111-1111-111111111111</MEMBER_ID_GIVER>
<MEMBER_ID_RECEIVER>11111111-1111-1111-1111-111111111111</MEMBER_ID_RECEIVER>
<TYPE>PROMOTE_IDEA</TYPE>
<DATE>11/12/2008 9:21:47 AM</DATE>
<REFERENCE_ID>11111111-1111-1111-1111-111111111111</REFERENCE_ID>
<POINTS>3</POINTS>
</TRANSACTION>
</TRANSACTIONS>
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"?>
<PROJECTS>
<PROJECT>
<ID>11111111-1111-1111-1111-111111111111</ID>
<PROCESS_ID>11111111-1111-1111-1111-111111111111</PROCESS_ID>
<TITLE><![CDATA[Title of the project.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the project.]]></DESCRIPTION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</PROJECT>
</PROJECTS>
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"?>
<STAGES>
<STAGE>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>Test Stage</NAME>
</STAGE>
</STAGES>
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"?>
<STATUSES>
<STATUS>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>Test Status</NAME>
</STATUS>
</STATUSES>
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"?>
<STATUSES>
<STATUS>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>Test Status</NAME>
</STATUS>
</STATUSES>
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"?>
<TWORKS>
<TWORK>
<ID>11111111-1111-1111-1111-111111111111</ID>
<BODY><![CDATA[Test Twork]]></BODY>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</TWORK>
</TWORKS>
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"?>
<BUSINESS_UNITS>
<BUSINESS_UNIT>
<ID>11111111-1111-1111-1111-111111111111</ID>
<ENTERPRISE_ID>11111111-1111-1111-1111-111111111111</ENTERPRISE_ID>
<GROUP_ID>11111111-1111-1111-1111-111111111111</GROUP_ID>
<UNIT_ID>11111111-1111-1111-1111-111111111111</UNIT_ID>
<NAME>Name</NAME>
<TYPE>Type</TYPE>
<DATE>11/12/2008 9:21:47 AM</DATE>
</BUSINESS_UNIT>
</BUSINESS_UNITS>
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"?>
<MEMBERS>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
</MEMBERS>
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"?>
<GROUPS>
<GROUP>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>Name</NAME>
<DATE>11/12/2008 9:21:47 AM</DATE>
</GROUP>
</GROUPS>
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"?>
<POOLS>
<POOL>
<ID>11111111-1111-1111-1111-111111111111</ID>
<TITLE>Title</TITLE>
<IDEA_COUNT>10</IDEA_COUNT>
</POOL>
</POOLS>
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"?>
<PROPOSALS>
<PROPOSAL>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME><![CDATA[Test Proposal]]></NAME>
<DESCRIPTION><![CDATA[Test Proposal Description]]></DESCRIPTION>
<CREATION_DATE>8/29/2008 12:05:29 PM</CREATION_DATE>
<OWNER>User Name</OWNER>
<STATUS>Test Status</STATUS>
<CUSTOM_STATUS>Test Custom Status</CUSTOM_STATUS>
<SCORE>100</SCORE>
<ADDITIONAL_DATA>
<DATA_ITEM>
<FIELD>Field Title</FIELD>
<DATA>Field Data</DATA>
</DATA_ITEM>
</ADDITIONAL_DATA>
</PROPOSAL>
</PROPOSALS>
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"?>
<IDEA>
<ID>11111111-1111-1111-1111-111111111111</ID>
<CODE>D101</CODE>
<SCORE>3</SCORE>
<TITLE><![CDATA[Title of the new idea.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new idea.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<DATE_MODIFIED>11/12/2008 9:21:47 AM</DATE_MODIFIED>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<CATEGORY_ID>11111111-1111-1111-1111-111111111111</CATEGORY_ID>
<STATUS_ID>11111111-1111-1111-1111-111111111111</STATUS_ID>
<ANONYMOUS>False</ANONYMOUS>
<VISIBLE>True</VISIBLE>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_idea.bix?c=11111111-1111-1111-1111-111111111111&idea_id=11111111-1111-1111-1111-111111111111]]></URL>
<TEAM_MEMBERS>
<TEAM_MEMBER>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</TEAM_MEMBER>
<TEAM_MEMBER>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</TEAM_MEMBER>
<TEAM_MEMBER>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</TEAM_MEMBER>
</TEAM_MEMBERS>
</IDEA>
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.getFile.getFile
Description
Returns the attachment file by file ID.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea - Get
Arguments
file_id (File ID): Required
This is the ID (i.e. OD111) of the file.
thumb (Thumbnail size): Optional
This is the thumbnail size of the file (i.e. 50).
Example Response
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid affiliate id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.getProject2MilestoneList
Description
Returns a list of milestones of all projects under a given affiliate.
HTTP Request Method: GET
Required Permission: bi.affiliate.getProject2MilestoneList - Get
Arguments
a (Affiliate ID): Required
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > '11/23/09' ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
Example Response
< ?xml version = "1.0" encoding="UTF-8"?>
<MILESTONES>
<MILESTONE>
<ID>11111111-1111-1111-1111-111111111111</ID>
<TITLE><![CDATA[New Milestone 001]]></TITLE>
<DESCRIPTION><![CDATA[Test User]]></DESCRIPTION>
<DUE_DATE>8/29/2008</DUE_DATE>
<COMPLETION_DATE>8/29/2008</COMPLETION_DATE>
<RELATED_TO_DO_COUNT>![CDATA[Related To Do's count goes here.]]</RELATED_TO_DO_COUNT>
<RELATED_TO_DO_COUNT_TOTAL>![CDATA[Total Related To Do's count goes here.]]</RELATED_TO_DO_COUNT_TOTAL>
<RELATED_TO_DO_COUNT_OPEN><![CDATA[Open To Do's count goes here.]]></RELATED_TO_DO_COUNT_OPEN>
<RELATED_TO_DO_COUNT_CLOSED><![CDATA[Completed To Do's count goes here.]]></RELATED_TO_DO_COUNT_CLOSED>
</MILESTONE>
</MILESTONES>
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
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"?>
<PROJECT_MEMBERS>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>11111111-1111-1111-1111-111111111111</TITLE>
<EMAIL>![CDATA[member's email id goes here]]</EMAIL>
<SCREEN_NAME>![CDATA[Member's screen name goes here.]]</DUE_DATE>
<FIRST_NAME>![CDATA[Member's first name goes here.]]</FIRST_NAME>
<LAST_NAME>![CDATA[Member's last name goes here.]]</LAST_NAME>
<PHOTO_URL>![CDATA[Member's photo url goes here.]]</PHOTO_URL>
<JOB_TITLE><![CDATA[Member's job name goes here.]]></JOB_TITLE>
<WORK_HISTORY><![CDATA[Member's work history goes here.]]></WORK_HISTORY>
<SKILLS><![CDATA[Member's skills goes here.]]></SKILLS>
<MOBILE_PHONE>1111111111111</MOBILE_PHONE>
<ADDRESS><![CDATA[Member's address goes here.]]></ADDRESS>
<PHONE>1111111111111</PHONE>
<DATE>11/12/2012</DATE>
<DATE_MODIFIED>11/12/2012</DATE_MODIFIED>
<EMPLOYEE_ID>1111111111111</EMPLOYEE_ID>
<ACTIVE>1111111111111</ACTIVE>
</MEMBER>
</PROJECT_MEMBERS>
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
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"?>
<PROJECT_INVESTMENTS>
<INVESTMENT>
<ID>11111111-1111-1111-1111-111111111111</ID>
<TITLE>![CDATA[Investment title goes here]]</TITLE>
<AMOUNT>100</AMOUNT>
<TIME>100</TIME>
<DESCRIPTION><![CDATA[Investment description goes here goes here.]]></DESCRIPTION>
</INVESTMENT>
</PROJECT_INVESTMENTS>
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"?>
<PROJECTS_INVESTMENTS>
<INVESTMENT>
<ID>11111111-1111-1111-1111-111111111111</ID>
<TITLE>![CDATA[Investment title goes here]]</TITLE>
<AMOUNT>100</AMOUNT>
<TIME>100</TIME>
<DESCRIPTION><![CDATA[Investment description goes here goes here.]]></DESCRIPTION>
</INVESTMENT>
</PROJECTS_INVESTMENTS>
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"?>
<PROJECTIONS>
<PROJECTION>
<ID>11111111-1111-1111-1111-111111111111</ID>
<YEAR_1_LOW><100></YEAR_1_LOW>
<YEAR_1_HIGH><100></YEAR_1_HIGH>
<YEAR_2_LOW>100</YEAR_2_LOW>
<YEAR_2_HIGH>100</YEAR_2_HIGH>
<YEAR_3_LOW>100</YEAR_3_LOW>
<YEAR_3_HIGH>100</YEAR_3_HIGH>
<LAST_UPDATED><8/29/2008></LAST_UPDATED>
</PROJECTION>
</PROJECTIONS>
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"?>
<PROJECT_INFORMATION>
<PROJECT_INFO>
<ID>11111111-1111-1111-1111-111111111111</ID>
<TITLE>[CDATA[Title goes here]]</TITLE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DESCRIPTION><![CDATA[ Description goes here .]]></DESCRIPTION>
<DATE>2011-01-08 9:36:42 PM </DATE>
<LAUNCH_DATE>< 2011-01-08 ></LAUNCH_DATE>
<COMPLETION_TARGET_DATE><![CDATA[ 2011-01-08 ]]></COMPLETION_TARGET_DATE>
<STATUS><![CDATA[Status goes here.]]></STATUS>
<VISIBILITY><![CDATA[ Visibility goes here .]]></VISIBILITY>
<MILESTONE_COUNT_TOTAL>100</MILESTONE_COUNT_TOTAL>
<MILESTONE_COUNT_OPEN>100</MILESTONE_COUNT_TOTAL>
<MILESTONE_COUNT_CLOSED>100</MILESTONE_COUNT_TOTAL>
<DOCUMENT_COUNT>100</DOCUMENT_COUNT>
</PROJECT_INFO>
</PROJECT_INFORMATION>
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"?>
<RESULTS>
<RESULT>
<RESULT_ID>11111111-1111-1111-1111-111111111111</RESULT_ID>
<TYPE><Revenue/Cost Savings/Note></TYPE>
<AMOUNT><$10,000.00></AMOUNT>
<DESCRIPTION>Description of this result</DESCRIPTION>
<START_DATE>1/1/2012</START_DATE>
<END_DATE>12/30/2012</END_DATE>
<NOTES_COUNT>1</NOTES_COUNT>
<NOTE_DATA><Note description data></NOTE_DATA>
<DATE_ADDED>11/14/2012</DATE_ADDED>
<ADDED_BY><XYZ User></ADDED_BY>
</RESULT>
</RESULTS>
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"?>
<ACTION_ITEMS>
<ACTION_ITEM>
<CODE>11111111-1111-1111-1111-111111111111</CODE>
<TITLE><![CDATA[New Idea 001]]></TITLE>
<ASSIGNEE_SCREEN_NAME><![CDATA[Test User]]></ASSIGNEE_SCREEN_NAME>
<ASSIGNEE_EMAIL>testuser@brightidea.com</ASSIGNEE_EMAIL>
<ASSIGNED_BY_SCREEN_NAME><![CDATA[John]]></ASSIGNED_BY_SCREEN_NAME>
<ASSIGNED_BY_EMAIL>john@brightidea.com</ASSIGNED_BY_EMAIL>
<TYPE>Scorecard/Proposal</TYPE>
<BATCH><![CDATA[Batch name goes here.]]></BATCH>
<ROUND><![CDATA[Round name goes here.]]></ROUND>
<STATUS><![CDATA[Status goes here.]]></STATUS>
<SENT_DATE>8/29/2008 12:05:29 PM</SENT_DATE>
<DUE_DATE>8/29/2008</DUE_DATE>
<COMPLETED_DATE>8/29/2008</COMPLETED_DATE>
</ACTION_ITEM>
</ACTION_ITEMS>
Errors
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"?>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
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"?>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
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"?>
<SESSION_TOKEN>11111111-1111-1111-1111-111111111111</SESSION_TOKEN>
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"?>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
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"?>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
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"?>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
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"?>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
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"?>
<AFFILIATES>
<AFFILIATE>
<ID>OD1234</ID>
<NAME><![CDATA[Test Affiliate]]></NAME>
<LOGIN_URL><![CDATA[http://www.brightidea.com/ct/ct_login.bix?c=11111111-1111-1111-1111-111111111111]]></LOGIN_URL>
</AFFILIATE>
</AFFILIATES>
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"?>
<CAMPAIGNS>
<CAMPAIGN>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME><![CDATA[Test Campaign]]></NAME>
<DATE>11/12/2008 9:21:47 AM</DATE>
<END_DATE>11/12/2008 9:21:47 AM</END_DATE>
<ACTIVE>1</ACTIVE>
<LOGIN_URL><![CDATA[http://www.brightidea.com/ct/ct_login.bix?c=11111111-1111-1111-1111-111111111111]]></LOGIN_URL>
<DESCRIPTION>This is a test campaign</DESCRIPTION>
<CREATOR_ID>11111111-1111-1111-1111-111111111111</CREATOR_ID>
<CREATOR_NAME>Test User</CREATOR_NAME>
<SPONSOR_ID>11111111-1111-1111-1111-111111111111</SPONSOR_ID>
<SPONSOR_NAME>Test User</SPONSOR_NAME>
<PRIVACY>Private</PRIVACY>
<STATE>Active</STATE>
</CAMPAIGN>
</CAMPAIGNS>
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"?>
<BLOGS>
<BLOG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<TOPIC_ID>11111111-1111-1111-1111-111111111111</TOPIC_ID>
<TITLE><![CDATA[Title of the new blog.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new blog.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_blog.bix?c=11111111-1111-1111-1111-111111111111&bID=11111111-1111-1111-1111-111111111111]]></URL>
</BLOG>
</BLOGS>
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"?>
<TAGS>
<TAG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>TestTag</NAME>
<DATE>11/12/2008 9:21:47 AM</DATE>
<BLOG_ID>11111111-1111-1111-1111-111111111111</BLOG_ID>
</TAG>
</TAGS>
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"?>
<CHIPS>
<CHIP>
<CAMPAIGN_ID>11111111-1111-1111-1111-111111111111</CAMPAIGN_ID>
<CHIP_TOTAL>200</CHIP_TOTAL>
<CHIP_LEFT>100</CHIP_LEFT>
</CHIP>
<CHIP>
<CAMPAIGN_ID>22222222-2222-2222-2222-222222222222</CAMPAIGN_ID>
<CHIP_TOTAL>400</CHIP_TOTAL>
<CHIP_LEFT>150</CHIP_LEFT>
</CHIP>
</CHIPS>
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"?>
<CHIP_VOTES>
<CHIP_VOTE>
<CHIPS>1</CHIPS>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</CHIP_VOTE>
</CHIP_VOTES>
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"?>
<IDEAS>
<IDEA>
<ID>11111111-1111-1111-1111-111111111111</ID>
<CODE>D101</CODE>
<CAMPAIGN_ID>11111111-1111-1111-1111-111111111111</CAMPAIGN_ID>
<SCORE>3</SCORE>
<TITLE><![CDATA[Title of the new idea.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new idea.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<DATE_MODIFIED>11/12/2008 9:21:47 AM</DATE_MODIFIED>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<CATEGORY_ID>11111111-1111-1111-1111-111111111111</CATEGORY_ID>
<STATUS_ID>11111111-1111-1111-1111-111111111111</STATUS_ID>
<ANONYMOUS>False</ANONYMOUS>
<VISIBLE>True</VISIBLE>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_idea.bix?c=11111111-1111-1111-1111-111111111111&idea_id=11111111-1111-1111-1111-111111111111]]></URL>
</IDEA>
</IDEAS>
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"?>
<TAGS>
<TAG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>TestTag</NAME>
<DATE>11/12/2008 9:21:47 AM</DATE>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
</TAG>
</TAGS>
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"?>
<VIEWS>
<VIEW>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</VIEW>
</VIEWS>
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"?>
<VOTES>
<VOTE>
<TYPE>Promote</TYPE>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</VOTE>
</VOTES>
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"?>
<LOGINS>
<LOGIN>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</LOGIN>
</LOGINS>
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"?>
<TRANSACTIONS>
<TRANSACTION>
<ID>11111111-1111-1111-1111-111111111111</ID>
<CAMPAIGN_ID>11111111-1111-1111-1111-111111111111</CAMPAIGN_ID>
<MEMBER_ID_GIVER>11111111-1111-1111-1111-111111111111</MEMBER_ID_GIVER>
<MEMBER_ID_RECEIVER>11111111-1111-1111-1111-111111111111</MEMBER_ID_RECEIVER>
<TYPE>PROMOTE_IDEA</TYPE>
<DATE>11/12/2008 9:21:47 AM</DATE>
<REFERENCE_ID>11111111-1111-1111-1111-111111111111</REFERENCE_ID>
<POINTS>3</POINTS>
</TRANSACTION>
</TRANSACTIONS>
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"?>
<TWORKS>
<TWORK>
<ID>11111111-1111-1111-1111-111111111111</ID>
<BODY><![CDATA[Test Twork]]></BODY>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<ATTACHMENT_ID>11111111-1111-1111-1111-111111111111</ATTACHMENT_ID>
</TWORK>
</TWORKS>
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"?>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
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"?>
<ACTION_ITEMS>
<ACTION_ITEM>
<ID>11111111-1111-1111-1111-111111111111</ID>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE_ASSIGNED>11/12/2008 9:21:47 AM</DATE_ASSIGNED>
<ACTION>Test action</ACTION>
<STATUS_ID>11111111-1111-1111-1111-111111111111</STATUS_ID>
<STATUS_NAME>Test Status</STATUS_NAME>
</ACTION_ITEM>
</ACTION_ITEMS>
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: POST
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"?>
<ACTIVITIES>
<ACTIVITY>
<TYPE>PROMOTE_IDEA</TYPE>
<TRANSACTION_ID>11111111-1111-1111-1111-111111111111</TRANSACTION_ID>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<CAMPAIGN_ID>11111111-1111-1111-1111-111111111111</CAMPAIGN_ID>
<CAMPAIGN_NAME>Test Campaign</CAMPAIGN_NAME>
<IDEA_TITLE><![CDATA[Test Idea Title]]></IDEA_TITLE>
<DATE>11/12/2008 9:21:47 AM</DATE>
<SCREEN_NAME><![CDATA[Test Idea Title]]></SCREEN_NAME>
<SUBMITTER>11111111-1111-1111-1111-111111111111</SUBMITTER>
<PHOTO><![CDATA[getfile.bix?a=OD1069&f=3996ABFD-616B-4441-8062-240406CE38A1&thumb=50]]></PHOTO>
<IDEA_SCREEN_NAME>Test Status</IDEA_SCREEN_NAME>
</ACTIVITY>
</ACTIVITIES>
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"?>
<TWORK>20</TWORK>
<NEW_ITEMS>
<CAMPAIGN>
<CAMPAIGN_ID>11111111-1111-1111-1111-111111111111</CAMPAIGN_ID>
<COUNT>20</COUNT>
</CAMPAIGN>
<IDEA>11</IDEA>
<ACTIVITY_TOTAL>11</ACTIVITY_TOTAL>
</NEW_ITEMS>
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"?>
<STATUS>Success</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.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"?>
<TRANSACTION>
<ID>11111111-1111-1111-1111-111111111111</ID>
<CAMPAIGN_ID>11111111-1111-1111-1111-111111111111</CAMPAIGN_ID>
<MEMBER_ID_GIVER>11111111-1111-1111-1111-111111111111</MEMBER_ID_GIVER>
<MEMBER_ID_RECEIVER>11111111-1111-1111-1111-111111111111</MEMBER_ID_RECEIVER>
<TYPE>PROMOTE_IDEA</TYPE>
<DATE>11/12/2008 9:21:47 AM</DATE>
<REFERENCE_ID>11111111-1111-1111-1111-111111111111</REFERENCE_ID>
<POINTS>3</POINTS>
</TRANSACTION>
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"?>
<CAMPAIGN>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME><![CDATA[Test Campaign]]></NAME>
<LOGIN_URL><![CDATA[http://www.brightidea.com/ct/ct_login.bix?c=11111111-1111-1111-1111-111111111111]]></LOGIN_URL>
</CAMPAIGN>
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"?>
<CAMPAIGN>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME><![CDATA[Test Campaign]]></NAME>
<LOGIN_URL><![CDATA[http://www.brightidea.com/ct/ct_login.bix?c=11111111-1111-1111-1111-111111111111]]></LOGIN_URL>
</CAMPAIGN>
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"?>
<CAMPAIGN>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME><![CDATA[Test Campaign]]></NAME>
<DATE>11/12/2008 9:21:47 AM</DATE>
<END_DATE>11/12/2008 9:21:47 AM</END_DATE>
<ACTIVE>1</ACTIVE>
<LOGIN_URL><![CDATA[http://www.brightidea.com/ct/ct_login.bix?c=11111111-1111-1111-1111-111111111111]]></LOGIN_URL>
<DESCRIPTION>This is a test campaign</DESCRIPTION>
<CREATOR_ID>11111111-1111-1111-1111-111111111111</CREATOR_ID>
<CREATOR_NAME>Test User</CREATOR_NAME>
<SPONSOR_ID>11111111-1111-1111-1111-111111111111</SPONSOR_ID>
<SPONSOR_NAME>Test User</SPONSOR_NAME>
<PRIVACY>Private</PRIVACY>
</CAMPAIGN>
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"?>
<BLOGS>
<BLOG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<TOPIC_ID>11111111-1111-1111-1111-111111111111</TOPIC_ID>
<TITLE><![CDATA[Title of the new blog.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new blog.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_blog.bix?c=11111111-1111-1111-1111-111111111111&bID=11111111-1111-1111-1111-111111111111]]></URL>
</BLOG>
</BLOGS>
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"?>
<TAGS>
<TAG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>TestTag</NAME>
<DATE>11/12/2008 9:21:47 AM</DATE>
<BLOG_ID>11111111-1111-1111-1111-111111111111</BLOG_ID>
</TAG>
</TAGS>
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"?>
<CATEGORIES>
<CATEGORY>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>Test Category</NAME>
<DATE>11/12/2008 9:21:47 AM</DATE>
</CATEGORY>
</CATEGORIES>
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
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
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"?>
<IDEAS>
<IDEA>
<ID>11111111-1111-1111-1111-111111111111</ID>
<CODE>D101</CODE>
<SCORE>3</SCORE>
<TITLE><![CDATA[Title of the new idea.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new idea.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<DATE_MODIFIED>11/12/2008 9:21:47 AM</DATE_MODIFIED>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<CATEGORY_ID>11111111-1111-1111-1111-111111111111</CATEGORY_ID>
<CATEGORY_NAME>Test Category</CATEGORY_NAME>
<STATUS_ID>11111111-1111-1111-1111-111111111111</STATUS_ID>
<STATUS_NAME>Test Status</STATUS_NAME>
<ANONYMOUS>False</ANONYMOUS>
<VISIBLE>True</VISIBLE>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_idea.bix?c=11111111-1111-1111-1111-111111111111&idea_id=11111111-1111-1111-1111-111111111111]]></URL>
<COMMENT_COUNT>1</COMMENT_COUNT>
</IDEA>
</IDEAS>
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid campaign id.
Required data not supplied.
Invalid SQL query.
bi.affiliate.campaign.getIdeaChipVoteList
Description
Returns a list of idea chip votes under a given campaign.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.idea.vote - Get
Arguments
q (SQL query): Optional
An SQL style query which accepts the WHERE, ORDER BY and LIMIT syntax. (WHERE date > '11/23/09' ORDER BY date DESC LIMIT 5, 10). Passing COUNT will return the total row count for this table instead of the data.
c (Campaign ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the campaign.
Example Response
< ?xml version = "1.0" encoding="UTF-8"?>
<CHIP_VOTES>
<CHIP_VOTE>
<CHIPS>1</CHIPS>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</CHIP_VOTE>
</CHIP_VOTES>
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"?>
<TAGS>
<TAG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>TestTag</NAME>
<DATE>11/12/2008 9:21:47 AM</DATE>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
</TAG>
</TAGS>
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"?>
<VIEWS>
<VIEW>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</VIEW>
</VIEWS>
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"?>
<VOTES>
<VOTE>
<TYPE>Promote</TYPE>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</VOTE>
</VOTES>
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"?>
<ATTACHMENTS>
<ATTACHMENT>
<ID>11111111-1111-1111-1111-111111111111</ID>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<FILENAME><![CDATA[FileName.jpg]]</FILENAME>
<TYPE>public</TYPE>
<URL><![CDATA[http://www.brightidea.com/ct/getfile.bix?a=OD000&f=11111111-1111-1111-1111-111111111111]]</URL>
</ATTACHMENT>
</ATTACHMENTS>
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"?>
<IDEAS>
<IDEA>
<ID>11111111-1111-1111-1111-111111111111</ID>
<SCORE>3</SCORE>
<TITLE><![CDATA[Title of the new idea.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new idea.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<DATE_MODIFIED>11/12/2008 9:21:47 AM</DATE_MODIFIED>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<CATEGORY_ID>11111111-1111-1111-1111-111111111111</CATEGORY_ID>
<STATUS_ID>11111111-1111-1111-1111-111111111111</STATUS_ID>
<ANONYMOUS>False</ANONYMOUS>
<QUESTION_ANSWERS>
<QUESTION>
<QUESTION_ID>11111111-1111-1111-1111-111111111111</QUESTION_ID>
<QUESTION>Sample Question</QUESTION>
<QUESTION_DESCRIPTION>Sample Description</QUESTION_DESCRIPTION>
<ANSWER_ID>11111111-1111-1111-1111-111111111111</ANSWER_ID>
<ANSWER>Sample Answer</ANSWER>
</QUESTION>
<FORM_ID>11111111-1111-1111-1111-111111111111</FORM_ID>
</QUESTION_ANSWERS>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_idea.bix?c=11111111-1111-1111-1111-111111111111&idea_id=11111111-1111-1111-1111-111111111111]]></URL>
</IDEA>
</IDEAS>
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"?>
<TRANSACTIONS>
<TRANSACTION>
<ID>11111111-1111-1111-1111-111111111111</ID>
<CAMPAIGN_ID>11111111-1111-1111-1111-111111111111</CAMPAIGN_ID>
<MEMBER_ID_GIVER>11111111-1111-1111-1111-111111111111</MEMBER_ID_GIVER>
<MEMBER_ID_RECEIVER>11111111-1111-1111-1111-111111111111</MEMBER_ID_RECEIVER>
<TYPE>PROMOTE_IDEA</TYPE>
<DATE>11/12/2008 9:21:47 AM</DATE>
<REFERENCE_ID>11111111-1111-1111-1111-111111111111</REFERENCE_ID>
<POINTS>3</POINTS>
</TRANSACTION>
</TRANSACTIONS>
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"?>
<STATUSES>
<STATUS>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>Test Status</NAME>
</STATUS>
</STATUSES>
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"?>
<GROUP>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>Test Group Name</NAME>
<DATE>8/29/2008 12:05:29 PM</DATE>
</GROUP>
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"?>
<GROUPS>
<GROUP>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>Test Group</NAME>
<DATE>8/29/2008 12:05:29 PM</DATE>
</GROUP>
</GROUPS>
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"?>
<EVALUATION_TEAMS>
<EVALUATION_TEAM>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>Test Team</NAME>
</EVALUATION_TEAM>
</EVALUATION_TEAMS>
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"?>
<MEMBERS>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
</MEMBERS>
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.campaign.getTransactionPointList
Description
Returns a list of transaction point settings.
HTTP Request Method: GET
Required Permission: bi.affiliate.campaign.transaction - 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"?>
<TRANSACTION_POINTS>
<TRANSACTION_POINT>
<DESCRIPTION>Register</DESCRIPTION>
<POINT>3</POINT>
<TYPE>REGISTER_POINTS</TYPE>
</TRANSACTION_POINT>
</TRANSACTION_POINTS>
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.campaign.setTransactionPoint
Description
Set transaction point for a given campaign.
HTTP Request Method: POST
Required Permission: bi.affiliate.campaign.transaction - Set
Arguments
transaction_type (Transaction type): Required
The transaction type needs to be updated (i.e. REGISTER_POINTS). A complete list of all the types can be returned from the bi.affiliate.campaign.getTransactionPointList API
point (Point): Required
This is the point to be set.
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"?>
<TRANSACTION_POINT>
<DESCRIPTION>Register</DESCRIPTION>
<POINT>3</POINT>
<TYPE>REGISTER_POINTS</TYPE>
</TRANSACTION_POINT>
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"?>
<CATEGORY>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>Test Category</NAME>
<DATE>11/12/2008 9:21:47 AM</DATE>
</CATEGORY>
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"?>
<CATEGORY>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>Test Category</NAME>
<DATE>11/12/2008 9:21:47 AM</DATE>
</CATEGORY>
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid category id.
Required data not supplied.
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"?>
<STATUS>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>Test Status</NAME>
</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"?>
<STATUS>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>Test Status</NAME>
</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"?>
<TWORK>
<ID>11111111-1111-1111-1111-111111111111</ID>
<BODY><![CDATA[Test Twork]]></BODY>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</TWORK>
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"?>
<TWORK>
<ID>11111111-1111-1111-1111-111111111111</ID>
<BODY><![CDATA[Test Twork]]></BODY>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</TWORK>
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.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"?>
<TWORK>
<ID>11111111-1111-1111-1111-111111111111</ID>
<BODY><![CDATA[Test Twork]]></BODY>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</TWORK>
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"?>
<BLOG_TOPIC>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME><![CDATA[Name of the new blog topic.]]></NAME>
<DESCRIPTION><![CDATA[Description of the new blog topic.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</BLOG_TOPIC>
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"?>
<BLOG_TOPIC>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME><![CDATA[Name of the new blog topic.]]></NAME>
<DESCRIPTION><![CDATA[Description of the new blog topic.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</BLOG_TOPIC>
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"?>
<BLOGS>
<BLOG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<TOPIC_ID>11111111-1111-1111-1111-111111111111</TOPIC_ID>
<TITLE><![CDATA[Title of the new blog.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new blog.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_blog.bix?c=11111111-1111-1111-1111-111111111111&bID=11111111-1111-1111-1111-111111111111]]></URL>
</BLOG>
</BLOGS>
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"?>
<BLOG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<TOPIC_ID>11111111-1111-1111-1111-111111111111</TOPIC_ID>
<TITLE><![CDATA[Title of the new blog.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new blog.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_blog.bix?c=11111111-1111-1111-1111-111111111111&bID=11111111-1111-1111-1111-111111111111]]></URL>
</BLOG>
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"?>
<BLOG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<TOPIC_ID>11111111-1111-1111-1111-111111111111</TOPIC_ID>
<TITLE><![CDATA[Title of the new blog.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new blog.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_blog.bix?c=11111111-1111-1111-1111-111111111111&bID=11111111-1111-1111-1111-111111111111]]></URL>
</BLOG>
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.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"?>
<TAGS>
<TAG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>TestTag</NAME>
</TAG>
</TAGS>
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:
<QUESTION_ITEMS>
<QUESTION_ITEM>
<ID>11111111-1111-1111-1111-111111111111</ID>
<BODY>Answer to this question</BODY>
</QUESTION_ITEM>
</QUESTION_ITEMS>
Example Response
< ?xml version = "1.0" encoding="UTF-8"?>
<IDEA>
<ID>11111111-1111-1111-1111-111111111111</ID>
<SCORE>3</SCORE>
<TITLE><![CDATA[Title of the new idea.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new idea.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<CATEGORY_ID>11111111-1111-1111-1111-111111111111</CATEGORY_ID>
<STATUS_ID>11111111-1111-1111-1111-111111111111</STATUS_ID>
<ANONYMOUS>False</ANONYMOUS>
<VISIBLE>True</VISIBLE>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_idea.bix?c=11111111-1111-1111-1111-111111111111&idea_id=11111111-1111-1111-1111-111111111111]]></URL>
</IDEA>
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:
<QUESTION_ITEMS>
<QUESTION_ITEM>
<ID>11111111-1111-1111-1111-111111111111</ID>
<BODY>Answer to this question</BODY>
</QUESTION_ITEM>
</QUESTION_ITEMS>
Example Response
< ?xml version = "1.0" encoding="UTF-8"?>
<IDEA>
<ID>11111111-1111-1111-1111-111111111111</ID>
<SCORE>3</SCORE>
<TITLE><![CDATA[Title of the new idea.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new idea.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<CATEGORY_ID>11111111-1111-1111-1111-111111111111</CATEGORY_ID>
<STATUS_ID>11111111-1111-1111-1111-111111111111</STATUS_ID>
<ANONYMOUS>False</ANONYMOUS>
<VISIBLE>True</VISIBLE>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_idea.bix?c=11111111-1111-1111-1111-111111111111&idea_id=11111111-1111-1111-1111-111111111111]]></URL>
</IDEA>
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"?>
<IDEA>
<ID>11111111-1111-1111-1111-111111111111</ID>
<CODE>D101</CODE>
<SCORE>3</SCORE>
<TITLE><![CDATA[Title of the new idea.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new idea.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<DATE_MODIFIED>11/12/2008 9:21:47 AM</DATE_MODIFIED>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<CATEGORY_ID>11111111-1111-1111-1111-111111111111</CATEGORY_ID>
<STATUS_ID>11111111-1111-1111-1111-111111111111</STATUS_ID>
<ANONYMOUS>False</ANONYMOUS>
<VISIBLE>True</VISIBLE>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_idea.bix?c=11111111-1111-1111-1111-111111111111&idea_id=11111111-1111-1111-1111-111111111111]]></URL>
<TEAM_MEMBERS>
<TEAM_MEMBER>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</TEAM_MEMBER>
<TEAM_MEMBER>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</TEAM_MEMBER>
<TEAM_MEMBER>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
</TEAM_MEMBER>
</TEAM_MEMBERS>
</IDEA>
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Invalid idea id.
Required data not supplied.
bi.affiliate.campaign.idea.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"?>
<CHIP_VOTES>
<CHIP_VOTE>
<CHIPS>1</CHIPS>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</CHIP_VOTE>
</CHIP_VOTES>
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"?>
<EVALUATIONS>
<EVALUATION>
<FORM_ID>11111111-1111-1111-1111-111111111111</FORM_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<SCORE>11111111-1111-1111-1111-111111111111</SCORE>
<EVALUATION_FORM>
<EVALUATION_QUESTION>
<QUESTION>
<ID>11111111-1111-1111-1111-111111111111</ID>
<BODY>Test Body</BODY>
</QUESTION>
<ANSWER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<BODY>Test Body</BODY>
</ANSWER>
</EVALUATION_QUESTION>
</EVALUATION_FORM>
</EVALUATION>
</EVALUATIONS>
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"?>
<HISTORY_RECORDS>
<HISTORY_RECORD>
<ID>11111111-1111-1111-1111-111111111111</ID>
<DATE>11/12/2008 9:21:47 AM</DATE>
<ACTION><![CDATA[Test Action]]></ACTION>
</HISTORY_RECORD>
</HISTORY_RECORDS>
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"?>
<TAGS>
<TAG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>TestTag</NAME>
</TAG>
</TAGS>
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"?>
<VIEWS>
<VIEW>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</VIEW>
</VIEWS>
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"?>
<VOTES>
<VOTE>
<TYPE>Promote</TYPE>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</VOTE>
</VOTES>
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"?>
<IDEA>
<ID>11111111-1111-1111-1111-111111111111</ID>
<TITLE><![CDATA[Title of the new idea.]]></TITLE>
<DESCRIPTION><![CDATA[Description of the new idea.]]></DESCRIPTION>
<DATE>11/12/2008 9:21:47 AM</DATE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<MEMBER_NAME><![CDATA[Test User]]></MEMBER_NAME>
<CATEGORY_ID>11111111-1111-1111-1111-111111111111</CATEGORY_ID>
<STATUS_ID>11111111-1111-1111-1111-111111111111</STATUS_ID>
<ANONYMOUS>False</ANONYMOUS>
<URL><![CDATA[http://www.brightidea.com/ct/ct_a_view_idea.bix?c=11111111-1111-1111-1111-111111111111&idea_id=11111111-1111-1111-1111-111111111111]]></URL>
</IDEA>
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"?>
<SCORECARDS>
<SCORECARD>
<SCORECARD_TEMPLATE> General Evaluaton</SCORECARD_TEMPLATE>
<SCORECARD_TEMPLATE_ID> 11111111-1111-1111-1111-111111111111 </SCORECARD_TEMPLATE_ID>
<BATCHES>
<BATCH>
<BATCH_ID> 11111111-1111-1111-1111-111111111111 </BATCH_ID>
<NAME> Batch1 </NAME>
<ROUNDS>
<ROUND>
<ROUND_ID> 11111111-1111-1111-1111-111111111111 </ROUND_ID>
<INDEX> 1 </INDEX>
</ROUND>
</ROUNDs>
</BATCH>
</BATCHES>
<DUE_DATE> 11/12/2008 9:21:47 AM </DUE_DATE>
<REQUESTED_BY> abc </REQUESTED_BY>
<EVALUATORS>
<EVALUATOR>
<ID> 11111111-1111-1111-1111-111111111111 </ID>
<SCREEN_NAME> xyz </SCREEN_NAME>
<EMAIL> xyz@brightida.com </EMAIL>
<DATE_COMPLETE> 11/12/2008 9:21:47 AM </DATE_COMPLETE>
<QUSTIONS_ANSWERS>
<QUSTION>
<QUSTION_TEXT> Question1 </QUSTION_TEXT>
<ANSWER_TEXT> Answer1 </ANSWER_TEXT>
</QUSTION>
<QUSTION>
<QUSTION_TEXT> Question2 </QUSTION_TEXT>
<ANSWER_TEXT> Answer2 </ANSWER_TEXT>
</QUSTION>
</QUSTIONS_ANSWERS>
<SCORE> 33.33% </SCORE>
</EVALUATOR>
</EVALUATORS>
<EVALUATOR_COUNT> 2 </EVALUATOR_COUNT>
<CLOSED_COUNT> 0 </CLOSED_COUNT>
<OPEN_COUNT> 1 </OPEN_COUNT>
<TOTAL_SCORE> 55.55%</TOTAL_SCORE>
</SCORECARD>
</SCORECARDS>
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.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"?>
<TAG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>TestTag</NAME>
</TAG>
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"?>
<TAG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>TestTag</NAME>
</TAG>
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"?>
<TAG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>TestTag</NAME>
</TAG>
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"?>
<TAG>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME>TestTag</NAME>
</TAG>
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"?>
<VIEW>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</VIEW>
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"?>
<CHIP_VOTE>
<CHIPS_SPENT>1</CHIPS_SPENT>
<CHIPS_AVAILABLE>10</CHIPS_AVAILABLE>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<SCORE>11</SCORE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</CHIP_VOTE>
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"?>
<CHIP_VOTE>
<CHIPS_SPENT>0</CHIPS_SPENT>
<CHIPS_AVAILABLE>10</CHIPS_AVAILABLE>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<SCORE>11</SCORE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</CHIP_VOTE>
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"?>
<VOTE>
<TYPE>Promote</TYPE>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<SCORE>11</SCORE>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</VOTE>
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"?>
<VOTE>
<TYPE>Promote</TYPE>
<IDEA_ID>11111111-1111-1111-1111-111111111111</IDEA_ID>
<MEMBER_ID>11111111-1111-1111-1111-111111111111</MEMBER_ID>
<DATE>8/29/2008 12:05:29 PM</DATE>
</VOTE>
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
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"?>
<MILESTONES>
<MILESTONE>
<ID>11111111-1111-1111-1111-111111111111</ID>
<TITLE><![CDATA[New Milestone 001]]></TITLE>
<DESCRIPTION><![CDATA[Test User]]></DESCRIPTION>
<DUE_DATE>8/29/2008</DUE_DATE>
<COMPLETION_DATE>8/29/2008</COMPLETION_DATE>
<RELATED_TO_DO_COUNT>![CDATA[Related To Do's count goes here.]]</RELATED_TO_DO_COUNT>
<RELATED_TO_DO_COUNT_TOTAL>![CDATA[Total Related To Do's count goes here.]]</RELATED_TO_DO_COUNT_TOTAL>
<RELATED_TO_DO_COUNT_OPEN><![CDATA[Open To Do's count goes here.]]></RELATED_TO_DO_COUNT_OPEN>
<RELATED_TO_DO_COUNT_CLOSED><![CDATA[Completed To Do's count goes here.]]></RELATED_TO_DO_COUNT_CLOSED>
</MILESTONE>
</MILESTONES>
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
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"?>
<PROJECTIONS>
<PROJECTION>
<ID>11111111-1111-1111-1111-111111111111</ID>
<YEAR_1_LOW><100></YEAR_1_LOW>
<YEAR_1_HIGH><100></YEAR_1_HIGH>
<YEAR_2_LOW>100</YEAR_2_LOW>
<YEAR_2_HIGH>100</YEAR_2_HIGH>
<YEAR_3_LOW>100</YEAR_3_LOW>
<YEAR_3_HIGH>100</YEAR_3_HIGH>
<LAST_UPDATED><8/29/2008></LAST_UPDATED>
</PROJECTION>
</PROJECTIONS>
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
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"?>
<RESULTS>
<RESULT>
<RESULT_ID>11111111-1111-1111-1111-111111111111</RESULT_ID>
<TYPE><Revenue/Cost Savings/Note></TYPE>
<AMOUNT><$10,000.00></AMOUNT>
<DESCRIPTION>Description of this result</DESCRIPTION>
<START_DATE>1/1/2012</START_DATE>
<END_DATE>12/30/2012</END_DATE>
<NOTES_COUNT>1</NOTES_COUNT>
<NOTE_DATA><Note description data></NOTE_DATA>
<DATE_ADDED>11/14/2012</DATE_ADDED>
<ADDED_BY><XYZ User></ADDED_BY>
</RESULT>
</RESULTS>
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"?>
<TODO_LIST>
<TODO>
<PROJECT_ID>11111111-1111-1111-1111-111111111111</PROJECT_ID>
<PROJECT_NAME>![CDATA[Project Name]]</PROJECT_NAME>
<TASK_ID>11111111-1111-1111-1111-111111111111</TASK_ID>
<TASK_TITLE><![CDATA[To Do Title]]></TASK_TITLE>
<TASK_DESCRIPTION><![CDATA[To Do Description]]></TASK_DESCRIPTION>
<ATTACHMENT_COUNT>2</ATTACHMENT_COUNT>
<CREATED_BY>![CDATA[Test User 1]]</CREATED_BY>
<ASSIGNEE>![CDATA[Test User 2]]</ASSIGNEE>
<ASSIGNED_BY><![CDATA[Test User 3]]></ASSIGNED_BY>
<DATE_ASSIGNED><11/14/2012 08:56:20 AM></DATE_ASSIGNED>
<DUE_DATE><11/14/2012 08:56:20 AM></DUE_DATE>
<DAYS_REMAINING>3</DAYS_REMAINING>
<FOLLOWER_COUNT>4</FOLLOWER_COUNT>
<FOLLOWERS>
<FOLLOWER_NAME>Test User 1</FOLLOWER_NAME>
<FOLLOWER_NAME>Test User 2</FOLLOWER_NAME>
</FOLLOWERS>
<COMMENT_COUNT>5</COMMENT_COUNT>
</TODO>
</TODO_LIST>
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"?>
<TODO_LIST>
<TODO>
<ID>11111111-1111-1111-1111-111111111111</ID>
<TITLE><![CDATA[To Do Title]]></TITLE>
<DESCRIPTION><![CDATA[To Do Description]]></DESCRIPTION>
<PROJECT_NAME>![CDATA[Project Name]]</PROJECT_NAME>
<ATTACHMENT_COUNT>2</ATTACHMENT_COUNT>
<CREATED_BY>![CDATA[Test User 1]]</CREATED_BY>
<ASSIGNEE>![CDATA[Test User 2]]</ASSIGNEE>
<ASSIGNED_BY><![CDATA[Test User 3]]></ASSIGNED_BY>
<DATE_ASSIGNED><11/14/2012 08:56:20 AM></DATE_ASSIGNED>
<DUE_DATE><11/14/2012 08:56:20 AM></DUE_DATE>
<DAYS_REMAINING>3</DAYS_REMAINING>
<FOLLOWER_COUNT>4</FOLLOWER_COUNT>
<FOLLOWERS>
<FOLLOWER_NAME>Test User 1</FOLLOWER_NAME>
<FOLLOWER_NAME>Test User 2</FOLLOWER_NAME>
</FOLLOWERS>
<COMMENT_COUNT>5</COMMENT_COUNT>
</TODO>
</TODO_LIST>
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"?>
<MEMBERS>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
</MEMBERS>
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"?>
<MEMBERS>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
</MEMBERS>
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.group.getMemberList
Description
Get a list of member accounts assigned to 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"?>
<MEMBERS>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
</MEMBERS>
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"?>
<GROUP>
<ID>11111111-1111-1111-1111-111111111111</ID>
<NAME><![CDATA[Group name]]></NAME>
<DATE>8/29/2008 12:05:29 PM</DATE>
</GROUP>
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"?>
<MEMBERS>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
</MEMBERS>
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"?>
<LABEL>
<ID>11111111-1111-1111-1111-111111111111</ID>
<KEY>LBL_WS_SETUP</KEY>
<VALUE>The Setup</VALUE>
</LABEL>
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
bi.affiliate.proposal.get
Description
Returns the data related for a given proposal.
HTTP Request Method: GET
Required Permission: bi.affiliate.proposal - Get
Arguments
p (Proposal ID): Required
This is the ID (i.e. 11111111-1111-1111-1111-111111111111) of the proposal.
Example Response
< ?xml version = "1.0" encoding="UTF-8"?>
<PROPOSAL>
<ID>11111111-1111-1111-1111-111111111111</ID>
<CODE>P1104</CODE>
<NAME>![CDATA[Proposal Name]]</NAME>
<DESCRIPTION>![CDATA[Proposal Description]]</DESCRIPTION>
<CREATION_DATE>06/28/2012 12:46:50 PM</CREATION_DATE>
<OWNER>![CDATA[Test User]]</OWNER>
<OWNER_EMAIL>testuser@brightidea.com</OWNER_EMAIL>
<STATUS>![CDATA[Active]]</STATUS>
<CUSTOM_STATUS>![CDATA[Active]]</CUSTOM_STATUS>
<SCORE>30.65</SCORE>
<TEMPLATE>![CDATA[Test Template]]</TEMPLATE>
<VERSION>2.5</VERSION>
<LAST_UPDATED_BY_SCREEN_NAME>![CDATA[Test User]]</LAST_UPDATED_BY_SCREEN_NAME>
<LAST_UPDATED_BY_EMAIL>testuser@brightidea.com</LAST_UPDATED_BY_EMAIL>
<LAST_UPDATED_DATE>06/28/2012 03:10:00 PM</LAST_UPDATED_DATE>
<ADDITIONAL_DATA>
<DATA_ITEM>
<FIELD>![CDATA[Field Title]]</FIELD>
<DATA>![CDATA[Field Data]]</DATA>
</DATA_ITEM>
</ADDITIONAL_DATA>
</PROPOSAL>
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"?>
<PROPOSAL>
<ATTACHMENT>
<ID>11111111-1111-1111-1111-111111111111</ID>
<USER_FILE_NAME>![CDATA[image01.jpg]]</USER_FILE_NAME>
<NAME>![CDATA[Attachment Name]]</NAME>
<LINK><![CDATA[http://www.brightidea.com/static/demo3/ODXXX/D5CC0992.jpg]]></LINK>
</ATTACHMENT>
</PROPOSAL>
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"?>
<PROPOSAL>
<TEAM_MEMBERS>
<MEMBER>
<ID>11111111-1111-1111-1111-111111111111</ID>
<AFFILIATE_ID>OD111</AFFILIATE_ID>
<EMAIL>testuser@brightidea.com</EMAIL>
<SCREEN_NAME><![CDATA[Test User]]></SCREEN_NAME>
<FIRST_NAME><![CDATA[John]]></FIRST_NAME>
<LAST_NAME><![CDATA[Doe]]></LAST_NAME>
<PHOTO_URL><![CDATA[http://www.brightidea.com/ct/attachment.asp?a=OD111&attachment_id=11111111-1111-1111-1111-111111111111]]></PHOTO_URL>
<JOB_TITLE><![CDATA[Job title goes here.]]></JOB_TITLE>
<SKILLS><![CDATA[Job skills go here.]]></SKILLS>
<WORK_HISTORY><![CDATA[Work history goes here.]]></WORK_HISTORY>
<PHONE><![CDATA[555-555-5555]]></PHONE>
<MOBILE_PHONE><![CDATA[555-555-5555]]></MOBILE_PHONE>
<ADDRESS><![CDATA[111 Anydrive]]></ADDRESS>
<EMAIL_NOTIFICATION>Yes</EMAIL_NOTIFICATION>
<DATE>8/29/2008 12:05:29 PM</DATE>
<DATE_MODIFIED>8/29/2008 12:05:29 PM</DATE_MODIFIED>
</MEMBER>
</TEAM_MEMBERS>
</PROPOSAL>
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"?>
<EVALUATION_LIST>
<PROPOSAL_ID> 11111111-1111-1111-1111-111111111111 </PROPOSAL_ID>
<BATCHES>
<BATCH>
<BATCH_ID> 11111111-1111-1111-1111-111111111111 </BATCH_ID>
<NAME> ![CDATA[Batch Name] </NAME>
<ROUNDS>
<ROUND>
<ROUND_ID> 11111111-1111-1111-1111-111111111111 </ROUND_ID>
<ROUND_INDEX> ![CDATA[Round 1] </ROUND_INDEX>
</ROUND>
</ROUNDS>
</BATCH>
</BATCHES>
<SCORECARD_TEMPLATE> ![CDATA[Template Name] </SCORECARD_TEMPLATE>
<EVALUATION_REQUESTED_BY_SCREEN_NAME> ![CDATA[Requestor Name] </EVALUATION_REQUESTED_BY_SCREEN_NAME>
<EVALUATION_REQUESTED_BY_EMAIL> testuser@brightidea.com </EVALUATION_REQUESTED_BY_EMAIL>
<EVALUATION_DUE_DATE> 11/12/2008 9:21:47 AM </EVALUATION_DUE_DATE>
<EVALUATORS>
<EVALUATOR>
<ASSIGNED_TO> 11111111-1111-1111-1111-111111111111 </ASSIGNED_TO>
<DATE_COMPLETE> 11/12/2008 9:21:47 AM </DATE_COMPLETE>
<SCREEN_NAME> ![CDATA[Test user] </SCREEN_NAME>
<EMAIL> testuser@brightida.com </EMAIL>
<QUESTIONS>
<QUESTION>
<QUSTION_TEXT> Question </QUSTION_TEXT>
<ANSWER_TEXT> Answer </ANSWER_TEXT>
<MEMBER_ID> 11111111-1111-1111-1111-111111111111 </MEMBER_ID>
</QUESTION>
<QUESTION>
<QUSTION_TEXT> Question </QUSTION_TEXT>
<ANSWER_TEXT> Answer </ANSWER_TEXT>
<MEMBER_ID> 11111111-1111-1111-1111-111111111111 </MEMBER_ID>
</QUESTION>
</QUESTIONS>
<SCORE> 63.33 </SCORE>
</EVALUATOR>
</EVALUATORS>
<TOTAL_EVALUATOR_COUNT> 2 </TOTAL_EVALUATOR_COUNT>
<TOTAL_SCORE> 63.33 </TOTAL_SCORE>
</EVALUATION_LIST>
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"?>
<RESULT>
OK
</RESULT>
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"?>
<RESULT>
OK
</RESULT>
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"?>
<notification_type>
updated
</notification_type>
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"?>
<badge_count>
reset
</badge_count>
Errors
Invalid or expired BI API key.
API call limit exceeded.
Access denied.
Permission denied.
Required data not supplied.
