BCI API Reference - Authenticate and obtain token

BCI API Support Reference (version 1.0)

Authentication

Authenticate and obtain token

URL path:	REST Request	SOAP Request	Base
	https://api.bciaustralia.com/rest/auth.json	https://api.bciaustralia.com/auth.cfc?wsdl	https://api.bciaustralia.com/auth.cfc
Serializable:	Yes
Methods:	doLogin

doLogin
`remote Struct doLogin ( required string clientID, required string password, optional string ver, optional string session_responseformat )` Authenticate to use the BCI API passing username(clientid) and password using HTTPS protocol and obtain a 'token' to be used for any subsequent requests throughout the API. Methods of access are: SOAP: https://api.bciaustralia.com/auth.cfc?method=doLogin&clientid={clientid}&password={password}(&returnFormat=wddx / &returnFormat=json) REST: https://api.bciaustralia.com/rest/auth(.json / .xml)?clientid={clientid}&password={password} Output: Struct Parameters: clientID: string, required - Your clientID or username password: string, required - Password for your account ver: string, optional - Pass the value ver=latest if you wish to use the API in the latest version. This is useful if your account is setup as using a legacy version for backward compatibility. session_responseformat: string, optional - Pass the value session_responseformat=json NULL values in JSON response, By default null values are returned as empty strings for numeric fields.

doLogin


	
		remote
	
		Struct
	
	doLogin
	
	(
 	
		
		required string
		
		clientID, 
		
		required string
		
		password,
		
		optional string
		
		ver,
		
		optional string
		
		session_responseformat		
	)

Authenticate to use the BCI API passing username(clientid) and password using HTTPS protocol and obtain a 'token' to be used for any subsequent requests throughout the API.

Methods of access are:

SOAP: https://api.bciaustralia.com/auth.cfc?method=doLogin&clientid={clientid}&password={password}(&returnFormat=wddx / &returnFormat=json)

REST: https://api.bciaustralia.com/rest/auth(.json / .xml)?clientid={clientid}&password={password}

Output: Struct

Parameters:
   clientID: string, required - Your clientID or username
   password: string, required - Password for your account
   ver: string, optional - Pass the value ver=latest if you wish to use the API in the latest version. This is useful if your account is setup as using a legacy version for backward compatibility.
   session_responseformat: string, optional - Pass the value session_responseformat=json NULL values in JSON response, By default null values are returned as empty strings for numeric fields.

Sample Output - doLogin() - XML