Get Map File List

Last Updated on : 2022-01-18 06:18:44

Get a list of map files on pages based on the file type. The minimum value of the page number is 1. No more than 1,000 items can be returned on each page. In case of exceeding 1,000 items, only the first 1,000 items are displayed.

API address

GET: /v1.0/users/sweepers/file/{device_id}/list

Request parameter

Parameter nameTypeINRequiredDescription
device_idStringuritrueThe device ID.
file_typeStringquerytrueThe file type. Valid values:
  • pic: a single map.
  • collect_recode: multiple maps.
start_timeIntegerqueryfalseThe start timestamp.
end_timeIntegerqueryfalseThe end timestamp.
page_noIntegerquerytrueThe page number. Minimum value: 1.
page_sizeIntegerquerytrueThe number of items returned on each page. Maximum value: 1,000.

Return parameter

Parameter nameTypeDescription
resultSweeperCleaningResultVOThe object of file information.

Description of result

Parameter nameTypeDescription
datasListThe object list of cleaning record files.
total_countLongThe total number of results.
has_moreBooleanSpecifies whether to return the next page.

Description of datas

Parameter nameTypeDescription
idLongThe record ID of a specified file.
extendStringThe extension information about a file.
timeIntegerThe timestamp when a file is generated.
file_nameStringThe file name.

Request example

GET: /v1.0/users/sweepers/file/6c6561cfb316df6e7a****/list?fileType=pic&pageNo=1&pageSize=10

Return example

{
    "result": {
        "datas": [
            {
                "extend": "yxzne56c96fb00522aa7_1639211017_1640779297_1640779735_6_****.txt",
                "id": 14428924,
                "time": 1640779772
            },
            {
                "extend": "yxzne56c96fb00522aa7_1639211017_1640414644_1640416159_17_****.txt",
                "id": 14272580,
                "time": 1640416221
            }
        ],
        "total_count": 2,
        "has_more": false
    },
    "t": 1641882023112,
    "success": true
}

Error code

For more information, see error code.