BCI API Support Reference (version 1.0)


Master Data

Project Ownership types



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


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

Get Project Development Type by ID

Methods of access are:

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

REST: http://api.bciaustralia.com/rest/projectownertypes/{projectownertypeid}(.json / .xml)

Output: Structure

Parameters:
   projectownertypeid: numeric, required - ID of the Project Ownership Type
   fields: string, optional - PROJECTOWNERTYPEID,PROJECT_OWNER_TYPE
   token: string, required - allocated token for current login session

getByQuery
remote Array getByQuery ( string projectownertypeid, string projectownertype, string fields="", required string token )

Get Project Stage by Query (passing a single or comma seperated list of IDs or the owner type name)

Methods of access are:

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

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

Output: Array

Parameters:
   projectownertypeid: string, optional - ID of the project owership type (single ID or comma-seperated list)
   projectownertype: string, optional - project ownership type name
   fields: string, optional - PROJECTOWNERTYPEID,PROJECT_OWNER_TYPE
   token: string, required - allocated token for current login session

Fields
Selectable fields for owner type information
PROJECTOWNERTYPEIDLONG
PROJECT_OWNER_TYPESTRING(1000)
Sample Output - getByPK() - XML
<wddxPacket version='1.0'> <header/> <data> <struct> <var name='PROJECTOWNERTYPEID'><number>2.0</number></var> <var name='PROJECT_OWNER_TYPE'><string>Private</string></var> </struct> </data> </wddxPacket>
Sample Output - getByQuery() - XML
<wddxPacket version='1.0'> <header/> <data> <array length='1'> <struct> <var name='PROJECTOWNERTYPEID'><number>2.0</number></var> <var name='PROJECT_OWNER_TYPE'><string>Private</string></var> </struct> </array> </data> </wddxPacket>