BCI API Support Reference (version 1.0)


Project And Role Information

Project Roles



URL path: REST Request SOAP Request Base
http://api.bciasia.com/rest/projectroles.json http://api.bciasia.com/projectroles.cfc?wsdl http://api.bciasia.com/projectroles.cfc
Serializable: Yes
Methods: getByPK, getByQuery
Localization and translation:
(BCI Asia API only)
Refer to the Localization and translation page for details.


getByPK
remote Array getByPK ( required numeric projectrefid, numeric last="", string fields="", required string token )

Get all project role information for a version of project

Methods of access are:

SOAP: http://api.bciasia.com/projectroles.cfc?wsdl&method=getByPK&projectrefid={projectrefid}(&returnFormat=wddx / &returnFormat=json)

REST: http://api.bciasia.com/rest/projectroles/{projectrefid}(.json / .xml)

Output: Array

Parameters:
projectrefid: numeric, required - Project reference ID of the unique project record
last: numeric, optional - Only latest published version of the project (value=1)
fields: string, optional - Fields being requested for the return data. Full list provided under "Fields" section below
token: string, required - Allocated token for current login session

getByQuery
remote Array getByQuery ( string companyid, string roleID, string rolegroupID, numeric tenderwinner="1", required string projectrefid, optional string projectid, numeric last="1", numeric version, string tenderid, string fields="", token string token, numeric NumberOfRows="1000", numeric StartRow="1", string tender_opening_from, string tender_opening_to, string tender_closing_from, string tender_closing_to )

Output: Array

Parameters:
companyid: string, optional - ID or comma-seperated list of company IDs
roleID: string, optional - ID or comma-seperated list of role IDs
rolegroupID: string, optional - ID or comma-seperated list of role group IDs
tenderwinner: numeric, optional - Flag indicating if contact/company is the tender winner (value = 1 for winner, default, value = 2 for showing all winner and to be appointed)
projectrefid: string, optional - ID or comma-seperated list of Project reference IDs of the unique project records
projectid: string, required - ID or comma-seperated list of project IDs
last: numeric, optional - Only latest published version of the project (value=1)
version: numeric, optional - Version number of the project
tenderid: numeric, optional - ID or comma-seperated list of tender IDs
fields: string, optional - Fields being requested for the return data. Full list provided under "Fields" section below
token: string, required - Allocated token for current login session
NumberOfRows: numeric, optional - Number of results being requested in the reponse data
StartRow: numeric, optional - Start position of the data in the result recordset
tender_opening_from: string, optional - Minimum tender opening date, accepted datetime format (dd/mm/yyyy or dd/mm/yyyy HH:mi where dd represents 2 digit dates, mm represents 2 digit month, yyyy is 4 digits for year, HH represents 2 digit hours according to a 24-hr clock, mi represents 2 digits minutes)
tender_opening_to: string, optional - Maximum tender opening date, accepted datetime format (dd/mm/yyyy or dd/mm/yyyy HH:mi where dd represents 2 digit dates, mm represents 2 digit month, yyyy is 4 digits for year, HH represents 2 digit hours according to a 24-hr clock, mi represents 2 digits minutes)
tender_closing_from: string, optional - Minimum tender closing date, accepted datetime format (dd/mm/yyyy or dd/mm/yyyy HH:mi where dd represents 2 digit dates, mm represents 2 digit month, yyyy is 4 digits for year, HH represents 2 digit hours according to a 24-hr clock, mi represents 2 digits minutes)
tender_closing_to: string, optional - Maximum tender closing date, accepted datetime format (dd/mm/yyyy or dd/mm/yyyy HH:mi where dd represents 2 digit dates, mm represents 2 digit month, yyyy is 4 digits for year, HH represents 2 digit hours according to a 24-hr clock, mi represents 2 digits minutes)

