Zone APIs
This section details about the service APIs for the Zones
Zone Master API
GET /zones/authorize/{rid}
This service will verify if the logged-in user is authorized to view the RID history.
Resource URL
GET /zones/authorize/{rid}
Resource details
Resource Details | Description |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Parameters
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
rid | yes | rid for which user wants to know the history |
Example Response
GET /zones/hierarchy/{langCode}
This service will fetch the logged-in user zone hierarchy.
Resource URL
GET /zones/hierarchy/{langCode}
Resource details
Resource Details | Description |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Parameters
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
langCode | yes | user language code |
Example Response
GET /zones/leafs/{langCode}
This service will fetch the logged-in user zone hierarchy leaf zones.
Resource URL
GET /zones/leafs/{langCode}
Resource details
Resource Details | Description |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Parameters
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
langCode | yes | user language code |
Example Response
GET /zones/zonename
This service will fetch the logged-in user zone hierarchy leaf zones.
Resource URL
GET /zones/zonename
Resource details
Resource Details | Description |
---|---|
Response format | JSON |
Requires Authentication | Yes |
Parameters
Name | Required | Description | Default Value | Example |
---|---|---|---|---|
langCode | yes | user language code | ||
userID | yes | user id |
Example Response
Failure details
Error Code | Error Message | Error Description |
---|---|---|
KER-MSD-337 | Error occured while fetching zone | Fetch Issue |
KER-MSD-339 | No zone found for the logged-in user | Data Not Found |
KER-MSD-338 | Error Occured while fetching zone of the user | Fetch Issue |
KER-MSD-391 | Entity for user ID specified Not Found | Data Not Found |
KER-MSD-392 | Entity for Zone Code of user ID specified Not Found | Data Not Found |
KER-MSD-393 | Internal Server Error | Dependency issue |
Last updated