GET authorisation/ping

This is provided simply to be able to test whether the access/bearer token issued is valid

Request Information

URI Parameters

Name Description Type Additional information
WsAccessKey The Web Service access key for this user and file which allows access to the API for the associated file (found in File - Settings). Using OAuth authentication mechanism is the preferred method to allow API access. string

Optional. Legacy authentication method and only required if not using OAuth. OAuth is preferred.
FileId Specifies the file id of the file to perform the operation upon. integer

Required

Body Parameters

None.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample: 
true

application/xml, text/xml

Sample: 
<boolean>true</boolean>