Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Create a PV plan

Early access: request API access for your workspace at https://bauhow.com/support before using this endpoint.

POST/v1/projects/{projectId}/pv-plans
Autorisierung
AuthorizationBearer-Token · headererforderlich

Workspace API key (bh_…).

Pfadparameter
projectIdstringerforderlich
min. Länge 1
Request-Body
erforderlichapplication/json
namestring
min. Länge 1 · max. Länge 191
originLatnumbererforderlich
min. -90 · max. 90
originLngnumbererforderlich
min. -180 · max. 180
originAddressstring | null
Eigenschaften anzeigen
Mindestens eines von:
string
string
null
null
buildingIdstring | null
Eigenschaften anzeigen
Mindestens eines von:
string
string
null
null
Antworten
201

OK

idstringerforderlich
projectIdstringerforderlich
namestringerforderlich
buildingIdstring | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
string
string
null
null
originLatnumbererforderlich
originLngnumbererforderlich
originAddressstring | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
string
string
null
null
isFavoritebooleanerforderlich
summaryobject | nullerforderlich
Eigenschaften anzeigen
Mindestens eines von:
object
object
null
null
createdAtstring<date-time>erforderlich
updatedAtstring<date-time>erforderlich
schemaVersionintegererforderlich
min. -9007199254740991 · max. 9007199254740991
payloadobjecterforderlich
Ausprobieren
Server
Autorisierung
Parameter
Bodyapplication/json
Anfrage
curl -X POST 'https://app.bauhow.com/api/v1/projects/string/pv-plans' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "originLat": -90,
  "originLng": -180,
  "originAddress": "string",
  "buildingId": "string"
}'
Antwort
{
  "id": "string",
  "projectId": "string",
  "name": "string",
  "buildingId": "string",
  "originLat": 0,
  "originLng": 0,
  "originAddress": "string",
  "isFavorite": true,
  "summary": {
    "property1": null,
    "property2": null
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "schemaVersion": -9007199254740991,
  "payload": {
    "property1": null,
    "property2": null
  }
}