Fields
FIRMTENDER_REFIDLONG
FIRMTENDERIDLONG
LASTBOOLEAN
VERSIONINTEGER
TENDER_REFIDLONG
TENDERIDLONG
PROJECT_REFIDLONG
PROJECTIDLONG
COMPANYIDLONG
TIME_STAMPDATE
CONTACTIDLONG
TENDERWINNERBOOLEAN
ROLEIDINTEGER
ROLE_GROUPIDINTEGER
ROLE_NAMESTRING(1000)
ROLE_GROUP_NAMESTRING(100)
FIRMTENDER_REMARKSSTRING(2000)
SITE_CONTACTSTRING(1000)
TENDER_OPENDATE
TENDER_CLOSEDATE
TENDER_REMARKSSTRING(2000)
TENDER_AWARDEDBOOLEAN
Fields in local languages
L_FIRMTENDER_REMARKSSTRING(2000)
L_TENDER_REMARKSSTRING(2000)
ROLE_NAME_ZHSTRING(1000)
ROLE_GROUP_NAME_ZHSTRING(100)
ROLE_NAME_THSTRING(1000)
ROLE_GROUP_NAME_THSTRING(100)
ROLE_NAME_IDSTRING(1000)
ROLE_GROUP_NAME_IDSTRING(100)
ROLE_NAME_VISTRING(1000)
ROLE_GROUP_NAME_VISTRING(100)
Sample Output - getByPK() - XML
<wddxPacket version='1.0'> <header/> <data> <array length='1'> <struct> <var name='TENDER_AWARDED'><number>1.0</number></var> <var name='ROLE_GROUPID'><number>6.0</number></var> <var name='FIRMTENDERID'><number>2761915.0</number></var> <var name='ROLEID'><number>18.0</number></var> <var name='TENDERID'><number>2537126.0</number></var> <var name='PROJECTID'><number>2.7313017E7</number></var> <var name='TENDER_REFID'><number>1.05791E7</number></var> <var name='TENDERWINNER'><number>1.0</number></var> <var name='TENDER_REMARKS'><string></string></var> <var name='TENDER_OPEN'><string></string></var> <var name='PROJECT_REFID'><number>1.0037304E7</number></var> <var name='FIRMTENDER_REMARKS'><string></string></var> <var name='TIME_STAMP'><dateTime>2013-05-17T17:23:00+10:00</dateTime></var> <var name='CONTACTID'><number>2657014.0</number></var> <var name='VERSION'><number>17.0</number></var> <var name='LAST'><number>1.0</number></var> <var name='SITE_CONTACT'><string></string></var> <var name='TENDER_CLOSE'><string></string></var> <var name='FIRMTENDER_REFID'><number>1.0642729E7</number></var> <var name='COMPANYID'><number>4526010.0</number></var> </struct> </array> </data> </wddxPacket>
Sample Output - getByQuery() - XML
<wddxPacket version='1.0'> <header/> <data> <struct> <var name='TENDER_AWARDED'><number>1.0</number></var> <var name='ROLE_GROUPID'><number>6.0</number></var> <var name='FIRMTENDERID'><number>2761858.0</number></var> <var name='ROLEID'><number>13.0</number></var> <var name='TENDERID'><number>2537123.0</number></var> <var name='PROJECTID'><number>2.7313017E7</number></var> <var name='TENDER_REFID'><number>1.0579097E7</number></var> <var name='TENDERWINNER'><number>1.0</number></var> <var name='TENDER_REMARKS'><string></string></var> <var name='TENDER_OPEN'><string></string></var> <var name='PROJECT_REFID'><number>1.0037304E7</number></var> <var name='FIRMTENDER_REMARKS'><string></string></var> <var name='TIME_STAMP'><dateTime>2013-05-17T17:23:00+10:00</dateTime></var> <var name='CONTACTID'><number>5703014.0</number></var> <var name='VERSION'><number>17.0</number></var> <var name='LAST'><number>1.0</number></var> <var name='SITE_CONTACT'><string></string></var> <var name='TENDER_CLOSE'><string></string></var> <var name='FIRMTENDER_REFID'><number>1.0642725E7</number></var> <var name='COMPANYID'><number>320014.0</number></var> </struct> </array> </var> </struct> </data> </wddxPacket>