Zone APIs
This section details about the service APIs for the Zones
This service will verify if the logged-in user is authorized to view the RID history.
GET /zones/authorize/{rid}
Resource Details | Description |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
rid | yes | rid for which user wants to know the history | | |
{
"id": null,
"version": null,
"responsetime": "2020-07-08T06:08:26.654Z",
"metadata": null,
"response": true,
"errors": null
}
This service will fetch the logged-in user zone hierarchy.
GET /zones/hierarchy/{langCode}
Resource Details | Description |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
langCode | yes | user language code | | |
{
"id": null,
"version": null,
"responsetime": "2019-11-18T06:04:39.194Z",
"metadata": null,
"response": [
{
"isActive": true,
"createdBy": "superadmin",
"createdDateTime": "2019-08-27T12:28:10.549Z",
"updatedBy": null,
"updatedDateTime": null,
"isDeleted": null,
"deletedDateTime": null,
"code": "STT",
"langCode": "eng",
"name": "Settat",
"hierarchyLevel": 3,
"hierarchyName": "Province",
"parentZoneCode": "CST",
"hierarchyPath": "MOR/NTH/CST/STT"
}
],
"errors": []
}
This service will fetch the logged-in user zone hierarchy leaf zones.
GET /zones/leafs/{langCode}
Resource Details | Description |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
langCode | yes | user language code | |