AddMeasurements

AddMeasurements

Adds one or more measurements to a measure sheet.

Request

Method
URL
POST
 https://api.solatech-dos.com/measuresheets/v1/addmeasurements 

Headers

Name
Required
Type
Description
APIKey
Guid
A valid API key with a scope of MeasureSheets | Update

Body

Name
Required
Type
Description
MeasureSheetUniqueID
GUID
The unique ID of the measure sheet that the measurements belong to.
Measurements
Object Array
One or more sets of measurements. See Measurement below.

Measurement

Name
Required
Type
Description
Room
Text
The room of the measurement, for example "Den".
Item
Text
The item in the room being measured, for example "Window 1".
Mount
Text
The mount, for example "Inside".
Width
Text
The width of the measurement, for example "45.25" or "45 1/4".
Height
Text
The height/length of the measurement, for example "65.0".
Remarks
Text
Remarks or notes on the measurement.
OtherMeasurements
List
Additional measurements.
{
  "MeasureSheetUniqueID": "0964b206-61e0-4fc0-a753-09a74eff7f64",
  "Measurements": [
    {
      "Room": "Kitchen",  
      "Item": "Window 1",  
      "Mount": "Inside",  
      "Width": "25 1/2",  
      "Height": "55",  
      "Remarks": "This window is not square."  
    },  
    {  
      "Room": "Kitchen",  
      "Item": "Window 2",  
      "Mount": "Inside",  
      "Width": "25",  
      "Height": "55.25",
      "Remarks": "",
      "OtherMeasurements":  
        {    
          "W1": "55",      
          "W2": "55.5",      
          "W3": "55.75"    
        }  
    }
  ]
}

Remarks

To identify a measure sheet, the MeasureSheetUniqueID is required. 
There must be at least one measurement, otherwise a 400-status code will be returned.

Response

Headers

Code
Description
200 OK
The measurements were added.
400 Bad Request
The measurement were not added. The reason why will be returned.
401 Unauthorized
The API key is missing, invalid, disabled, or does not have the correct scope.
404 Not Found
The measure sheet was not found.

Body

No details are returned when adding multiple measurements.