| URL path: | REST Request | SOAP Request | Base |
| http://api.bciaustralia.com/rest/projectstages.json | http://api.bciaustralia.com/projectstages.cfc?wsdl | http://api.bciaustralia.com/projectstages.cfc | |
| Serializable: | Yes | ||
| Methods: | getByPK, getByQuery |
| getByPK |
|---|
remote
Struct
getByPK
(
required numeric
projectstagesid,
string
fields="",
required string
token
)
Get Project Stage by ID Methods of access are: SOAP: http://api.bciaustralia.com/projectstages.cfc?wsdl&method=getByPK&projectstageid={projectstageid}(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/projectstages/{projectstagesid}(.json / .xml) Output: Structure Parameters: projectstagesid: numeric, required - ID of the project Stage fields: string, optional - PROJECTSTAGESID,PROJECT_STAGE,SORT_ORDER token: string, required - allocated token for current login session |
| getByQuery |
remote
Array
getByQuery
(
string
projectstagesid,
string
projectstage,
string
fields="",
required string
token
)
Get Project Stage by Query (By Stage Name, list of IDs) Methods of access are: SOAP: http://api.bciaustralia.com/projectstages.cfc?wsdl&method=getByQuery(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/projectstages(.json / .xml) Output: Array Parameters: projectstagesid: string, optional - ID of the Project Stage (single ID or comma seperated list of IDs) projectstage: string, optional - Project Stage fields: string, optional - PROJECTSTAGESID,PROJECT_STAGE,SORT_ORDER token: string, required - Allocated token for current login session |
| Fields | ||||
|---|---|---|---|---|
| Selectable fields for project stage information | ||||
|
| Sample Output - getByPK() - XML |
|---|
|
|
| Sample Output - getByQuery() - XML |
|---|
|
|