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