| URL path: | REST Requests | SOAP Request | Base |
|
http://api.bciaustralia.com/rest/leadmanager_ids.json?companyID={comma separated companyIDs} http://api.bciaustralia.com/rest/leadmanager_ids.json?leadmanager_companyID={comma separated LeadManager companyIDs} http://api.bciaustralia.com/rest/leadmanager_ids/company/{companyID}.json https://api.bciaustralia.com/rest/leadmanager_ids/leadmanager_company/{leadmanager_companyID}.json http://api.bciaustralia.com/rest/leadmanager_ids/company/{companyID}.json |
http://api.bciaustralia.com/leadmanager_ids.cfc?wsdl | http://api.bciaustralia.com/leadmanager_ids.cfc | |
| Serializable: | Yes | ||
| Methods: | getByPK_company, getByPK_leadmanager_company, getByQuery |
| getByPK_company |
|---|
remote
Struct
getByPK_company
(
required numeric
companyid,
string
fields="",
required string
token
)
Get LeadManager Company ID from Company ID Methods of access are: SOAP: http://api.bciaustralia.com/leamanager_ids.cfc?wsdl&method=getByPK_company&companyid={companyid}(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/leadmanager_ids/company/{companyid}(.json / .xml) Output: Structure Parameters: companyid: numeric, required - ID of the company provided by an API endpoint, single ID only fields: string, optional - COMPANYID, LEADMANAGER_COMPANYID token: string, required - allocated token for current login session |
| getByPK_leadmanager_company |
remote
Struct
getByPK_leadmanager_company
(
required numeric
leadmanager_companyid,
string
fields="",
required string
token
)
Get Company ID from LeadManager Company ID Methods of access are: SOAP: http://api.bciaustralia.com/leamanager_ids.cfc?wsdl&method=getByPK_leadmanager_company&leadmanager_companyid={leadmanager companyid}(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/leadmanager_ids/leadmanager_company/{leadmanager companyid}(.json / .xml) Output: Structure Parameters: leadmanager_companyid: numeric, required - ID of the company from the LeadManager application company ID, single ID only fields: string, optional - COMPANYID, LEADMANAGER_COMPANYID token: string, required - allocated token for current login session |
| getByQuery |
remote
Array
getByQuery
(
string
companyid,
string
leadmanager_companyid,
string
fields="",
required string
token
)
Get Company ID or LeadManager Company ID by Query (passing list of IDs or category name) Methods of access are: SOAP: http://api.bciaustralia.com/leadmanager_ids.cfc?method=getByQuery(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/leadmanager_ids(.json / .xml) Output: Array Parameters: companyid: string - ID of the company provided by an API endpoint (single ID or comma-seperated list) leadmanager_companyid: string - ID of the company from the LeadManager application company ID (single ID or comma-seperated list) fields: string, optional - COMPANYID, LEADMANAGER_COMPANYID token: string, required - allocated token for current login session NOTE: You must pass at least one of the following parameters - companyID, leadmanager_companyID |
| Fields | ||||
|---|---|---|---|---|
| Selectable fields for LeadManager IDs Endpoint | ||||
|
| Sample Output - getByPK() - JSON |
|---|
|
{ "LEADMANAGER_COMPANYID": 1646121, "COMPANYID": 20432010 } |
| Sample Output - getByQuery() - JSON |
|---|
|
[ {
]
"LEADMANAGER_COMPANYID": 7671, "COMPANYID": 4308010 },{ "LEADMANAGER_COMPANYID": 1646121, "COMPANYID": 20432010 } |