BCI API Support Reference (version 1.0)


Master Data

Project Statuses



URL path: REST Request SOAP Request Base
http://api.bciaustralia.com/rest/projectstatuses.json http://api.bciaustralia.com/projectstatuses.cfc?wsdl http://api.bciaustralia.com/projectstatuses.cfc
Serializable: Yes
Methods: getByPK, getByQuery


getByPK
remote Struct getByPK ( required numeric projectstatusid, string fields="", required string token )

Get Project Status by ID

Methods of access are:

SOAP: http://api.bciaustralia.com/projectstatuses.cfc?wsdl&method=getByPK&projectstatusid={projectstatusid}(&returnFormat=wddx / &returnFormat=json)

REST: http://api.bciaustralia.com/rest/projectstatuses/{projectstatusid}(.json / .xml)

Output: Structure

Parameters:
   projectstatusid: numeric, required - Project Status ID
   fields: string, optional - PROJECT_STATUSID,PROJECT_STATUS,PROJECT_STATUS_ABBV
   token: string, required - allocated token for current login session

getByQuery
remote Array getByQuery ( string projectstatusid, string projectstatus, string fields="", required string token )

Get Project Status by Query

Methods of access are:

SOAP: http://api.bciaustralia.com/projectstatuses.cfc?method=getByQuery(&returnFormat=wddx / &returnFormat=json)

REST: http://api.bciaustralia.com/rest/projectstatuses(.json / .xml)

Output: Array

Parameters:
   projectstatusid: string, optional - Project Status ID (single ID or comma seperated list)
   projectstatus: string, optional - Project Status Name
   fields: string, optional - PROJECT_STATUSID,PROJECT_STATUS,PROJECT_STATUS_ABBV
   token: string, required - allocated token for current login session

Fields
Selectable fields for project status information
PROJECT_STATUSIDLONG
PROJECT_STATUSSTRING(100)
PROJECT_STATUS_ABBVSTRING(100)
Sample Output - getByPK() - XML
<wddxPacket version='1.0'> <header/> <data> <struct> <var name='PROJECT_STATUS_ABBV'><string>Development Approval</string></var> <var name='PROJECT_STATUS'><string>Development Approval</string></var> <var name='PROJECT_STATUSID'><number>6.0</number></var> </struct> </data> </wddxPacket>
Sample Output - getByQuery() - XML
<wddxPacket version='1.0'> <header/> <data> <array length='1'> <struct> <var name='PROJECT_STATUS_ABBV'><string>Development Approval</string></var> <var name='PROJECT_STATUS'><string>Development Approval</string></var> <var name='PROJECT_STATUSID'><number>6.0</number></var> </struct> </array> </data> </wddxPacket>