Skip to content

Floor Plan Job Management Operations

Description

This API allows you to manage floor plan jobs, including approving, canceling, and declining a job for a specified client, site, building, and level.
This documentation provides a clear overview of the Approve, Cancel, and Decline operations for the floor plan jobs, including the required request body and expected responses.

Approve Floor Plan Job

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

Optional Fields

  • message: (string) Optional. Approve message.

Request Body: 

{
  "message": "test message",
}

Success Response:

{
  "message": "Floor plan job approved successfully."
}


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

Cancel Floor Plan Job API

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

Required Fields

  • message: (string) Required. Cancel message.

Request Body: 

{
  "message": "test message",
}

Success Response:

{
  "message": "Floor plan job cancelled successfully."
}


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

Decline Floor Plan Job API

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

Required Fields

  • message: (string) Required. Decline message.

Request Body: 

{
  "message": "test message",
}

Success Response:

{
  "message": "Floor plan job declined successfully."
}


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

Upload New Floor Plan File to Floor Plan Job

Description

This API endpoint allows you to upload a new floor plan file for an existing floor plan job.
This is useful when the map job has completed and a new floor plan file needs to be associated with the job.

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

Required Fields

  • floorplanFileUrl: (string) Required. The URL of the new floor plan file to be uploaded.
  • fileType: (string) Required. Must be one of the following values: "dxf", "dwg", or "pdf".

Request Body:

{
  "floorplanFileUrl": "https://example.com/path/to/new-floorplan-file.dxf",
  "fileType": "dxf"
}

Success Response:

{
  "message": "Floor Plan Job's cad file is updated successfully."
}


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

Upload New Floor Plan File to Floor Plan Job

Description

This API endpoint allows you to upload a new floor plan file for an existing floor plan job.
This is useful when the map job has completed and a new floor plan file needs to be associated with the job.

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

Request Body:

{
  "type": "FeatureCollection",
  "features": [
    {
      "type": "Feature",
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [
              0.12296541,
              -7.2299134
            ],
            [
              0.12296243,
              -7.22991624
            ],
            [
              0.12276055,
              -7.22991624
            ]
          ]
        ]
      },
      "properties": {
        "typeCode": "floor-outline",
        "sid": "string",
        "bid": "string",
        "lvl": 1,
        "name": null,
        "description": null,
        "style": {}
      }
    }
  ]
}

Success Response:

{
  "message": "Floor Plan Job's geojson is updated successfully."
}


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

Upload Floorplan Original File

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

Description:

Uploads the original floorplan file for a specific level in a building.

Request Body:

{
  "fileType": "dxf",
  "floorPlanFileBase64": "ICAwDQpTRUNUSU9ODQogIDINCkhFQURFUg0KICA5DQokQUNBRFZFUg0KICAxDQpBQzEwMzINCiAgOQ0KJEFDQURNQUlOVFZFUg0KIDkwDQogICAgICAxNDANCiAgOQ0KJERXR0NPREVQQUdFDQogIDMNCkFOU0lfMTI1Mg0KICA5DQokTEFTVFNBVkVEQlkNCiAg...."
}

Success Response: 

Empty response


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

Get Floorplan Original File

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

Description:

Get the original floorplan file for a specific level in a building.

Success Response:

{
    "fileType": "dxf",
    "floorPlanFileBase64": "ICAwDQpTRUNUSU9ODQogIDINCkhFQURFUg0KICA5DQokQUNBRFZFUg0KICAxDQpBQzEwMzINCiAgOQ0KJEFDQURNQUlOVFZFUg0KIDkwDQogICAgICAxNDANCiAgOQ0KJERXR0NPREVQQUdFDQogIDMNCkFOU0lfMTI1Mg0KICA5DQokTEFTVFNBVkVEQlkNCiAg....",
    "uploadedFileUrl": "{blob_url}"
}


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