Skip to content

Floor Plan Job Query

Description

This response provides detailed information about a specific floor plan job, including metadata, status, results, and additional data related to the job.

GET api/v9/mapscale/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/levels/{levelIndex}/floor-plan-jobs/{floorPlanId}

Statuses: 

- Received
- InProgress
- AwaitingManualReview
- Success
- Failure
- Cancelled
- Declined

Success Response:

{
  "floorPlanJobId": "01942726-b7b4-752f-b1a2-3659730a20a0",
  "clientIdentifier": "2c54c6cf-6ae1-4892-861f-3347a3fe75f9",
  "siteIdentifier": "644f1f9b-a7e0-45e8-b4de-06e288e82915",
  "buildingIdentifier": "ea2394c2-4826-4d70-bf93-ab43f7d66cbe",
  "levelIdentifier": "1a2394c2-4826-4d70-bf93-ab43f7d66cbe",
  "levelIndex": 0,
  "createdDate": "2025-01-02T13:13:56.404295Z",
  "updatedDate": "2025-01-02T13:19:34.393611Z",
  "finishedDate": "2025-01-02T13:19:34.327643Z",
  "fileUrl": "floor plan file url will be here",
  "resultUrl": "result url will be here",
  "errorMessage": "",
  "status": "Success",
  "isPreciseGeorefencingRequested": false,
  "reviewRequest": "MappingTeamReview",
  "extra": {
    "notes": "notessasd",
    "testid": "1234"
  },
  "resultExtra": {
    "areaSqFeet": 61408,
    "areaSqM": 5705,
    "circulationCoveragePercentage": 77,
    "unitCoveragePercentage": 23,
    "internalStatus": [
      {
        "message": "Not started yet",
        "name": "Initialization",
        "progress": 0
      },
      {
        "message": "Not started yet",
        "name": "Downloading CAD File",
        "progress": 0
      },
      {
        "message": "Not started yet",
        "name": "Preparing CAD Entities",
        "progress": 0
      },
      {
        "message": "Not started yet",
        "name": "Drawing",
        "progress": 0
      },
      {
        "message": "Not started yet",
        "name": "Finding Structural Elements",
        "progress": 0
      },
      {
        "message": "Not started yet",
        "name": "Finding Walls",
        "progress": 0
      },
      {
        "message": "Not started yet",
        "name": "Finding Units",
        "progress": 0
      },
      {
        "message": "Not started yet",
        "name": "Finding Furniture",
        "progress": 0
      },
      {
        "message": "Not started yet",
        "name": "Finalizing",
        "progress": 0
      },
      {
        "message": "Not started yet",
        "name": "Uploading",
        "progress": 0
      }
    ]
  },
  "aiProcessingStartedAt": "2025-01-02T13:14:03.473662Z",
  "aiRequestReceivedAt": "2025-01-02T13:14:03.46452Z",
  "aiProcessingFinishedAt": "2025-01-02T13:16:52.047486Z",
  "declineMessage": "",
  "warningMessage": "Test Message",
  "cancelMessage": ""
}

Response Fields:

  • FloorplanjobId: (guid) The unique identifier for the floor plan job.
  • CreatedDate: (string) The date and time when the job was created, in ISO 8601 format.
  • UpdatedDate: (string) The date and time when the job was last updated, in ISO 8601 format.
  • FinishedDate: (string) The date and time when the job was finished, in ISO 8601 format.
  • FileUrl: (string) The URL to the original floor plan file.
  • ResultUrl: (string) The URL to the result file generated by the job.
  • ErrorMessage: (string) A message indicating any errors related to the job (if applicable).
  • Status: (string) The current status of the job (e.g., "AwaitingReview").
  • IsPreciseGeorefencingRequested: (boolean) Indicates whether precise georeferencing is requested.
  • ReviewRequest: (string) The type of review requested for the job (e.g., "MappingTeamReview").


* You can access the possible response codes you may encounter here.

Floor Plan Job Detailed

Description

This response provides detailed information about a specific floor plan job.

GET api/v9/mapscale/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/levels/{levelIndex}/floor-plan-jobs/{floorPlanId}/detailed

Success Response:

