BCI API Support Reference (version 1.0)


Master Data

Project Development Types



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


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

Get Project Development Type by ID

Methods of access are: SOAP: http://api.bciaustralia.com/projectdevtypes.cfc?wsdl&method=getByPK&projectdevtypeid={projectdevtypeid}(&returnFormat=wddx / &returnFormat=json)

REST: http://api.bciaustralia.com/rest/projectdevtypes/{projectdevtypeid}(.json / .xml)

Output: Structure

Parameters:
   projectdevtypeid: numeric, required - ID of the project development type
   fields: string, optional - PROJECTDEVTYPEID,PROJECT_DEVELOPMENT_TYPE
   token: string, required - allocated token for current login session

getByQuery
remote Array getByQuery ( string projectdevtypeid, string projectdevtype, string fields="", required string token )

Get Project Development type by query (passing list of IDs or development type name)

Methods of access are: SOAP: http://api.bciaustralia.com/projectstages.cfc?wsdl&method=getByQuery(&returnFormat=wddx / &returnFormat=json)

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

Output: Array

Parameters:
   projectdevtypeid: string, optional - ID of the project development type (single ID or comma-seperated list)
   projectdevtype: string, optional - project development type name
   fields: string, optional - PROJECTDEVTYPEID,PROJECT_DEVELOPMENT_TYPE
   token: string, required - allocated token for current login session

Fields
Selectable fields for development type information
PROJECTDEVTYPEIDLONG
PROJECT_DEVELOPMENT_TYPESTRING(1000)
Sample Output - getByPK() - XML
<wddxPacket version='1.0'> <header/> <data> <struct> <var name='PROJECT_DEVELOPMENT_TYPE'><string>Refurbishment</string></var> <var name='PROJECTDEVTYPEID'><number>2.0</number></var> </struct> </data> </wddxPacket>
Sample Output - getByQuery() - XML
<wddxPacket version='1.0'> <header/> <data> <array length='1'> <struct> <var name='PROJECT_DEVELOPMENT_TYPE'><string>Refurbishment</string></var> <var name='PROJECTDEVTYPEID'><number>2.0</number></var> </struct> </array> </data> </wddxPacket>