-
Notifications
You must be signed in to change notification settings - Fork 0
Version
sadhasivam edited this page Sep 10, 2024
·
1 revision
URL: /api/admin/viewVersions
Method: GET
Description: Displays the list of versions.
This endpoint does not require any parameters.
{
"success": true,
"message": "",
"data": [
{
"version_id": 63523,
"product_id": 256,
"version_number": "v3.0.1",
"version_date": "2024-08-21",
"version_upgrade_count": 0,
"version_status": 1,
"product_title": "Test Product",
"callback_count": 0,
"product": [
{
"product_id": 256,
"product_title": "Test Product"
}
]
},
{
"version_id": 63522,
"product_id": 255,
"version_number": "v8.1",
"version_date": "2024-08-21",
"version_upgrade_count": 0,
"version_status": 1,
"product_title": "New Product",
"callback_count": 0,
"product": [
{
"product_id": 256,
"product_title": "New Product"
}
]
},
]
}URL: /api/admin/versionView/{version_id}
Method: GET
Description: Displays detailed information about a specific version.
| Parameter | Type | Required/Optional | Description |
|---|---|---|---|
version_id |
Integer | Required | The ID of the version whose details you want to retrieve. |
{
"success": true,
"message": "Version details are displayed here",
"data": {
"version_id": 63523,
"product_id": 256,
"version_number": "Test Product",
"version_install_file": "",
"version_install_query": "",
"version_raw_install_query": "",
"version_upgrade_file": "",
"version_upgrade_query": "",
"version_raw_upgrade_query": "",
"version_install_limit": 0,
"version_install_count": 0,
"version_upgrade_limit": 0,
"version_upgrade_count": 0,
"version_changelog": "",
"version_date": "2024-08-21",
"version_expire_date": "2024-08-21",
"version_comments": "",
"version_status": 1,
"expired": 1,
"created_at": null,
"updated_at": null,
"product": [
{
"product_id": 256,
"product_title": "Test Product",
}
]
}
}URL: /api/admin/versionCallbacks/{version_id}
Method: GET
Description: Displays the callbacks associated with a specific version.
| Parameter | Type | Required/Optional | Description |
|---|---|---|---|
version_id |
Integer | Required | The ID of the version for which callbacks are to be retrieved. |
{
"success": true,
"message": "All version callbacks are displayed here",
"data": [
{
"callback_id": 4699,
"version_id": 63321,
"callback_ip": "78.89.2.36",
"callback_date_time": "2024-03-22 16:40:32",
"callback_status": 1,
"callback_type": "Upgrade"
},
{
"callback_id": 4677,
"version_id": 63321,
"callback_ip": "121.18.53.38",
"callback_date_time": "2024-03-18 06:46:11",
"callback_status": 1,
"callback_type": "Upgrade"
},
]
}URL: /api/admin/versions/add
Method: POST
Description: Adds a new version.
| Parameter | Type | Required/Optional | Description |
|---|---|---|---|
product_id |
Integer | Required | The ID of the product for which the version is being added. |
api_key_secret |
String | Required | The secret key for API authentication. |
version_number |
String | Required | The version number of the product. |
version_status |
Integer | Required | The status of the version (e.g., 0 for inactive, 1 for active). |
version_install_file |
File | Optional | The installation archive file for the version. |
version_install_query |
File | Optional | The installation query file for the version. |
version_raw_install_query |
String | Optional | The raw installation query for the version. |
version_upgrade_file |
File | Optional | The upgrade archive file for the version. |
version_upgrade_query |
File | Optional | The upgrade query file for the version. |
version_raw_upgrade_query |
String | Optional | The raw upgrade query for the version. |
version_install_limit |
Integer | Optional | The limit on the number of installations for this version. |
version_upgrade_limit |
Integer | Optional | The limit on the number of upgrades for this version. |
version_changelog |
String | Optional | The changelog for this version. |
version_expire_date |
String | Optional | The expiration date of the version. |
version_comments |
String | Optional | Additional comments about the version. |
{
"api_action_success":1,
"api_error_detected":0,
"action_success":1,
"error_detected":0,
"page_message":"Test Product version V3.1.23 added."
}
URL: /api/admin/versions/edit
Method: POST
Description: Updates an existing version.
| Parameter | Type | Required/Optional | Description |
|---|---|---|---|
product_id |
Integer | Required | The ID of the product for which the version is being Updated. |
api_key_secret |
String | Required | The secret key for API authentication. |
version_number |
String | Required | The version number of the product. |
version_status |
Integer | Required | The status of the version (e.g., 0 for inactive, 1 for active). |
version_install_file |
File | Optional | The installation archive file for the version. |
version_install_query |
File | Optional | The installation query file for the version. |
version_raw_install_query |
String | Optional | The raw installation query for the version. |
version_upgrade_file |
File | Optional | The upgrade archive file for the version. |
version_upgrade_query |
File | Optional | The upgrade query file for the version. |
version_raw_upgrade_query |
String | Optional | The raw upgrade query for the version. |
version_install_limit |
Integer | Optional | The limit on the number of installations for this version. |
version_upgrade_limit |
Integer | Optional | The limit on the number of upgrades for this version. |
version_changelog |
String | Optional | The changelog for this version. |
version_expire_date |
String | Optional | The expiration date of the version. |
version_comments |
String | Optional | Additional comments about the version. |
{
"api_action_success":1,
"api_error_detected":0,
"action_success":1,
"error_detected":0,
"page_message":"Test Product version V3.1.23 updated."
}
URL: /api/admin/versions/delete
Method: POST
Description: Deletes a specified version.
| Parameter | Type | Required/Optional | Description |
|---|---|---|---|
version_id |
Integer | Required | The ID of the version to be deleted. |
api_key_secret |
String | Required | The API key used to authenticate the request. |
{
"success": true,
"message": "The record you have selected has been deleted successfully",
"data": 1
}