{
  "floorPlanJobId": "71bed585-79cc-41ff-ba3d-8bba66e35461",
  "resultExtra": {
    "areaSqFeet": 61408,
    "areaSqM": 5705,
    "cadCoordinatesGeojson": "cad coordinates geojson url will be comes here",
    "circulationCoveragePercentage": 77,
    "explodedDXF": "exploded dxf url will be comes here",
    "internalStatus": [
      {
        "message": "Initialization",
        "name": "Initialization",
        "progress": 1
      },
      {
        "message": "Downloading CAD File",
        "name": "Downloading CAD File",
        "progress": 1
      },
      {
        "message": "Preparing CAD Entities",
        "name": "Preparing CAD Entities",
        "progress": 1
      },
      {
        "message": "Drawing",
        "name": "Drawing",
        "progress": 1
      },
      {
        "message": "Finding Structural Elements",
        "name": "Finding Structural Elements",
        "progress": 1
      },
      {
        "message": "Finding Walls",
        "name": "Finding Walls",
        "progress": 1
      },
      {
        "message": "Finding Units",
        "name": "Finding Units",
        "progress": 1
      },
      {
        "message": "Finding Furniture",
        "name": "Finding Furniture",
        "progress": 1
      },
      {
        "message": "Finalizing",
        "name": "Finalizing",
        "progress": 1
      },
      {
        "message": "Uploading",
        "name": "Uploading",
        "progress": 1
      }
    ],
    "mappingPackage": "mapping package url will be comes here",
    "previewImage": "preview image url will be comes here",
    "rasterCad": "raster cad url will be comes here",
    "unitCoveragePercentage": 23
  },
  "aiProcessingStartedAt": "2025-06-13T12:21:02.472902Z",
  "aiRequestReceivedAt": "2025-06-13T12:20:02.472926Z",
  "aiProcessingFinishedAt": "2025-06-13T12:22:02.472914Z",
  "internalMapResult": "internal map result will be comes here",
  "location": null,
  "georeferencing": {
    "anchors": [
      {
        "originalCoordinates": [
          100,
          200
        ],
        "coordinates": [
          -72.74199264368674,
          41.81341672831643
        ]
      },
      {
        "originalCoordinates": [
          2500,
          900
        ],
        "coordinates": [
          -72.74432602905546,
          41.81245557927655
        ]
      }
    ]
  }
}


* You can access the possible response codes you may encounter here.

Client's Level Floor Plan Jobs

GET api/v9/mapscale/clients/{clientIdentifier}/floor-plan-jobs

Query Parameters

Parameter Type Required Default Description
skip integer No 0 Number of records to skip. Used for pagination.
take integer No 10 Number of records to return. Limits the size of the page.

Success Response:

[
    {
        "floorPlanJobId": "01942726-b7b4-752f-b1a2-3659730a20a0",
        "clientIdentifier": "2c54c6cf-6ae1-4892-861f-3347a3fe75f9",
        "siteIdentifier": "644f1f9b-a7e0-45e8-b4de-06e288e82915",
        "buildingIdentifier": "ea2394c2-4826-4d70-bf93-ab43f7d66cbe",
        "levelIdentifier": "1a2394c2-4826-4d70-bf93-ab43f7d66cbe",
        "levelIndex": 0,
        "createdDate": "2025-01-02T13:13:56.404295Z",
        "updatedDate": "2025-01-02T13:19:34.393611Z",
        "finishedDate": "2025-01-02T13:19:34.327643Z",
        "fileUrl": "floor plan file url will be here",
        "resultUrl": "result url will be here",
        "errorMessage": "",
        "status": "Success",
        "isPreciseGeorefencingRequested": false,
        "reviewRequest": "MappingTeamReview",
        "extra": {
            "notes": "notessasd",
            "testid": "1234"
        },
        "resultExtra": {
            "areaSqFeet": 61408,
            "areaSqM": 5705,
            "circulationCoveragePercentage": 77,
            "unitCoveragePercentage": 23,
            "internalStatus": [
              {
                "message": "Not started yet",
                "name": "Initialization",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Downloading CAD File",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Preparing CAD Entities",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Drawing",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finding Structural Elements",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finding Walls",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finding Units",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finding Furniture",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finalizing",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Uploading",
                "progress": 0
              }
            ]
        },
        "aiProcessingStartedAt": "2025-01-02T13:14:03.473662Z",
        "aiRequestReceivedAt": "2025-01-02T13:14:03.46452Z",
        "aiProcessingFinishedAt": "2025-01-02T13:16:52.047486Z",
        "declineMessage": "",
        "warningMessage": "Test Message",
        "cancelMessage": ""
    }
]


* You can access the possible response codes you may encounter here.

Site's Level Floor Plan Jobs

GET api/v9/mapscale/clients/{clientIdentifier}/sites/{siteIdentifier}/floor-plan-jobs

Query Parameters

Parameter Type Required Default Description
skip integer No 0 Number of records to skip. Used for pagination.
take integer No 10 Number of records to return. Limits the size of the page.

Success Response:

