Skip to main content
POST
/
customer
/
site
Standort anlegen
curl --request POST \
  --url https://api.blueplant.app/api/v1/customer/site \
  --header 'ApiKey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "address": {
    "streetName": "<string>",
    "houseNumber": "<string>",
    "zipCode": "<string>",
    "city": "<string>",
    "location": {
      "lat": 0,
      "lng": 0
    }
  },
  "needsAppointment": true,
  "hasKey": true,
  "comment": "<string>",
  "appointmentPreparationTimeInMinutes": 1,
  "attendingIntervals": [
    {}
  ],
  "openingHours": [],
  "serviceRecordRecipientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "callOutFee": 1,
  "assignedEmployeeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contactPersonId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contractId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "validFrom": "2023-12-25",
  "validUntil": "2023-12-25"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

ApiKey
string
header
required

Dein API-Schlüssel aus den Mandanten-Einstellungen, gesendet im Header ApiKey.

Body

application/json
customerId
string<uuid>
required

ID des Kunden, zu dem der Standort gehört.

name
string
required

Bezeichnung des Standorts.

Maximum string length: 60
address
object
required

Postanschrift mit optionaler Geo-Position.

needsAppointment
boolean
required

Ob für diesen Standort Termine geplant werden müssen.

hasKey
boolean
required

Ob für den Zugang ein Schlüssel vorhanden ist.

comment
string

Freier Hinweis zum Standort.

Maximum string length: 150
appointmentPreparationTimeInMinutes
integer

Zeitpuffer in Minuten, den blueplant vor einem Termin an diesem Standort einplant.

Required range: x >= 0
attendingIntervals
object[]

Besuchsintervalle des Standorts. TODO: genaue Struktur der Intervall-Objekte mit dem Dev-Team abstimmen.

openingHours
object[]

Öffnungszeiten des Standorts. TODO: genaue Struktur der Öffnungszeit-Objekte mit dem Dev-Team abstimmen.

serviceRecordRecipientId
string<uuid>

Empfänger der Leistungsnachweise für diesen Standort.

callOutFee
number

Anfahrtspauschale für diesen Standort.

Required range: x >= 0
assignedEmployeeId
string<uuid>

Standardmäßig zugewiesene mitarbeitende Person.

contactPersonId
string<uuid>

Ansprechpartner am Standort.

contractId
string<uuid>

Zugehöriger Vertrag.

validFrom
string<date>

Beginn der Gültigkeit.

validUntil
string<date>

Ende der Gültigkeit.

Response

Standort angelegt.

Antwort mit der ID des angelegten Objekts.

id
string<uuid>

ID des angelegten Objekts.