Skip to content

Create Floor Plan Job API

Create Floor Plan Job

This API endpoint allows you to create a new floor plan job for a specified client, site, building, and level.

  • If the ReviewRequest parameter is sent as “NoRequest” in the body when the floor plan job request is sent, after the Mapscale operations are successful, Pointr Cloud Content update is performed and the floor plan job status is updated as “Success”.
  • If Review Request parameter is sent as “MappingTeamReview”, floor plan job status is updated as “AwaitingManualReview” after Mapscale operations are successful. Floor plan job Approve request must be sent to update the content.
  • If the Review Request parameter is sent as “DashboardReview”, the floor plan job status will be updated as “Success” after the Mapscale operations are successful. Content update is done by the dashboard.
  • In case of an error during automatic content update operations, a message is written in error message field and the floor plan job status sets “AwaitingManualReview”

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

Required Fields

  • fileType: (string) Required. Must be one of the following values: "dxf", "dwg", or "pdf".
  • fileUrl: (string) Required. The URL of the floor plan file.
  • isPreciseGeoreferencingRequested: (boolean) Required. Must be either true or false.

Optional Fields - reviewRequest: (string) Optional. Must be MappingTeamReview, DashboardReview, or NoRequest. If the reviewRequest field is not set, the system automatically sets it to MappingTeamReview.

  • location: (object) Optional. If provided, must include:

    • address: (string) Required if location is provided.
    • latitude: (number) Required if location is provided.
    • longitude: (number) Required if location is provided.

  • levelType: (string) (optional values can be office, hospital, hotel, university)

  • buildingName: (string)
  • taxonomyVersion: (string)

Request Body:

{
  "fileUrl": "https://pointrsastest.blob.core.windows.net/roomtest.dxf",
  "fileType": "dxf",
  "fileHash": "",
  "extra": {
    "key": "value"
  },
  "location": {
    "address": "address",
    "latitude": 39.925533,
    "longitude": 32.866287
  },
  "isPreciseGeoreferencingRequested": false,
  "reviewRequest": "MappingTeamReview",
  "taxonomyVersion": "8.15.0",
  "buildingName": "Building 1",
  "levelType": "office",
  "georeferencing": {
    "anchors": [
      {
        "originalCoordinates": [
          100,
          200
        ],
        "coordinates": [
          -72.74199264368674,
          41.81341672831643
        ]
      },
      {
        "originalCoordinates": [
          2500,
          900
        ],
        "coordinates": [
          -72.74432602905546,
          41.81245557927655
        ]
      }
    ]
  }
}

Success Response:

{
  "floorPlanJobId": "dcf3ca2b-ef17-4b80-b4ed-e22c11bb722b"
}


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