| URL path: | REST Request | SOAP Request | Base |
| http://api.bciaustralia.com/rest/projectsubcategories.json | http://api.bciaustralia.com/projectsubcategories.cfc?wsdl | http://api.bciaustralia.com/projectsubcategories.cfc | |
| serializable: | Yes | ||
| Methods: | getByPK, getByQuery |
| getByPK |
|---|
remote
Struct
getByPK
(
required numeric
projectsubcategoryid,
string
fields="",
required string
token
)
Get Project Sub Category by ID Methods of access are: SOAP: http://api.bciaustralia.com/projectsubcategories.cfc?wsdl&method=getByPK&projectsubcategoryid={projectsubcategoryid}(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/projectsubcategories/{projectsubcategoryid}(.json / .xml) Output: Structure Parameters: projectsubcategoryid: numeric, required - Project Subcategory ID fields: string, optional - PROJECT_SUBCATEGORYID,PROJECTCATEGORIESID,PROJECT_SUBCATEGORY,SECTIONID token: string, required - allocated token for current login session |
| getByQuery |
remote
Array
getByQuery
(
string
projectsubcategoryid,
string
projectsubcategory,
string
projectcategoriesid,
string
fields="",
required string
token
)
Get Project Subcategory by Query (pass name of project subcategory or list of project subcategory ids) Methods of access are: SOAP: http://api.bciaustralia.com/projectsubcategory.cfc?wdsl&method=getByQuery(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/projectsubcategory(.json / .xml) Output: Array Parameters: projectsubcategoryid: string, optional - List of Project SubCategory IDs projectsubcategory: string, optional - Name of Project Subcategory projectcategoriesid: string, optional - List of Project Categories IDs (Allows to pull up all subcategories within selected categories) fields: string, optional - PROJECT_SUBCATEGORYID,PROJECTCATEGORIESID,PROJECT_SUBCATEGORY,SECTIONID token: string, required - allocated token for current login session |
| Fields | ||||||||
|---|---|---|---|---|---|---|---|---|
| Selectable fields for subcategory information | ||||||||
|
| Sample Output - getByPK() - XML |
|---|
|
|
| Sample Output - getByQuery() - XML |
|---|
|
|