Create

Create

Create

Adds a location to an account.

Request

Method
URL
POST
 https://api.solatech-dos.com/lists/v1/accounts/{accountUniqueId}/departments 

Path Parameters

Name
Required
Type
Description
accountUniqueId

Guid
The unique ID of the account.

Headers

Name
Required
Type
Description
APIKey

Guid
A valid API key with a scope of AccountLists

Body

Name
Required
Type
Description
name

Text
The name of the location. Maximum length is 32 characters and it cannot be empty.
active
Boolean
Indicates if the location is active or inactive. The default is active.
{
  "name": "Installation",
  "active": true
}

Remarks

nameis required, cannot be empty, and cannot exceed 32 characters. If active is omitted, the location is created as active.
A location's name must be unique within an account. If a location with the same name already exists for the account, the request will fail with a 409 Conflict.

Response

Headers

Location — the URL of the newly created location.

Status Code

Code
Description
201 Created
The location was created.
400 Bad Request
The location was not created. This occurs if name is missing, empty, or exceeds 32 characters.
401 Unauthorized
The API key is missing, invalid, disabled, or does not have the correct scope.
403 Forbidden
The API key does not belong to this account, the account does not have the API-keys feature, or the key does not have the required scope.
409 Conflict
A location with that name already exists for this account.

Body

Name
Type
Description
uniqueId
Guid
The unique ID of the location.
name
Text
The name of the location.
active
Boolean
Indicates if the location is active or inactive.