Create a new site
curl --request POST \
--url https://api.voltview.co.uk/v1/createSite \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"address": "<string>",
"postcode": "<string>",
"floorArea": 123,
"buildingType": "<string>"
}
'import requests
url = "https://api.voltview.co.uk/v1/createSite"
payload = {
"name": "<string>",
"address": "<string>",
"postcode": "<string>",
"floorArea": 123,
"buildingType": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
address: '<string>',
postcode: '<string>',
floorArea: 123,
buildingType: '<string>'
})
};
fetch('https://api.voltview.co.uk/v1/createSite', 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.voltview.co.uk/v1/createSite",
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([
'name' => '<string>',
'address' => '<string>',
'postcode' => '<string>',
'floorArea' => 123,
'buildingType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.voltview.co.uk/v1/createSite"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"postcode\": \"<string>\",\n \"floorArea\": 123,\n \"buildingType\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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.voltview.co.uk/v1/createSite")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"postcode\": \"<string>\",\n \"floorArea\": 123,\n \"buildingType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voltview.co.uk/v1/createSite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"postcode\": \"<string>\",\n \"floorArea\": 123,\n \"buildingType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"address": "<string>",
"postcode": "<string>",
"region": "<string>",
"floorArea": 123,
"buildingType": "<string>",
"meterCount": 123,
"utilities": []
}{
"type": "error",
"error": {
"type": "invalid_request_error",
"message": "Invalid request"
}
}Sites
Create a new site
Create a new site in the system.
POST
/
v1
/
createSite
Create a new site
curl --request POST \
--url https://api.voltview.co.uk/v1/createSite \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"address": "<string>",
"postcode": "<string>",
"floorArea": 123,
"buildingType": "<string>"
}
'import requests
url = "https://api.voltview.co.uk/v1/createSite"
payload = {
"name": "<string>",
"address": "<string>",
"postcode": "<string>",
"floorArea": 123,
"buildingType": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
address: '<string>',
postcode: '<string>',
floorArea: 123,
buildingType: '<string>'
})
};
fetch('https://api.voltview.co.uk/v1/createSite', 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.voltview.co.uk/v1/createSite",
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([
'name' => '<string>',
'address' => '<string>',
'postcode' => '<string>',
'floorArea' => 123,
'buildingType' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.voltview.co.uk/v1/createSite"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"postcode\": \"<string>\",\n \"floorArea\": 123,\n \"buildingType\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<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.voltview.co.uk/v1/createSite")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"postcode\": \"<string>\",\n \"floorArea\": 123,\n \"buildingType\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.voltview.co.uk/v1/createSite")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"address\": \"<string>\",\n \"postcode\": \"<string>\",\n \"floorArea\": 123,\n \"buildingType\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"name": "<string>",
"address": "<string>",
"postcode": "<string>",
"region": "<string>",
"floorArea": 123,
"buildingType": "<string>",
"meterCount": 123,
"utilities": []
}{
"type": "error",
"error": {
"type": "invalid_request_error",
"message": "Invalid request"
}
}Authorizations
VoltView API key
Body
application/json
Response
Site created successfully
Site identifier
Site name
Site address
Site postcode
Geographic region
Floor area in square meters
Type of building
Number of meters at the site
Utilities available at the site
Available options:
ELECTRICITY, GAS, WATER Site status
Available options:
ACTIVE, INACTIVE ⌘I