BCI API Support Reference (version 1.0)


Master Data

Project Tender Types



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


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

Get Project Tender Type by ID

Methods of access are:

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

REST: http://api.bciaustralia.com/rest/projecttendertypes/{projecttendertypeid}(.json / .xml)

Output: Structure

Parameters:
   projecttendertypeid: numeric, required - Project Tender Type ID
   fields: string, optional - PROJECTTENDERTYPEID,PROJECT_TENDER_TYPE
   token: string, required - allocated token for current login session

getByQuery
remote Array getByQuery ( string projecttendertypeid, string projecttendertype, string fields="", string token )

Get Project Tender Type by Query (passing Tender Type Name or list of Tender Type IDs)

Methods of access are:

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

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

Output: Array

Parameters:
   projecttendertypeid: string, optional - Project Tender Type ID (or comma seperated list)
   projecttendertype: string, optional - Project Tender Type Name
   fields: string, optional - PROJECTTENDERTYPEID,PROJECT_TENDER_TYPE
   token: string, required - allocated token for current login session

Fields
Selectable fields for tender type information
PROJECTTENDERTYPEIDLONG
PROJECT_TENDER_TYPESTRING(30)
Sample Output - getByPK() - XML
<wddxPacket version='1.0'> <header/> <data> <struct> <var name='PROJECT_TENDER_TYPE'><string>Pre-registered tender</string></var> <var name='PROJECTTENDERTYPEID'><number>3.0</number></var> </struct> </data> </wddxPacket>
Sample Output - getByQuery() - XML
<wddxPacket version='1.0'> <header/> <data> <array length='1'> <struct> <var name='PROJECT_TENDER_TYPE'><string>Pre-registered tender</string></var> <var name='PROJECTTENDERTYPEID'><number>3.0</number></var> </struct> </array> </data> </wddxPacket>