getAllVersionsByPK
|
remote
Array
getAllVersionsByPK
(
required numeric
projectid,
string
fields="",
required string
token,
string
sortby="",
string
sortbyorder=""
)
Get all versions for a project passing a projectID
Methods of access are:
SOAP: http://api.bciaustralia.com/projects.cfc?wsdl&method=getAllVersionsByPK&projectid={projectid}(&returnFormat=wddx / &returnFormat=json)
REST: https://api.bciaustralia.com/rest/projects/getAllVersionsByPK(.json / .xml)&{search-criteria}
Output: Array
Parameters:
projectid: |
numeric, required - ID of the project for which all versions are being requested
|
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
|
sortby: |
string, optional - Field to sort the data by
|
sortbyorder: |
string, optional - Order of the sort (Ascending / Descending)
|
|
getAllVersionsByQuery
|
remote
Array
getAllVersionsByQuery
(
string
projectid,
string
state,
string
version,
string
cat,
string
subcat,
string
timestamp_from,
string
timestamp_to,
numeric
timestamp,
string
tender_closing_from,
string
tender_closing_to,
string
construction_start_from,
string
construction_start_to,
string
units_min,
string
units_max,
string
storeys_min,
string
storeys_max,
string
floor_area_min,
string
floor_area_max,
string
project_value_min,
string
project_value_max,
string
keyword,
string
status,
string
stage,
string
ownership,
string
development,
string
postcode,
string
address,
string
town,
string
council,
string
region,
string
country,
string
funding,
string
green,
numeric
master_plan,
string
fields="",
required string
token,
string
da_number,
string
sortby,
string
sortbyorder,
numeric
NumberOfRows="1000",
numeric
StartRow="1",
string
companyid,
numeric
main_contractor_appointed,
numeric
main_contractor_listed,
numeric
main_contractor_appointment_method_id,
,
string
contract_typeid
)
Get project information based on search criteria searching across all version of project not just the last published versions
Methods of access are:
SOAP: http://api.bciaustralia.com/projects.cfc?wsdl&method=getAllVersionsByQuery&{search-criteria}(&returnFormat=wddx / &returnFormat=json)
REST: https://api.bciaustralia.com/rest/projects/getAllVersionsByQuery(.json / .xml)&{search-criteria}
Output: Array
Parameters:
projectid: |
string, optional - ID or comma-seperated list of IDs of the project for which all versions are being searched
|
state: |
string, optional - ID or comma-seperated list of IDs of states in which projects are located
|
version: |
string, optional - Specific project version
|
cat: |
string, optional - ID or comma-seperated list of IDs of categories
|
subcat: |
string, optional - ID or comma-seperated list of IDs of sub-categories
|
timestamp_from: |
string, optional - Minimum date stamp for searching using a time frame, 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)
|
timestamp_to: |
string, optional - Maximum date stamp for searching using a time frame, 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)
|
timestamp: |
numeric, optional - Number of days relative to today as a time-frame, for example 5 means searching through last 5 days. This considers the exact time so timestamp=1 effectively means projects reported in the last 24 hours, timestamp=2 would mean projects reported in the last 48 hours.
|
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)
|
construction_start_from: |
string, optional - Minimum construction start 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)
|
construction_start_to: |
string, optional - Maximum construction start 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)
|
units_min: |
string, optional - Minimum number of units
|
units_max: |
string, optional - Maximum number of units
|
storeys_min: |
string, optional - Minimum number of storeys
|
storeys_max: |
string, optional - Maximum number of storeys
|
floor_area_min: |
string, optional - Minimum floor area
|
floor_area_max: |
string, optional - Maximum floor area
|
project_value_min: |
string, optional - Minimum project value in millions
|
project_value_max: |
string, optional - Maximum project value in millions
|
keyword: |
string, optional - Keyword for project
|
status: |
string, optional - ID or comma-seperated list of IDs of the project status
|
stage: |
string, optional - ID or comma-seperated list of IDs of the project stage
|
ownership: |
string, optional - ID or comma-seperated list of IDs of the project ownership types
|
development: |
string, optional - ID or comma-seperated list of IDs of the project development types
|
postcode: |
string, optional - Postcode of project location
|
address: |
string, optional - Address of project location
|
town: |
string, optional - Town/Suburb of project location
|
council: |
string, optional - Council of project location
|
region: |
string, optional - ID or comma-seperated list of IDs of BCI regions
|
country: |
string, optional - ID or comma-seperated list of IDs of countries
|
funding: |
string, optional - ID or comma-seperated list of IDs of funding types, Local Funding (value = 1), State Funding (value=2), Federal Funding (value=3)
|
green: |
string, optional - ID or comma-seperated list of IDs of Green Star Ratings
|
master_plan: |
numeric, optional - Flag of Master Plan
|
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
|
da_number: |
string, optional - DA Number, Enter exact DA Number Only (Without Year)
|
sortby: |
string, optional - Field to sort the data by
|
sortbyorder: |
string, optional - Order of the sort (Ascending / Descending)
|
NumberOfRows: |
numeric, optional - Number of results being requested in the reponse data
|
StartRow: |
numeric, optional - Start position of the data in the result recordset
|
companyid: |
string, optional - ID or comma-seperated list of IDs of companies for which projects are being searched
|
main_contractor_appointed: |
string, optional - Pass 1 for projects with main contractor appointed, 0 for projects with not appointed
|
main_contractor_listed: |
string, optional - Pass 1 for projects with main contractor listed, 0 for projects with not listed
|
main_contractor_appointment_method_id: |
numeric, optional - ID of the main contractor appointment method
|
contract_typeid: |
string, optional - Single ID or comma-seperated list of IDs of Contract Types
|
|
getByPK
|
remote
Struct
getByPK
(
required numeric
projectrefid,
string
fields="",
required string
token,
string
sortby,
string
sortbyorder
)
Get Latest Version by Projectid
Access the lastest version of a project as identified by the project id. Methods of access are:
SOAP: http://api.bciaustralia.com/projects.cfc?method=getByPK&projectrefid={projectrefid}(&returnFormat=wddx / &returnFormat=json)
REST: http://api.bciaustralia.com/rest/projects/{projectrefid}(.json / .xml)
Output: Structure
Parameters:
projectrefid: |
numeric, required - Projectrefid of the project record
|
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
|
sortby: |
string, optional - Field to sort the data by
|
sortbyorder: |
string, optional - Order of the sort (Ascending / Descending)
|
|
getByQuery
|
remote
Array
getByQuery
(
numeric
projectrefid,
string
projectid,
string
state,
string
last="1",
string
version,
string
cat,
string
cat_1,
string
subcat,
string
timestamp_from,
string
timestamp_to,
numeric
timestamp,
string
updatedate_from,
string
updatedate_to,
numeric
updatedate,
string
tender_closing_from,
string
tender_closing_to,
string
construction_start_from,
string
construction_start_to,
string
units_min,
string
units_max,
string
storeys_min,
string
storeys_max,
string
floor_area_min,
string
floor_area_max,
string
project_value_min,
string
project_value_max,
string
keyword,
string
status,
string
stage,
string
ownership,
string
development,
string
postcode,
string
address,
string
town,
string
council,
string
region,
string
country,
string
funding,
string
green,
numeric
master_plan,
string
fields="",
required string
token,
string
da_number,
string
sortby,
string
sortbyorder,
numeric
NumberOfRows="100",
numeric
StartRow="1",
string
companyid,
numeric
main_contractor_appointed,
numeric
main_contractor_listed,
numeric
main_contractor_appointment_method_id,
,
string
contract_typeid
)
Function to retrieve project information based on search parameters
Methods of access are:
SOAP: http://api.bciaustralia.com/projects.cfc?wsdl&method=getByQuery&search-parameters(&returnFormat=wddx / &returnFormat=json)
REST: http://api.bciaustralia.com/rest/projects(.json / .xml)&search-parameters
Output: Array
Parameters:
projectrefid: |
numeric, optional - Projectrefid of the project record
|
projectid: |
string, optional - ID or comma-seperated list of IDs of the project for which all versions are being searched
|
state: |
string, optional - ID or comma-seperated list of IDs of states in which projects are located
|
last: |
string, optional - Search for only the last published version (value=1)
|
version: |
string, optional - Specific project version
|
cat: |
string, optional - ID or comma-seperated list of IDs of categories
|
subcat: |
string, optional - ID or comma-seperated list of IDs of sub-categories
|
timestamp_from: |
string, optional - Minimum date stamp for searching using a time frame, 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)
|
timestamp_to: |
string, optional - Maximum date stamp for searching using a time frame, 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)
|
timestamp: |
numeric, optional - Number of days relative to today as a time-frame, for example 5 means searching through last 5 days. This considers the exact time so timestamp=1 effectively means projects reported in the last 24 hours, timestamp=2 would mean projects reported in the last 48 hours.
|
updatedate_from: |
string, optional - Minimum update date for searching using a time frame, 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)
|
updatedate_to: |
string, optional - Maximum update date for searching using a time frame, 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)
|
updatedate: |
numeric, optional - Number of days relative to today as a time-frame, for example 5 means searching through last 5 days. This considers the exact time so updatedate=1 effectively means projects updated/edited in the last 24 hours, updatedate=2 would mean projects reported in the last 48 hours.
|
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)
|
construction_start_from: |
string, optional - Minimum construction start 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)
|
construction_start_to: |
string, optional - Maximum construction start 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)
|
units_min: |
string, optional - Minimum number of units
|
units_max: |
string, optional - Maximum number of units
|
storeys_min: |
string, optional - Minimum number of storeys
|
storeys_max: |
string, optional - Maximum number of storeys
|
floor_area_min: |
string, optional - Minimum floor area
|
floor_area_max: |
string, optional - Maximum floor area
|
project_value_min: |
string, optional - Minimum project value in millions
|
project_value_max: |
string, optional - Maximum project value in millions
|
keyword: |
string, optional - Keyword for project
|
status: |
string, optional - ID or comma-seperated list of IDs of the project status
|
stage: |
string, optional - ID or comma-seperated list of IDs of the project stage
|
ownership: |
string, optional - ID or comma-seperated list of IDs of the project ownership types
|
development: |
string, optional - ID or comma-seperated list of IDs of the project development types
|
postcode: |
string, optional - Postcode of project location
|
address: |
string, optional - Address of project location
|
town: |
string, optional - Town/Suburb of project location
|
council: |
string, optional - Council of project location
|
region: |
string, optional - ID or comma-seperated list of IDs of BCI regions
|
country: |
string, optional - ID or comma-seperated list of IDs of countries
|
funding: |
string, optional - ID or comma-seperated list of IDs of funding types, Local Funding (value = 1), State Funding (value=2), Federal Funding (value=3)
|
green: |
string, optional - ID or comma-seperated list of IDs of Green Star Ratings
|
master_plan: |
numeric, optional - Flag of Master Plan
|
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
|
da_number: |
string, optional - DA Number, Enter exact DA Number Only (Without Year)
|
sortby: |
string, optional - Field to sort the data by
|
sortbyorder: |
string, optional - Order of the sort (Ascending / Descending)
|
NumberOfRows: |
numeric, optional - Number of results being requested in the reponse data
|
StartRow: |
numeric, optional - Start position of the data in the result recordset
|
companyid: |
string, optional - ID or comma-seperated list of IDs of companies for which projects are being searched
|
main_contractor_appointed: |
string, optional - Pass 1 for projects with main contractor appointed, 0 for projects with not appointed
|
main_contractor_listed: |
string, optional - Pass 1 for projects with main contractor listed, 0 for projects with not listed
|
main_contractor_appointment_method_id: |
numeric, optional - ID of the main contractor appointment method
|
contract_typeid: |
string, optional - Single ID or comma-seperated list of IDs of Contract Types
|
|
getVersionByPK
|
remote
Array
getVersionByPK
(
required numeric
projectid,
required numeric
version,
string
fields="",
required string
token,
string
sortby="",
string
sortbyorder=""
)
Output: Array
Parameters:
projectid: |
numeric, required - ID of the project
|
version: |
numeric, required - Version number of the project
|
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
|
sortby: |
string, optional - Field to sort the data by
|
sortbyorder: |
string, optional - Order of the sort (Ascending / Descending)
|
|
getAllSinceLastQuery
|
remote
Array
getAllSinceLastQuery
(
string
projectid,
string
state,
string
version,
string
cat,
string
cat_1,
string
subcat,
string
timestamp_from,
string
timestamp_to,
numeric
timestamp,
string
tender_closing_from,
string
tender_closing_to,
string
construction_start_from,
string
construction_start_to,
string
units_min,
string
units_max,
string
storeys_min,
string
storeys_max,
string
floor_area_min,
string
floor_area_max,
string
project_value_min,
string
project_value_max,
string
keyword,
string
status,
string
stage,
string
ownership,
string
development,
string
postcode,
string
address,
string
town,
string
council,
string
region,
string
country,
string
funding,
string
green,
numeric
master_plan,
string
fields="",
required string
token,
string
da_number,
string
sortby,
string
sortbyorder,
numeric
NumberOfRows="1000",
numeric
StartRow="1",
string
companyid,
numeric
main_contractor_appointed,
numeric
main_contractor_listed,
numeric
main_contractor_appointment_method_id,
,
string
contract_typeid
)
Function to retrieve newer project versions since the last time user made a request to this method.
Output: Array
Parameters:
projectrefid: |
numeric, optional - Projectrefid of the project record
|
projectid: |
string, optional - ID or comma-seperated list of IDs of the project for which all versions are being searched
|
state: |
string, optional - ID or comma-seperated list of IDs of states in which projects are located
|
last: |
string, optional - Search for only the last published version (value=1)
|
version: |
string, optional - Specific project version
|
cat: |
string, optional - ID or comma-seperated list of IDs of categories
|
subcat: |
string, optional - ID or comma-seperated list of IDs of sub-categories
|
timestamp_from: |
string, optional - Minimum date stamp for searching using a time frame, 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)
|
timestamp_to: |
string, optional - Maximum date stamp for searching using a time frame, 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)
|
timestamp: |
numeric, optional - Number of days relative to today as a time-frame, for example 5 means searching through last 5 days. This considers the exact time so timestamp=1 effectively means projects reported in the last 24 hours, timestamp=2 would mean projects reported in the last 48 hours.
|
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)
|
construction_start_from: |
string, optional - Minimum construction start 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)
|
construction_start_to: |
string, optional - Maximum construction start 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)
|
units_min: |
string, optional - Minimum number of units
|
units_max: |
string, optional - Maximum number of units
|
storeys_min: |
string, optional - Minimum number of storeys
|
storeys_max: |
string, optional - Maximum number of storeys
|
floor_area_min: |
string, optional - Minimum floor area
|
floor_area_max: |
string, optional - Maximum floor area
|
project_value_min: |
string, optional - Minimum project value in millions
|
project_value_max: |
string, optional - Maximum project value in millions
|
keyword: |
string, optional - Keyword for project
|
status: |
string, optional - ID or comma-seperated list of IDs of the project status
|
stage: |
string, optional - ID or comma-seperated list of IDs of the project stage
|
ownership: |
string, optional - ID or comma-seperated list of IDs of the project ownership types
|
development: |
string, optional - ID or comma-seperated list of IDs of the project development types
|
postcode: |
string, optional - Postcode of project location
|
address: |
string, optional - Address of project location
|
town: |
string, optional - Town/Suburb of project location
|
council: |
string, optional - Council of project location
|
region: |
string, optional - ID or comma-seperated list of IDs of BCI regions
|
country: |
string, optional - ID or comma-seperated list of IDs of countries
|
funding: |
string, optional - ID or comma-seperated list of IDs of funding types, Local Funding (value = 1), State Funding (value=2), Federal Funding (value=3)
|
green: |
string, optional - ID or comma-seperated list of IDs of Green Star Ratings
|
master_plan: |
numeric, optional - Flag of Master Plan
|
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
|
da_number: |
string, optional - DA Number, Enter exact DA Number Only (Without Year)
|
sortby: |
string, optional - Field to sort the data by
|
sortbyorder: |
string, optional - Order of the sort (Ascending / Descending)
|
NumberOfRows: |
numeric, optional - Number of results being requested in the reponse data
|
StartRow: |
numeric, optional - Start position of the data in the result recordset
|
companyid: |
string, optional - ID or comma-seperated list of IDs of companies for which projects are being searched
|
main_contractor_appointed: |
string, optional - Pass 1 for projects with main contractor appointed, 0 for projects with not appointed
|
main_contractor_listed: |
string, optional - Pass 1 for projects with main contractor listed, 0 for projects with not listed
|
main_contractor_appointment_method_id: |
numeric, optional - ID of the main contractor appointment method
|
contract_typeid: |
string, optional - Single ID or comma-seperated list of IDs of Contract Types
|
|