JSON Structures For Level/Org Details

Parameters:

Possible Parameters are :

Root Level Name[Optional]
LevelID[Optional]
Location Name/Code[Optional]
Country[Optional]

Location Details with Hierarchical Org Structure in Breadcrumb/Flat Format :

If the user passes a Level Name as parameter then all locations under that level are displayed. If the user does not pass any Level Name as parameter, then all the locations of the system are displayed.

{
    "Level:     : "By Geography/By Country",
    "LocationId": "1234",
    "LocationCode": "Test",
    "LocationName": "Test",
    "Address": "Test",
    "City": "Test",
    "State": "Test",
    "Country": "Test",
    "Zip": "765432"    
    
}

2. Location Details with Hierarchical Org Structure : [@RootLevel Name - Mandatory && @LocationName or code mandatory]

{
  "Levels": [
    [
       
      "By Division",
      "Sub Level 1",
      "Sub Level 2"
    ],
    [
      "By Geography",
      "Sub Level 11"
    ],
    [
      "By Distribution",
      "Sub Level 21",
      "Sub Level 22",
      "Sub Level 23",
      "Sub Level 24"
    ]
  ],
  "Details": {
    "LocationId"  :"1234",
    "LocationCode": "Test",
    "LocationName": "Test",
    "Address": "Test",
    "City": "Test",
    "State": "Test",
    "Country": "Test",
    "Zip": "765432"
  }

}

3. Org Details [@RootName - mandatory] - Only Level information shown with ID. No location information. For mapping to location we need to call location API with the LevelName & LevelID

{
  "LevelDetails": [
     {
        "LevelName": "By Divison",
        "Id": "1001",
        "ParentId": "1001",
        "ParentLevel": "By Division"
      },
      {
        "LevelName": "Sales",
        "Id": "1002",
        "ParentId": "1001",
        "ParentLevel": "By Division"
      },
       {
        "LevelName": "Canada",
        "Id": "1003",
        "ParentId": "1002",
        "ParentLevel": "Sales"
      },
       {
        "LevelName": "India",
        "Id": "1004",
        "ParentId": "1002",
        "ParentLevel": "Sales"
      },
       {
        "LevelName": "US",
        "Id": "1005",
        "ParentId": "1002",
        "ParentLevel": "Sales"
      },
       {
        "LevelName": "CustomerSuccess",
        "Id": "1006",
        "ParentId": "1001",
        "ParentLevel": "ByDivision"
      }
  ]
}

4. Org Structure with both Locations and Levels :

This would show the linkage between immediate levels/locations.The field “type” will show if it is a Level or a Location. @RootNodeId to be passed as the mandatory parameter.

catuo
{
"OrgDetails" : 
[
{
"uid": 1,
"id": 1003,
"parentid": 1003,
"name": "By Division",
"type": "Level"
},

{
"uid": 2,
"id": 1019,
"parentid": 1003,
"name": "India",
"type": "Level"
},
{
"uid": 3,
"id": 1020,
"parentid": 1003,
"name": "US",
"type": "Level"
},
{
"uid": 4,
"id": 8790,
"parentid": 1020,
"name": "Westlake",
"type": "Location"
},
{
"uid": 5,
"id": 8791,
"parentid": 1019,
"name": "Bhubaneswar",
"type": "Location"
}
]
}