API
/web_api/app_config
/web_api/app_config
This page is built from the JSON Schema snapshot in the documentation repository. The snapshot is updated by a separate command from the main app catalog and is not rewritten when the site is built.
Request
main-app://schemas/api_app/app_config.request.json
REQUEST /web_api/app_config
| Name | Type | Required | Constraint |
|---|---|---|---|
* | any | No | other fields allowed |
Response
main-app://schemas/api_app/app_config.response.json
GET|POST /web_api/app_config success
| Name | Type | Required | Constraint |
|---|---|---|---|
api_code | integer | Yes | const 200 |
api_result | object | Yes | no other fields |
empty | boolean | No | - |
Other top-level fields are not allowed.
api_result
| Name | Type | Required | Constraint |
|---|---|---|---|
min_supported_version | string | Yes | - |
latest_version | string | Yes | - |
update_url | object | Yes | no other fields |
maintenance | boolean | Yes | - |
maintenance_message | string | Yes | - |
app_version | string | Yes | - |
platform | enum | Yes | "ios", "android" |
api_result.update_url
| Name | Type | Required | Constraint |
|---|---|---|---|
ios | string | Yes | - |
android | string | Yes | - |
Source schema
The files below are copied from the snapshot unchanged. A $ref fragment is a separate block. The schemas are not merged.
Request: main-app://schemas/api_app/app_config.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_app/app_config.request.json",
"title": "REQUEST /web_api/app_config",
"$ref": "main-app://schemas/_shared/json-object.request.json"
}Fragment: main-app://schemas/_shared/json-object.request.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/_shared/json-object.request.json",
"title": "JSON object body, fields vary by operation",
"type": "object",
"additionalProperties": true
}Response: main-app://schemas/api_app/app_config.response.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/api_app/app_config.response.json",
"title": "GET|POST /web_api/app_config success",
"allOf": [
{ "$ref": "main-app://schemas/_shared/envelope-success.json" },
{
"type": "object",
"properties": {
"api_result": {
"type": "object",
"required": [
"min_supported_version",
"latest_version",
"update_url",
"maintenance",
"maintenance_message",
"app_version",
"platform"
],
"additionalProperties": false,
"properties": {
"min_supported_version": { "type": "string" },
"latest_version": { "type": "string" },
"update_url": {
"type": "object",
"required": ["ios", "android"],
"additionalProperties": false,
"properties": {
"ios": { "type": "string" },
"android": { "type": "string" }
}
},
"maintenance": { "type": "boolean" },
"maintenance_message": { "type": "string" },
"app_version": { "type": "string" },
"platform": { "type": "string", "enum": ["ios", "android"] }
}
}
}
}
]
}Fragment: main-app://schemas/_shared/envelope-success.json
json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "main-app://schemas/_shared/envelope-success.json",
"title": "Canonical success envelope",
"type": "object",
"required": ["api_code", "api_result"],
"properties": {
"api_code": { "const": 200 },
"api_result": true,
"empty": { "type": "boolean" }
},
"additionalProperties": false
}Did this page help?