Create

Create

Adds a measure sheet to a customer.

Request

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

Headers

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

Body

Name
Required
Type
Description
CustomerUniqueID
GUID
The unique ID of the customer that the measure sheet belongs to.
CustomerExternalID
Text
The external ID of the customer that the measure sheet belongs to.
Location
Text
The name of the measure sheet. Locations must be unique for each measure sheet.
Measurements
Object Array
One or more measurements. See Measurements below.

Measurement

Property
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.
{
  "CustomerUniqueID": "0c61b36d-1169-4acd-ac6b-a6e2ef64e9d8",
  "CustomerExternalID": "",
  "Location": "Primary House",   

  "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 customer, only the CustomerUniqueID OR the CustomerExternalID are used. If both are supplied, the CustomerUniqueID will be used. 

Response

Headers

None

Status Code

Code
Description
200 OK
The measure sheet was created.
400 Bad Request
The measure sheet was 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 customer was not found.

Body

Details on the measure sheet added will be returned.
Property
Type
Description
MeasureSheetUniqueID
GUID
The unique id of the measure sheet. This will be used when reading or deleting the measure sheet, or when adding additional measurements via the AddMeasurement or AddMeasurements endpoints.
{
  "MeasureSheetUniqueID": "a21a6274-dc75-4bb0-a165-f12f3c500868"
}