BCI API Support Reference (version 1.0)


Company and Contact Information

Contacts



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


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

Get Contact Details by passing contactID

Methods of access are:

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

REST: http://api.bciaustralia.com/rest/contacts/{contactid}(.json / .xml)

Output: Structure

Parameters:
contactid: numeric, required - ID of the contact
fields: string, optional - Field names of returned data - CONTACTID, FIRST_NAME, LAST_NAME, SALUTATION, POSITION, TELEPHONE, FAX, SITE_PHONE, MOBILE, EMAIL, COMPANYID, NOTE, TIME_STAMP, RESIGNED
token: string, optional - allocated token for current login session

getByQuery
remote Array getByQuery ( string contactid, string companyid, string contact_first_name, string contact_last_name, string company_name, string company_town, string company_country, string company_state, string company_council, string company_postcode, string company_address, string company_role, string company_rolegroup, numeric project_value_min, numeric project_value_max, string project_name, string project_type, numeric projectid, numeric projectrefid, string project_keyword, string project_country, string project_state, string project_region, string project_council, string project_town, string project_category, string project_subcategory, string project_status, string project_stage, string project_date_stamp_min, string project_date_stamp_max, numeric company_tender_status, string project_postcode, string fields="", required string token numeric NumberOfRows="1000", numeric StartRow="1", string contact_timestamp_from, string contact_timestamp_to, numeric contact_timestamp )

Output: Array

Parameters:
contactid: string, optional - ID of the contact
companyid: string, optional - ID of the company
contact_first_name: string, optional - First name of the contact
contact_last_name: string, optional - Last name of the contact
fields: string, optional - Field names of returned data - CONTACTID, FIRST_NAME, LAST_NAME, SALUTATION, POSITION, TELEPHONE, FAX, SITE_PHONE, MOBILE, EMAIL, COMPANYID, NOTE, TIME_STAMP, RESIGNED
token: string, required - allocated token for current login session
company_name: string, optional - Partial or complete name of the company
company_town: string, optional - Town/suburb of the company
company_country: string, optional - ID or comma-seperated list of Country IDs
company_state: string, optional - ID or comma-seperated list of State IDs
company_council: string, optional - Name of the council
company_postcode: string, optional - Postcode of location of the company/contact
company_address: string, optional - Address of location of the company/contact
company_role: string, optional - ID or comma-seperated list of role IDs
company_rolegroup: string, optional - ID or comma-seperated list of role group IDs
project_value_min: numeric, optional - Minimum project value (in millions)
project_value_max: numeric, optional - Maximum project value (in millions)
project_name: string, optional - Partial or full project name
project_type: string, optional - Partial or full project type
projectid: numeric, optional - ID or comma-seperated list of project IDs
projectrefid: numeric, optional - ID or comma-seperated list of project Ref IDs
project_keyword: string, optional - Project keyword
project_country: string, optional - ID or comma-seperated list of countries where project is located
project_state: string, optional - ID or comma-seperated list of states where project is located
project_region: string, optional - ID or comma-seperated list of BCI Regions where project is located
project_council: string, optional - Name of council where project is located
project_town: string, optional - Name of town/suburb where project is located
project_category: string, optional - ID or comma-seperated list of categories of projects
project_subcategory: string, optional - ID or comma-seperated list of sub categories of projects
project_status: string, optional - ID or comma-seperated list of statuses of projects
project_stage: string, optional - ID or comma-seperated list of stages of projects
project_date_stamp_min: string, optional - Minimum date of project published 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)
project_date_stamp_max: string, optional - Maximum date of project published 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)
company_tender_status: numeric, optional - tender Status
project_postcode: string, optional - Postcode where project is located
NumberOfRows: numeric, optional - Number of result records being requested
StartRow: numeric, optional - Start position of the recordset being requested, default is 1
contact_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)
contact_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)
contact_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 contacts updated in the last 24 hours, timestamp=2 would mean contacts updated in the last 48 hours.
Fields
Selectable fields for contact information
CONTACTIDLONG
FIRST_NAMESTRING(1000)
LAST_NAMESTRING(1000)
NAME_ORDERINTEGER
SALUTATIONSTRING(1000)
POSITIONSTRING(1000)
TELEPHONESTRING(1000)
FAXSTRING(1000)
SITE_PHONESTRING(1000)
MOBILESTRING(1000)
EMAILSTRING(1000)
COMPANYIDLONG
NOTESTRING(1000)
TIME_STAMPDATE
RESIGNEDINTEGER
COMPANY_NAMESTRING(1000)
Sample Output - getByPK() - XML
<wddxPacket version='1.0'> <header/> <data> <struct> <var name='SALUTATION'><string>Mr</string></var> <var name='SITE_PHONE'><string></string></var> <var name='NOTE'><string></string></var> <var name='TELEPHONE'><string>08 9999 9999</string></var> <var name='LAST_NAME'><string>Smith</string></var> <var name='RESIGNED'><number>0.0</number></var> <var name='TIME_STAMP'><dateTime>2012-10-03T12:49:57+10:00</dateTime></var> <var name='CONTACTID'><number>454545</number></var> <var name='FIRST_NAME'><string>John</string></var> <var name='MOBILE'><string></string></var> <var name='EMAIL'><string>john@bhbconsulting.com.au</string></var> <var name='POSITION'><string>Structural Director</string></var> <var name='FAX'><string>08 9999 9999</string></var> <var name='COMPANYID'><number>155555</number></var> </struct> </data> </wddxPacket>
Sample Output - getByQuery() - XML
<wddxPacket version='1.0'> <header/> <data> <array length='1'> <struct> <var name='SALUTATION'><string>Mr</string></var> <var name='SITE_PHONE'><string></string></var> <var name='NOTE'><string></string></var> <var name='TELEPHONE'><string>08 9999 9999</string></var> <var name='LAST_NAME'><string>Smith</string></var> <var name='RESIGNED'><number>0.0</number></var> <var name='TIME_STAMP'><dateTime>2012-10-03T12:49:57+10:00</dateTime></var> <var name='CONTACTID'><number>454545</number></var> <var name='FIRST_NAME'><string>John</string></var> <var name='MOBILE'><string></string></var> <var name='EMAIL'><string>john@bhbconsulting.com.au</string></var> <var name='POSITION'><string>Structural Director</string></var> <var name='FAX'><string>08 9999 9999</string></var> <var name='COMPANYID'><number>155555</number></var> </struct> </array> </data> </wddxPacket>