| URL path: | REST Request | SOAP Request | Base |
| http://api.bciaustralia.com/rest/projectstagesstatuses.json | http://api.bciaustralia.com/projectstagesstatuses.cfc?wsdl | http://api.bciaustralia.com/projectstagesstatuses.cfc | |
| Serializable: | Yes | ||
| methods: | getByPK, getByQuery |
| getByPK |
|---|
remote
Array
getByPK
(
required numeric
projectstagesid,
string
fields="",
required string
token
)
Get Project Stage / Status Relation by ID Methods of access are: SOAP: http://api.bciaustralia.com/projectstagesstatuses.cfc?wsdl&method=getByPK&projectstageid={projectstageid}(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/projectstagesstatuses/{projectstagesid}(.json / .xml) Output: Array Parameters: projectstagesid: numeric, required - ID of the project Stage fields: string, optional - Field selection in response - PROJECTSTAGESID, PROJECT_STATUSID, REFID token: string, required - allocated token for current login session |
| getByQuery |
remote
Array
getByQuery
(
string
projectstagesid,
string
projectstage,
string
projectstatusid,
string
projectstatus,
string
fields="",
required string
token
)
Get Project Stage / Status Relation by Query (By Stage Name, list of IDs) Methods of access are: SOAP: http://api.bciaustralia.com/projectstagesstatuses.cfc?wsdl&method=getByQuery(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/projectstagesstatuses(.json / .xml) Output: Array Parameters: projectstagesid: string, optional - ID or comma-seperated list of IDs of the project Stages projectstage: string, optional - Name of the Project Stage projectstatusid: string, optional - ID or comma seperated list of IDS of project statuses projectstatus: string, optional - Name of the Project Status fields: string, optional - Field selection in response - PROJECTSTAGESID, PROJECT_STATUSID, REFID token: string, required - allocated token for current login session |
| Fields | ||||||
|---|---|---|---|---|---|---|
| Selectable fields for stage and status relationships | ||||||
|