[
    {
        "floorPlanJobId": "01942726-b7b4-752f-b1a2-3659730a20a0",
        "clientIdentifier": "2c54c6cf-6ae1-4892-861f-3347a3fe75f9",
        "siteIdentifier": "644f1f9b-a7e0-45e8-b4de-06e288e82915",
        "buildingIdentifier": "ea2394c2-4826-4d70-bf93-ab43f7d66cbe",
        "levelIdentifier": "1a2394c2-4826-4d70-bf93-ab43f7d66cbe",
        "levelIndex": 0,
        "createdDate": "2025-01-02T13:13:56.404295Z",
        "updatedDate": "2025-01-02T13:19:34.393611Z",
        "finishedDate": "2025-01-02T13:19:34.327643Z",
        "fileUrl": "floor plan file url will be here",
        "resultUrl": "result url will be here",
        "errorMessage": "",
        "status": "Success",
        "isPreciseGeorefencingRequested": false,
        "reviewRequest": "MappingTeamReview",
        "extra": {
            "notes": "notessasd",
            "testid": "1234"
        },
        "resultExtra": {
            "areaSqFeet": 61408,
            "areaSqM": 5705,
            "circulationCoveragePercentage": 77,
            "unitCoveragePercentage": 23,
            "internalStatus": [
              {
                "message": "Not started yet",
                "name": "Initialization",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Downloading CAD File",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Preparing CAD Entities",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Drawing",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finding Structural Elements",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finding Walls",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finding Units",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finding Furniture",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finalizing",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Uploading",
                "progress": 0
              }
            ]
        },
        "aiProcessingStartedAt": "2025-01-02T13:14:03.473662Z",
        "aiRequestReceivedAt": "2025-01-02T13:14:03.46452Z",
        "aiProcessingFinishedAt": "2025-01-02T13:16:52.047486Z",
        "declineMessage": "",
        "warningMessage": "Test Message",
        "cancelMessage": ""
    }
]


* You can access the possible response codes you may encounter here.

Building's Level Floor Plan Jobs

GET api/v9/mapscale/clients/{clientIdentifier}/sites/{siteIdentifier}/buildings/{buildingIdentifier}/floor-plan-jobs

Query Parameters

Parameter Type Required Default Description
skip integer No 0 Number of records to skip. Used for pagination.
take integer No 10 Number of records to return. Limits the size of the page.

Success Response:

[
    {
        "floorPlanJobId": "01942726-b7b4-752f-b1a2-3659730a20a0",
        "clientIdentifier": "2c54c6cf-6ae1-4892-861f-3347a3fe75f9",
        "siteIdentifier": "644f1f9b-a7e0-45e8-b4de-06e288e82915",
        "buildingIdentifier": "ea2394c2-4826-4d70-bf93-ab43f7d66cbe",
        "levelIdentifier": "1a2394c2-4826-4d70-bf93-ab43f7d66cbe",
        "levelIndex": 0,
        "createdDate": "2025-01-02T13:13:56.404295Z",
        "updatedDate": "2025-01-02T13:19:34.393611Z",
        "finishedDate": "2025-01-02T13:19:34.327643Z",
        "fileUrl": "floor plan file url will be here",
        "resultUrl": "result url will be here",
        "errorMessage": "",
        "status": "Success",
        "isPreciseGeorefencingRequested": false,
        "reviewRequest": "MappingTeamReview",
        "extra": {
            "notes": "notessasd",
            "testid": "1234"
        },
        "resultExtra": {
            "areaSqFeet": 61408,
            "areaSqM": 5705,
            "circulationCoveragePercentage": 77,
            "unitCoveragePercentage": 23,
            "internalStatus": [
              {
                "message": "Not started yet",
                "name": "Initialization",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Downloading CAD File",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Preparing CAD Entities",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Drawing",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finding Structural Elements",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finding Walls",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finding Units",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finding Furniture",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Finalizing",
                "progress": 0
              },
              {
                "message": "Not started yet",
                "name": "Uploading",
                "progress": 0
              }
            ]
        },
        "aiProcessingStartedAt": "2025-01-02T13:14:03.473662Z",
        "aiRequestReceivedAt": "2025-01-02T13:14:03.46452Z",
        "aiProcessingFinishedAt": "2025-01-02T13:16:52.047486Z",
        "declineMessage": "",
        "warningMessage": "Test Message",
        "cancelMessage": ""
    }
]


* You can access the possible response codes you may encounter here.

Get Floorplans

GET api/v9/mapscale/floor-plan-jobs

This endpoint allows you to Get floorplan data from the server with filtering and sorting options. Additionally, the response includes a total result count to enable pagination.

Filtering Options:

  • You can filter the data using the following columns:
