Area Hierarchy Structure

Area Structure Overview

Areas are related with a parent child relationship.

The Parent Area represents the highest level or the broadest geographical region. It encompasses everything and serves as the main area. These parent areas are split into multiple regions identified by the Fiber Network Operator.

The Child Area represents smaller geographical regions that fall within the parent area. They are subsets or subdivisions of the parent area and are often more specific in their scope.

Each area contains an area type this represents the type of the area.

Endpoints Used

1. GET /area-types
   1. This endpoint will return the area types on the area.
2. GET /areas
   1. This endpoint will return the area types on the area.

Goal

Get a list of area types from the endpoint and use the information in the areas call to get the areas with the type.

Steps to Follow

1. Go to the area types endpoint:

   1. Use the appropriate API endpoint URL to access the area types shown in the Endpoint Used section.
   2. This endpoint should provide a list of available area types.

2. Record the enabled area types:

   1. Check the response from the area types endpoint.
   2. Record the area types that are enabled or available for selection.
   3. Store this information for later use in subsequent requests.

3. Run a GET request to the areas' endpoint:

   1. Use the areas endpoint URL you can find in the API Specification document.
   2. Include the parameter type: {Required Area_Type_Id} in the request.
   3. Replace {Required Area_Type_Id} with the specific area type ID of the areas you want to retrieve.

4. Retrieve the results:

   1. Send the GET request.
   2. The response will contain all the areas with the specified area type.
   3. Handle the response data as needed for further processing or analysis.