| URL path: | REST Request | SOAP Request | Base |
| https://api.bciaustralia.com/rest/contracttypes.json | https://api.bciaustralia.com/contracttypes.cfc?wsdl | https://api.bciaustralia.com/contracttypes.cfc | |
| Serializable: | Yes | ||
| Properties: | |||
| Methods: | getByPK, getByQuery |
| getByPK |
|---|
remote
Struct
getByPK
(
required numeric
contracttypid,
string
fields="",
required string
token
)
Get BCI specific contract type information (passing a contract type ID). Methods of access are: SOAP: https://api.bciaustralia.com/rolegroups.cfc?wsdl&method=getByPK&contracttypid={contracttypid}(&returnFormat=wddx / &returnFormat=json) REST: https://api.bciaustralia.com/rest/contracttypes/{contracttypid}(.json / .xml) Output: Structure Parameters: contracttypid: numeric, required - ID of the specific contract type information requested fields: string, optional - valid field names for the return structure.Valid fields : CONTRACT_TYPEID, CONTRACT_TYPE token: string, required - allocated token for current login session |
| getByQuery |
remote
Array
getByQuery
(
string
contracttypid,
string
contracttype,
string
fields="",
required string
token
)
Get specific BCI contract type information (passing a contract type name or a list of contract type IDs). Methods of access are: SOAP: https://api.bciaustralia.com/contracttypes.cfc?wsdl&method=getByQuery(&returnFormat=wddx / &returnFormat=json) REST: https://api.bciaustralia.com/rest/contracttypes(.json / .xml) Output: Array Parameters: contracttypid: string, optional - Contract Type ID or comma seperated list of Contract Type IDs contracttype: string, optional - Contract Type Name fields: string, optional - valid field names for the return structure.Valid fields : CONTRACT_TYPEID, CONTRACT_TYPE token: string, required - allocated token for current login session |
| Fields | ||||
|---|---|---|---|---|
| Selectable fields for contract type information | ||||
|
| Sample Output - getByPK() - XML |
|---|
|
|
| Sample Output - getByQuery() - XML |
|---|
|
|