Update Packages

An easy guide to update Packages information.

Update Packages Endpoint

To successfully update Packages information within a campaign, the following endpoint can be used:

Endpoint:
https://api.novasole.com/packages

Request Method:
PUT

Request Body

This endpoint requires a valid bearer token and request body that includes details about Campaign Id, Name and Sort Index. To get a valid Campaign Id, use the Get Campaign endpoint. To obtain a valid bearer token, please refer to the Authentication page for more information. The Sort Index of a updated Package refers to order in which the Package will be used in a calculation. The first and default package has a Sort Index of 0.

Successful Response

{
  "id": 1,
  "name": "string",
  "sortIndex": 1
}

Using the Package Id’s

The Package Id’s can be used in the request body for the Create Scan or Create Design endpoints. A package contains certain product preferences on defaults for creating an energy system. This information will be automatically retrieved in the Create Scan or Design endpoint when passing a certain Package Id in the request body of that endpoint.