POST public/getAppUpdateDetails
Returns the current version of the SC//AcuVigil mobile app and links to it in the app stores. The mobile app uses it to tell users when an update is available.
Request syntax
curl https://apiv2.acumera.net/public/getAppUpdateDetails \
--cookie av_session.txt
The username, password, and tfa_token parameters are also accepted, and are required only if the client hasn't already signed in with login. See Getting started with the SC//AcuVigil API.
Request parameters
This function takes no parameters of its own.
Response syntax
{
"success": "string",
"data": {
"app_update_info": {
"current_app_version": "string",
"android_app_link": "string",
"apple_app_link": "string"
}
}
}
Response parameters
If the call succeeds, success is "1" and the following data is returned. All values are strings.
| Field | Description |
|---|---|
app_update_info.current_app_version |
The current version of the mobile app. |
app_update_info.android_app_link |
A link to the app in the Google Play store. |
app_update_info.apple_app_link |
A link to the app in the Apple App Store. |
Errors
If the call fails, success is "0", and returnCode and returnMessage describe the problem. The HTTP status is still 200.
| Return code | Message | Cause |
|---|---|---|
MOBILE_APP_UPDATE_DETAILS_NOT_FOUND |
One or more of the mobile app update information items could not be found. | An item isn't configured on the server. Contact Scale Computing Support. |
INVALID_LOGIN |
We were unable to log you in. Make sure you entered the correct username, password and 2FA code. | You haven't signed in, your session has ended, or the credentials sent with the call are wrong. |
Examples
Example: Get the mobile app version
curl https://apiv2.acumera.net/public/getAppUpdateDetails \
--cookie av_session.txt
Response (values replaced with placeholders):
{
"success": "1",
"data": {
"app_update_info": {
"current_app_version": "<version>",
"android_app_link": "<Google Play store link>",
"apple_app_link": "<Apple App Store link>"
}
}
}