Districts
API endpoint to get information about District entities
Retrieve district data
GET
Supported Protocol: HTTPS
GET /api/:version_number/:project_name/entity/store/district?:pagination_params
curl -K -H "Authorization: Auth-Token YOUR_PROJECT-API-KEY" https://services.traxretail.com/api/v4/my-project/entity/store/district?sort=distirct_name&page=1&per_page=10
metadata object
Info related to pagination
district Object[]
List of districts, each containing the following fields:
district_name string
District name (District names that have been configured in coordination with Trax implementation team)
is_deleted boolean
True/False
district_code number
Code of the given district
Request Details
Mandatory fields marked indicated by
*
{
"metadata": {
"page": 1,
"per_page": 200,
"page_count": 1,
"total_count": 1,
"links": {
"self": "?page=0&per_page=200",
"first": "?page=0&per_page=200",
"previous": "",
"next": "",
"last": ""
}
},
"district": [
{
"district_name": "My-district",
"district_code": null,
"is_deleted": false
},
{
"district_name": "My district-1",
"district_code": null,
"is_deleted": false
}
]
}
Response
Response Details
The Districts GET reply body will contain the following fields:
Validation and Errors
The following are the validations and errors that may appear due to an invalid GET request:
Incorrect or expired token
-
Error Code: 401 - Unauthorized
-
Error: Incorrect or expired token
Requesting a forbidden resource
-
Error Code: 403 - Forbidden
-
Error: A forbidden resource has been requested <resource>
Request Headers
Authorization string
Value: 'Auth-Token {project auth token}'
Authentication token provided by Trax
Query Parameters
version_number string *
The current implemented API version. <Major> version (e.g. 'v4')
project_name string *
Project name as provided by Trax
pagination params
For more info see the pagination page. By default the first page will be returned first