GetZoneList
Get Zone List under the App
Request address
POST
http://OmsAddress/app/newoms.php/webservice/business/app/get-zone-list?cmd=10010&ip-type=webservicerest&access-token=AccessTokenVal
POST request parameter description
| Parameter name | Data type | Description | Whether the field is required | Remarks |
|---|---|---|---|---|
| app_id | integer | App id of a zone | Yes | |
| set_id | integer | Set id of a game zone | No. If not specified, the zone list under all sets will be returned |
Data Parameters
Use json format to represent the record related information. The following is an example:
{
"set_id": 1,
"app_id": 2
}
Return Syntax
Return Parameter Description
When the returned status code is not 200, it indicates that the query was unsuccessful, and the returned data is error information
When the returned status code is 200, it indicates that the query was successful, and the returned information is the specified set_id and app_id
Request Example
Send A Request through the Curl Method
For the parameters in the command, please refer to the "Description of POST Request Parameters" on this page. For the method to obtain access-token, see: Get access-token
curl -H "Content-type: application/json" -X "POST" -d '{
"set_id": 1,
"app_id": 2
}' http://omsaddress/app/newoms.php/webservice/business/app/get-zone-list?cmd=10010&ip-type=webservicerest&access-token=\
Return Example
Successful Return Example
Status of http request = 200
[
{
"uid": 1,
"set_id": 1,
"app_id": 2,
"zone_id": 3,
"zone_name": "tdr_zone",
"create_date": "2021-06-25 10:38:29",
"zone_tag": "test",
"zone_group": "",
"set_name": "test_set"
},
{
"uid": 3,
"set_id": 1,
"app_id": 2,
"zone_id": 4,
"zone_name": "yyyy",
"create_date": "2021-06-28 10:18:22",
"zone_tag": "",
"zone_group": "",
"set_name": "test_set"
},
{
"uid": 4,
"set_id": 1,
"app_id": 2,
"zone_id": 5,
"zone_name": "aaaa",
"create_date": "2021-06-28 10:18:43",
"zone_tag": "",
"zone_group": "",
"set_name": "test_set"
},
{
"uid": 5,
"set_id": 1,
"app_id": 2,
"zone_id": 6,
"zone_name": "bbbb",
"create_date": "2021-06-28 10:18:53",
"zone_tag": "",
"zone_group": "",
"set_name": "test_set"
},
{
"uid": 6,
"set_id": 1,
"app_id": 2,
"zone_id": 7,
"zone_name": "cccc",
"create_date": "2021-06-28 10:19:01",
"zone_tag": "",
"zone_group": "",
"set_name": "test_set"
}
]
Failed Return Example
Status of http request != 200
{
"name": "Unauthorized",
"message": "You are requesting with an invalid credential.",
"code": 0,
"status": 401,
"type": "yii\\web UnauthorizedHttpException"
}
{
"app_id": [
"ip(10.29.89.68) not in whitelist to query zones info(cmd:10010) of set_id:126 app_id:2"
]
}