| URL path: | REST Request | SOAP Request | Base |
| http://api.bciaustralia.com/rest/projectcategories.json | http://api.bciaustralia.com/projectcategories.cfc?wsdl | http://api.bciaustralia.com/projectcategories.cfc | |
| Serializable: | Yes | ||
| Methods: | getByPK, getByQuery |
| getByPK |
|---|
remote
Struct
getByPK
(
required numeric
projectcategoriesid,
string
fields="",
required string
token
)
Get Project Category by ID Methods of access are: SOAP: http://api.bciaustralia.com/projectcategories.cfc?wsdl&method=getByPK&projectcategoriesid={projectcategoriesid}(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/projectcategories/{projectcategoriesid}(.json / .xml) Output: Structure Parameters: projectcategoriesid: numeric, required - ID of the project category fields: string, optional - PROJECTCATEGORIESID,PROJECT_CATEGORIES token: string, required - allocated token for current login session |
| getByQuery |
remote
Array
getByQuery
(
string
projectcategoriesid,
string
projectcategory,
string
fields="",
required string
token
)
Get Project Category by Query (passing list of IDs or category name) Methods of access are: SOAP: http://api.bciaustralia.com/projectcategories.cfc?method=getByQuery(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/projectcategories(.json / .xml) Output: Array Parameters: projectcategoriesid: string, optional - ID of the project category (single ID or comma-seperated list) projectcategory: string, optional - project category name fields: string, optional - PROJECTCATEGORIESID,PROJECT_CATEGORIES token: string, required - allocated token for current login session |
| Fields | ||||
|---|---|---|---|---|
| Selectable fields for category information | ||||
|
| Sample Output - getByPK() - XML |
|---|
|
|
| Sample Output - getByQuery() - XML |
|---|
|
|