Standort anlegen
Legt einen Standort für einen Kunden an.
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"
}
'import requests
url = "https://api.blueplant.app/api/v1/customer/site"
payload = {
"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"
}
headers = {
"ApiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {ApiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://api.blueplant.app/api/v1/customer/site', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.blueplant.app/api/v1/customer/site",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"ApiKey: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.blueplant.app/api/v1/customer/site"
payload := strings.NewReader("{\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"address\": {\n \"streetName\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"location\": {\n \"lat\": 0,\n \"lng\": 0\n }\n },\n \"needsAppointment\": true,\n \"hasKey\": true,\n \"comment\": \"<string>\",\n \"appointmentPreparationTimeInMinutes\": 1,\n \"attendingIntervals\": [\n {}\n ],\n \"openingHours\": [],\n \"serviceRecordRecipientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"callOutFee\": 1,\n \"assignedEmployeeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contactPersonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ApiKey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.blueplant.app/api/v1/customer/site")
.header("ApiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"address\": {\n \"streetName\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"location\": {\n \"lat\": 0,\n \"lng\": 0\n }\n },\n \"needsAppointment\": true,\n \"hasKey\": true,\n \"comment\": \"<string>\",\n \"appointmentPreparationTimeInMinutes\": 1,\n \"attendingIntervals\": [\n {}\n ],\n \"openingHours\": [],\n \"serviceRecordRecipientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"callOutFee\": 1,\n \"assignedEmployeeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contactPersonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blueplant.app/api/v1/customer/site")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"address\": {\n \"streetName\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"location\": {\n \"lat\": 0,\n \"lng\": 0\n }\n },\n \"needsAppointment\": true,\n \"hasKey\": true,\n \"comment\": \"<string>\",\n \"appointmentPreparationTimeInMinutes\": 1,\n \"attendingIntervals\": [\n {}\n ],\n \"openingHours\": [],\n \"serviceRecordRecipientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"callOutFee\": 1,\n \"assignedEmployeeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contactPersonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"message": "invalid input",
"errors": [
{}
]
}Authorizations
Dein API-Schlüssel aus den Mandanten-Einstellungen, gesendet im Header ApiKey.
Body
ID des Kunden, zu dem der Standort gehört.
Bezeichnung des Standorts.
60Postanschrift mit optionaler Geo-Position.
Show child attributes
Show child attributes
Ob für diesen Standort Termine geplant werden müssen.
Ob für den Zugang ein Schlüssel vorhanden ist.
Freier Hinweis zum Standort.
150Zeitpuffer in Minuten, den blueplant vor einem Termin an diesem Standort einplant.
x >= 0Besuchsintervalle des Standorts. TODO: genaue Struktur der Intervall-Objekte mit dem Dev-Team abstimmen.
Öffnungszeiten des Standorts. TODO: genaue Struktur der Öffnungszeit-Objekte mit dem Dev-Team abstimmen.
Empfänger der Leistungsnachweise für diesen Standort.
Anfahrtspauschale für diesen Standort.
x >= 0Standardmäßig zugewiesene mitarbeitende Person.
Ansprechpartner am Standort.
Zugehöriger Vertrag.
Beginn der Gültigkeit.
Ende der Gültigkeit.
Response
Standort angelegt.
Antwort mit der ID des angelegten Objekts.
ID des angelegten Objekts.
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"
}
'import requests
url = "https://api.blueplant.app/api/v1/customer/site"
payload = {
"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"
}
headers = {
"ApiKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {ApiKey: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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'
})
};
fetch('https://api.blueplant.app/api/v1/customer/site', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.blueplant.app/api/v1/customer/site",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
]),
CURLOPT_HTTPHEADER => [
"ApiKey: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.blueplant.app/api/v1/customer/site"
payload := strings.NewReader("{\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"address\": {\n \"streetName\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"location\": {\n \"lat\": 0,\n \"lng\": 0\n }\n },\n \"needsAppointment\": true,\n \"hasKey\": true,\n \"comment\": \"<string>\",\n \"appointmentPreparationTimeInMinutes\": 1,\n \"attendingIntervals\": [\n {}\n ],\n \"openingHours\": [],\n \"serviceRecordRecipientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"callOutFee\": 1,\n \"assignedEmployeeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contactPersonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ApiKey", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.blueplant.app/api/v1/customer/site")
.header("ApiKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"address\": {\n \"streetName\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"location\": {\n \"lat\": 0,\n \"lng\": 0\n }\n },\n \"needsAppointment\": true,\n \"hasKey\": true,\n \"comment\": \"<string>\",\n \"appointmentPreparationTimeInMinutes\": 1,\n \"attendingIntervals\": [\n {}\n ],\n \"openingHours\": [],\n \"serviceRecordRecipientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"callOutFee\": 1,\n \"assignedEmployeeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contactPersonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.blueplant.app/api/v1/customer/site")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ApiKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"name\": \"<string>\",\n \"address\": {\n \"streetName\": \"<string>\",\n \"houseNumber\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"city\": \"<string>\",\n \"location\": {\n \"lat\": 0,\n \"lng\": 0\n }\n },\n \"needsAppointment\": true,\n \"hasKey\": true,\n \"comment\": \"<string>\",\n \"appointmentPreparationTimeInMinutes\": 1,\n \"attendingIntervals\": [\n {}\n ],\n \"openingHours\": [],\n \"serviceRecordRecipientId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"callOutFee\": 1,\n \"assignedEmployeeId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contactPersonId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"contractId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"validFrom\": \"2023-12-25\",\n \"validUntil\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"message": "invalid input",
"errors": [
{}
]
}