Skip to content

Get all portfolio details

Request

Returns the complete portfolio hierarchy for the current account and user.

Behavior:

  • Validates account and user context
  • Retrieves all accessible portfolio locations
  • Returns structured portfolio response data
  • Logs the action as portfolio details view
curl -i -X GET \
  https://demozone.zlinkfm.com/RND/api/v1/portfolio/all

Responses

OK

Body
dataArray of objects or null(zLink.Business.zOne.Portfolio.ResponseModels.LocationResponseModel)
messagestring or null
isErrorboolean
messageCodeinteger, (int32)
statusstring or null
errorTypestring or null
traceidstring or null
responseDescriptionstring or null
Response
{
  "data": [
    {
      "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
      "locationName": "string",
      "status": {
        "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
        "statusCode": "string",
        "statusName": "string",
        "statusColor": "string"
      },
      "buildings": [
        {
          "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7",
          "buildingName": "string",
          "levels": [
            {
              "levelId": "a70368c7-b12e-43a9-9830-ab2485710b95",
              "levelName": "string",
              "cadPlans": [
                null
              ],
              "spaceDetail": {},
              "orgUnitInfo": [
                null
              ],
              "status": {}
            }
          ],
          "buildingPlans": [
            {
              "planId": "b3f60ba2-c1fd-4b3a-a23d-8e876e0ef75d",
              "planType": {},
              "planDescription": "string",
              "planModel": {},
              "planFile": {},
              "revisions": [
                null
              ],
              "locationInfo": {
                "cadPlanCoordinates": []
              },
              "assetIds": [
                null
              ],
              "svgPlanAdded": true,
              "responseDescription": "string",
              "hasAnyRevisions": true,
              "isPlanRemoved": true,
              "responseMessage": "string",
              "isCadPlanExist": true
            }
          ],
          "buildingType": "string",
          "cadPlans": [
            {
              "planId": "b3f60ba2-c1fd-4b3a-a23d-8e876e0ef75d",
              "planType": {},
              "planDescription": "string",
              "planModel": {},
              "planFile": {},
              "revisions": [
                null
              ],
              "locationInfo": {
                "cadPlanCoordinates": []
              },
              "assetIds": [
                null
              ],
              "svgPlanAdded": true,
              "responseDescription": "string",
              "hasAnyRevisions": true,
              "isPlanRemoved": true,
              "responseMessage": "string",
              "isCadPlanExist": true
            }
          ],
          "location": {
            "type": "string",
            "features": [
              {
                "properties": {},
                "geometry": {}
              }
            ]
          },
          "spaceDetail": {
            "numberOfDepartments": 0,
            "totalArea": 0.1,
            "usableArea": 0.1,
            "occupied": 0,
            "vacant": 0
          },
          "status": {
            "statusId": "e900225c-0629-4e96-be6e-86a17a309645",
            "statusCode": "string",
            "statusName": "string",
            "statusColor": "string"
          },
          "responseDescription": "string",
          "latLong": [
            0.1
          ],
          "latitude": 0.1,
          "longitude": 0.1
        }
      ],
      "buildingPlans": [
        {
          "planId": "b3f60ba2-c1fd-4b3a-a23d-8e876e0ef75d",
          "planType": {
            "planTypeId": "0516887d-9268-43c8-b82e-1501d9714a9a",
            "planTypeName": "string"
          },
          "planDescription": "string",
          "planModel": {
            "planModelId": "9eed1a98-11cb-4f43-8459-1812e5594dc9",
            "planModelName": "string"
          },
          "planFile": {
            "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
            "fileName": "string",
            "fileSize": "string",
            "currentRevisionNumber": 0,
            "createdOn": "string",
            "fileSizeInBytes": 0,
            "createdDate": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "isLatest": true
          },
          "revisions": [
            {
              "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
              "fileName": "string",
              "fileSize": "string",
              "currentRevisionNumber": 0,
              "createdOn": "string",
              "fileSizeInBytes": 0,
              "createdDate": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "isLatest": true
            }
          ],
          "locationInfo": {
            "location": "string",
            "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
            "building": "string",
            "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7",
            "level": "string",
            "levelId": "a70368c7-b12e-43a9-9830-ab2485710b95",
            "room": "string",
            "roomId": "c3631f02-ff67-42b8-8775-18c47f52a678",
            "workspace": "string",
            "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
            "spaceKey": "string",
            "spaceAssignedOn": "string",
            "spaceCategory": {
              "spaceCategoryId": "809d6029-69b4-43c2-a738-11abe5eaf804",
              "spaceCategoryName": "string",
              "spaceCategoryCode": "string"
            },
            "roomFunction": {
              "roomFunctionId": "21215e30-d522-4a6e-b350-1cf0e9b3df3c",
              "roomFunctionName": "string"
            },
            "spaceArea": 0.1,
            "levelPlanHandle": "string",
            "employeeLocationId": "2e9ca96c-a4c6-4bdb-b2bb-33d9e60c3f1c",
            "rollBackInfo": {
              "isRollBack": true,
              "rollBackType": "string",
              "employeeLocationId": "2e9ca96c-a4c6-4bdb-b2bb-33d9e60c3f1c",
              "comments": "string"
            },
            "levelPlanId": "0f5a21ff-233b-4dbc-8296-4521bcd60dc1",
            "planFile": {
              "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
              "fileName": "string",
              "fileSize": "string",
              "currentRevisionNumber": 0,
              "createdOn": "string",
              "fileSizeInBytes": 0,
              "createdDate": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "isLatest": true
            },
            "cadPlanCoordinates": [
              0.1
            ],
            "spaceAssignedOnDateTimeFormat": "string",
            "svgPlanAdded": true
          },
          "assetIds": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "svgPlanAdded": true,
          "responseDescription": "string",
          "hasAnyRevisions": true,
          "isPlanRemoved": true,
          "responseMessage": "string",
          "isCadPlanExist": true
        }
      ],
      "location": {
        "type": "string",
        "features": [
          {
            "type": "string",
            "id": 0,
            "properties": {
              "property1": null,
              "property2": null
            },
            "geometry": {
              "property1": null,
              "property2": null
            }
          }
        ]
      },
      "cadPlans": [
        {
          "planId": "b3f60ba2-c1fd-4b3a-a23d-8e876e0ef75d",
          "planType": {
            "planTypeId": "0516887d-9268-43c8-b82e-1501d9714a9a",
            "planTypeName": "string"
          },
          "planDescription": "string",
          "planModel": {
            "planModelId": "9eed1a98-11cb-4f43-8459-1812e5594dc9",
            "planModelName": "string"
          },
          "planFile": {
            "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
            "fileName": "string",
            "fileSize": "string",
            "currentRevisionNumber": 0,
            "createdOn": "string",
            "fileSizeInBytes": 0,
            "createdDate": "2019-08-24T14:15:22Z",
            "createdBy": "string",
            "isLatest": true
          },
          "revisions": [
            {
              "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
              "fileName": "string",
              "fileSize": "string",
              "currentRevisionNumber": 0,
              "createdOn": "string",
              "fileSizeInBytes": 0,
              "createdDate": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "isLatest": true
            }
          ],
          "locationInfo": {
            "location": "string",
            "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
            "building": "string",
            "buildingId": "fee3295a-6e55-45b0-a091-7b4de7e39de7",
            "level": "string",
            "levelId": "a70368c7-b12e-43a9-9830-ab2485710b95",
            "room": "string",
            "roomId": "c3631f02-ff67-42b8-8775-18c47f52a678",
            "workspace": "string",
            "workspaceId": "ef0efa32-d1c1-43d4-a5e2-fe7b4f00403c",
            "spaceKey": "string",
            "spaceAssignedOn": "string",
            "spaceCategory": {
              "spaceCategoryId": "809d6029-69b4-43c2-a738-11abe5eaf804",
              "spaceCategoryName": "string",
              "spaceCategoryCode": "string"
            },
            "roomFunction": {
              "roomFunctionId": "21215e30-d522-4a6e-b350-1cf0e9b3df3c",
              "roomFunctionName": "string"
            },
            "spaceArea": 0.1,
            "levelPlanHandle": "string",
            "employeeLocationId": "2e9ca96c-a4c6-4bdb-b2bb-33d9e60c3f1c",
            "rollBackInfo": {
              "isRollBack": true,
              "rollBackType": "string",
              "employeeLocationId": "2e9ca96c-a4c6-4bdb-b2bb-33d9e60c3f1c",
              "comments": "string"
            },
            "levelPlanId": "0f5a21ff-233b-4dbc-8296-4521bcd60dc1",
            "planFile": {
              "fileId": "a1c6a2ab-4b01-4253-b4c9-70e04b3b48fc",
              "fileName": "string",
              "fileSize": "string",
              "currentRevisionNumber": 0,
              "createdOn": "string",
              "fileSizeInBytes": 0,
              "createdDate": "2019-08-24T14:15:22Z",
              "createdBy": "string",
              "isLatest": true
            },
            "cadPlanCoordinates": [
              0.1
            ],
            "spaceAssignedOnDateTimeFormat": "string",
            "svgPlanAdded": true
          },
          "assetIds": [
            "497f6eca-6276-4993-bfeb-53cbbbba6f08"
          ],
          "svgPlanAdded": true,
          "responseDescription": "string",
          "hasAnyRevisions": true,
          "isPlanRemoved": true,
          "responseMessage": "string",
          "isCadPlanExist": true
        }
      ],
      "spaceDetail": {
        "numberOfDepartments": 0,
        "totalArea": 0.1,
        "usableArea": 0.1,
        "occupied": 0,
        "vacant": 0
      },
      "responseDescription": "string",
      "latitude": 0.1,
      "longitude": 0.1
    }
  ],
  "message": "string",
  "isError": true,
  "messageCode": 0,
  "status": "string",
  "errorType": "string",
  "traceid": "string",
  "responseDescription": "string"
}