Field Filtering Type Notes
clientidentifier Multiple Selection Filters data for multiple clients simultaneously. If not provided, all results are returned.
floorplan submission start date Date-Time Field Filters floorplan jobs submitted after the specified date/time.
floorplan submission end date Date-Time Field Filters floorplan jobs submitted before the specified date/time.
status Multiple Selection Filters floorplan jobs by multiple statuses.
extra Text Search Searches by tenantid or performs a general search in extra for better filtering.
floorPlanJobId Guid Field Filters floorplan jobs by floorPlanJobId

Sorting Options - To sort the results, specify the column name and sorting order (asc or desc).

Result Count - The response includes a resultcount field that provides the total number of results. This can be used to calculate the number of pages for pagination.

Success Response:

{
  "resultCount": 2,
  "floorPlanJobs": [
    {
      "floorPlanJobId": "01942726-b7b4-752f-b1a2-3659730a20a0",
      "clientIdentifier": "2c54c6cf-6ae1-4892-861f-3347a3fe75f9",
      "siteIdentifier": "644f1f9b-a7e0-45e8-b4de-06e288e82915",
      "buildingIdentifier": "ea2394c2-4826-4d70-bf93-ab43f7d66cbe",
      "levelIdentifier": "1a2394c2-4826-4d70-bf93-ab43f7d66cbe",
      "levelIndex": 0,
      "createdDate": "2025-01-02T13:13:56.404295Z",
      "updatedDate": "2025-01-02T13:19:34.393611Z",
      "finishedDate": "2025-01-02T13:19:34.327643Z",
      "fileUrl": "floor plan file url will be here",
      "resultUrl": "result url will be here",
      "errorMessage": "",
      "status": "Success",
      "isPreciseGeorefencingRequested": false,
      "reviewRequest": "MappingTeamReview",
      "extra": {
        "notes": "notessasd",
        "testid": "1234"
      },
      "resultExtra": {
        "areaSqFeet": 61408,
        "areaSqM": 5705,
        "circulationCoveragePercentage": 77,
        "unitCoveragePercentage": 23,
        "internalStatus": [
          {
            "message": "Not started yet",
            "name": "Initialization",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Downloading CAD File",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Preparing CAD Entities",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Drawing",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Finding Structural Elements",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Finding Walls",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Finding Units",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Finding Furniture",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Finalizing",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Uploading",
            "progress": 0
          }
        ]
      },
      "aiProcessingStartedAt": "2025-01-02T13:14:03.473662Z",
      "aiRequestReceivedAt": "2025-01-02T13:14:03.46452Z",
      "aiProcessingFinishedAt": "2025-01-02T13:16:52.047486Z",
      "declineMessage": "",
      "warningMessage": "Test Message",
      "cancelMessage": ""
    },
    {
      "floorPlanJobId": "01942726-b7b4-752f-b1a2-3659730a20a1",
      "clientIdentifier": "2c54c6cf-6ae1-4892-861f-3347a3fe75f9",
      "siteIdentifier": "644f1f9b-a7e0-45e8-b4de-06e288e82915",
      "buildingIdentifier": "ea2394c2-4826-4d70-bf93-ab43f7d66cbe",
      "levelIdentifier": "1a2394c2-4826-4d70-bf93-ab43f7d66cbe",
      "levelIndex": 1,
      "createdDate": "2025-01-02T13:13:56.404295Z",
      "updatedDate": "2025-01-02T13:19:34.393611Z",
      "finishedDate": "2025-01-02T13:19:34.327643Z",
      "fileUrl": "floor plan file url will be here",
      "resultUrl": "result url will be here",
      "errorMessage": "",
      "status": "Success",
      "isPreciseGeorefencingRequested": false,
      "reviewRequest": "MappingTeamReview",
      "extra": {
        "notes": "notessasd",
        "testid": "1234"
      },
      "resultExtra": {
        "areaSqFeet": 61408,
        "areaSqM": 5705,
        "circulationCoveragePercentage": 77,
        "unitCoveragePercentage": 23,
        "internalStatus": [
          {
            "message": "Not started yet",
            "name": "Initialization",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Downloading CAD File",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Preparing CAD Entities",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Drawing",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Finding Structural Elements",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Finding Walls",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Finding Units",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Finding Furniture",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Finalizing",
            "progress": 0
          },
          {
            "message": "Not started yet",
            "name": "Uploading",
            "progress": 0
          }
        ]
      },
      "aiProcessingStartedAt": "2025-01-02T13:14:03.473662Z",
      "aiRequestReceivedAt": "2025-01-02T13:14:03.46452Z",
      "aiProcessingFinishedAt": "2025-01-02T13:16:52.047486Z",
      "declineMessage": "",
      "warningMessage": "Test Message",
      "cancelMessage": ""
    }
  ]
}


* You can access the possible response codes you may encounter here.