Introduction

Welcome to use MeasureSquare cloud APIs.
The Cloud API is organized around REST, has predictable, resource-oriented URLs.

Before use, you need to contact the admin, request an auth name and token key to generate the required authentication string.
For more detail, see Authentication section.

The Cloud API support JSON and XML data format, and uses HTTP response codes to indicate API errors.
For more detail, see Response and Errors section.

Product catalog APIs

API	Description
GET api/productdbs/{id}/products	Get products from product catalog
POST api/productdbs/{id}/products	Create/Update/Delete the products in product catalog. It is allowed to only pass the attribute values of the product that need to be updated Notes: 1. If you want to clear all existing old product datas in the product catalog, set OverWrite to true, otherwise, it's best to set it to false. 2. Update_Keep_Existing is best to set it to true, so it will keep the estimation values which may be updated in M8. otherwise, the product will be updated with default estimation value if you do not transfer estimation properties. 3. If Update_Del_Existing is set to true, it will delete existing products that are not in the passed updated product list, so it's best to set it to false.
DELETE api/productdbs/{id}/products	Delete some products in product catalog
GET api/productdbs?m2Id={m2Id}	Get the user's product catalogs
POST api/productdbs?m2Id={m2Id}&name={name}	Create empty product catalog
DELETE api/productdbs?id={id}&m2Id={m2Id}	Delete the whole product catalog

Project APIs

API	Description
GET api/{m2Id}/projects?search={search}&isArchived={isArchived}&applicationType={applicationType}&showTags={showTags}	Get the projects by MeasureSquare ID The return projects are sorted by last updated date. Max return count is 100.
GET api/{m2Id}/projects/count?search={search}&isArchived={isArchived}&applicationType={applicationType}	Get the project count by MeasureSquare ID
GET api/{m2Id}/projects/length/{pageLength}/page/{pageIndex}?search={search}&orderby={orderby}&isArchived={isArchived}&applicationType={applicationType}&showTags={showTags}	Get the paging projects by MeasureSquare ID.
GET api/{m2Id}/projects/date/{updatedTime}/number/{number}?isArchived={isArchived}&applicationType={applicationType}&showTags={showTags}	Get the new/updated projects based on time stamp by MeasureSquare ID It is the best way that you remember the LastUpdatedOn value of the last project, and pass this value while invoking this API next time, to prevent from missing projects.
GET api/projects/count?search={search}&distinct={distinct}&isArchived={isArchived}&applicationType={applicationType}	Get total project count in group
GET api/projects/length/{pageLength}/page/{pageIndex}?search={search}&distinct={distinct}&orderby={orderby}&isArchived={isArchived}&applicationType={applicationType}	Get paging projects in group
GET api/projects/date/{updatedTime}/number/{number}?isArchived={isArchived}&applicationType={applicationType}	Get the new/updated projects based on time stamp It is the best way that you remember the LastUpdatedOn value of the last project, and pass this value while invoking this API next time, to prevent from missing projects.
GET api/projects/{projectId}/accessToken?readOnly={readOnly}	Get project access token
GET api/projects/{projectId}?getProductInfo={getProductInfo}	Get project info, inclue Customer Info/Job Site Contact and Address/Management/Project products
GET api/projects/{projectId}/layers	Get layer info, include Rooms(Wall/Window/Door/Elevation) and Stairs
GET api/projects/{projectId}/layerAssignment	get product assignment info of each Room and Stair
GET api/projects/{projectId}/worksheets	Get project worksheets
GET api/projects/{projectId}/estimation?withCutImage={withCutImage}	Get project estimation
GET api/projects/{projectId}/report?sections={sections}	Get project report
GET api/projects/{projectId}/download?revision={revision}	Get project file (application/fez)
GET api/projects/{projectId}/images?width={width}&height={height}	Get a zip file include all layer images (application/zip)
GET api/projects/{projectId}/layers/{layerIndex}/image?width={width}&height={height}	Get layer image (image/png)
GET api/projects/{projectId}/pdf?printProfileId={printProfileId}	Get project pdf (application/pdf) PrintProfileId is an optional parameter, in most case, you don't need to pass it. Cannot call repeatedly within 1 second. And a maximum of 10 calls can be made within 1 minute.
GET api/projects/{projectId}/fsde	Get project fsde file (text/xml)
GET api/projects/{projectId}/dxf	Get project dxf file (application/dxf)
GET api/projects/{projectId}/webviewer?showQty={showQty}&showAreaPerimeter={showAreaPerimeter}&showDimensions={showDimensions}&showBluePrint={showBluePrint}&showEmptyTakeoff={showEmptyTakeoff}	Get project viewer url
GET api/projects/{projectId}/sharedusers	Get project shared users list
GET api/projects/{projectId}/url?revision={revision}	Get project file url
POST api/{m2Id}/projects	Create or update project for MeasureSquare ID
POST api/{m2Id}/projects/{projectId}/clone	Clone one project from designated project
POST api/{m2Id}/projects/{projectId}/archive	Archive project
POST api/{m2Id}/projects/{projectId}/unarchive	Unarchive project

Authentication

You authenticate to the MeasureSquare cloud API by providing your API Key in the request.
You can manage your API Key from your account's API Setting page.
Your API keys carry many privileges, so be sure to keep them secret!

Authentication to the API occurs via HTTP Basic Auth. Provide your API Key as the basic auth username. You do not need to provide a password.
You must authenticate for all requests.
For example:
curl -u PutYourApiKeyHere: --request GET "https://cloud.measuresquare.com/api/projects/count"

All API requests must be made over HTTPS. Calls made over HTTP will fail, and the API requests without authentication will also fail.
API Endpoint: https://cloud.measuresquare.com

Response and Errors

The Cloud API support JSON and XML data format.
If set the Request Accept to application/json, the API will return the data with JSON format.
If set the Request Accept to application/xml, the API will return the data with XML format.

The Cloud API uses conventional HTTP status codes to indicate the success or failure of an API request.
In general, it return 200 success status code, and request data.
If the authentication is failed, it will return 401 status code.
If the request data no exists, it will return 400(or 404) status code.
If the request has unkown exception, it will return 500 status code. (These are rare.)
If request failure(non 200 status code), response will also return the defined error message in response content. View Details

Notification

Notification URL is an optional setting.
If you need the project notification, register your URL in API Setting page.
MeasureSquare cloud will notify anytime a project be created or updated, and one parameter called projectId will be attached to your registered URL.

Sample Code

View Details