| URL path: | REST Request | SOAP Request | Base |
| http://api.bciaustralia.com/rest/rolegroups.json | http://api.bciaustralia.com/rolegroups.cfc?wsdl | http://api.bciaustralia.com/rolegroups.cfc | |
| Serializable: | Yes | ||
| Properties: | |||
| Methods: | getByPK, getByQuery |
| getByPK |
|---|
remote
Struct
getByPK
(
required numeric
rolegroupid,
string
fields="",
required string
token
)
Get BCI specific role group information (passing a role groupid). Methods of access are: SOAP: http://api.bciaustralia.com/rolegroups.cfc?wsdl&method=getByPK&rolegroupid={rolegroupid}(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/rolegroups/{rolegroupid}(.json / .xml) Output: Structure Parameters: rolegroupid: numeric, required - role groupid of the specific role information requested fields: string, optional - valid field names for the return structure.Valid fields : ROLE_GROUPID,ROLE_GROUP_NAME,ABBV token: string, required - allocated token for current login session |
| getByQuery |
remote
Array
getByQuery
(
string
rolegroupid,
string
rolegroup,
string
fields="",
required string
token
)
Get specific BCI role group information (passing a role group name or a list of role groupid IDs). Methods of access are: SOAP: http://api.bciaustralia.com/rolegroups.cfc?wsdl&method=getByQuery(&returnFormat=wddx / &returnFormat=json) REST: http://api.bciaustralia.com/rest/rolegroups(.json / .xml) Output: Array Parameters: rolegroupid: string, optional - Role Group ID or comma seperated list of Role Group IDs rolegroup: string, optional - Role Group Name fields: string, optional - valid field names for the return structure.Valid fields : ROLE_GROUPID,ROLE_GROUP_NAME,ABBV token: string, required - allocated token for current login session |
| Fields | ||||||
|---|---|---|---|---|---|---|
| Selectable fields for role groups information | ||||||
|
| Sample Output - getByPK() - XML |
|---|
|
|
| Sample Output - getByQuery() - XML |
|---|
|
|