Create an import template
curl --request POST \
--url https://api.ctrl-hub.com/v3/import-templates \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"type": "<string>",
"attributes": {
"property_id_source": "uprn",
"supply_type_mode": "fixed",
"import_type": "meters",
"name": "<string>",
"column_headers": [
"<string>"
],
"uprn_column": "<string>",
"fixed_supply_type": "<string>",
"address_columns": [
"<string>"
],
"supply_identifier_column": "<string>",
"serial_number_column": "<string>",
"supply_type_column": "<string>",
"supply_type_value_mapping": {},
"meter_extra_info_rules": [
{
"type": "global",
"display_name": "<string>",
"field": "<string>",
"value": "<string>",
"column": "<string>",
"match_values": [
"<string>"
]
}
],
"psr_extra_info_rules": [
{
"type": "global",
"display_name": "<string>",
"field": "<string>",
"value": "<string>",
"column": "<string>",
"match_values": [
"<string>"
]
}
],
"psr_column": "<string>",
"psr_column_value": "<string>",
"psr_priority_static": 123,
"psr_priority_column": "<string>"
},
"relationships": {
"organisation": {
"data": {
"type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/import-templates"
payload = { "data": {
"type": "<string>",
"attributes": {
"property_id_source": "uprn",
"supply_type_mode": "fixed",
"import_type": "meters",
"name": "<string>",
"column_headers": ["<string>"],
"uprn_column": "<string>",
"fixed_supply_type": "<string>",
"address_columns": ["<string>"],
"supply_identifier_column": "<string>",
"serial_number_column": "<string>",
"supply_type_column": "<string>",
"supply_type_value_mapping": {},
"meter_extra_info_rules": [
{
"type": "global",
"display_name": "<string>",
"field": "<string>",
"value": "<string>",
"column": "<string>",
"match_values": ["<string>"]
}
],
"psr_extra_info_rules": [
{
"type": "global",
"display_name": "<string>",
"field": "<string>",
"value": "<string>",
"column": "<string>",
"match_values": ["<string>"]
}
],
"psr_column": "<string>",
"psr_column_value": "<string>",
"psr_priority_static": 123,
"psr_priority_column": "<string>"
},
"relationships": { "organisation": { "data": {
"type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
} } }
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: '<string>',
attributes: {
property_id_source: 'uprn',
supply_type_mode: 'fixed',
import_type: 'meters',
name: '<string>',
column_headers: ['<string>'],
uprn_column: '<string>',
fixed_supply_type: '<string>',
address_columns: ['<string>'],
supply_identifier_column: '<string>',
serial_number_column: '<string>',
supply_type_column: '<string>',
supply_type_value_mapping: {},
meter_extra_info_rules: [
{
type: 'global',
display_name: '<string>',
field: '<string>',
value: '<string>',
column: '<string>',
match_values: ['<string>']
}
],
psr_extra_info_rules: [
{
type: 'global',
display_name: '<string>',
field: '<string>',
value: '<string>',
column: '<string>',
match_values: ['<string>']
}
],
psr_column: '<string>',
psr_column_value: '<string>',
psr_priority_static: 123,
psr_priority_column: '<string>'
},
relationships: {
organisation: {data: {type: '<string>', id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}}
}
}
})
};
fetch('https://api.ctrl-hub.com/v3/import-templates', 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.ctrl-hub.com/v3/import-templates",
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([
'data' => [
'type' => '<string>',
'attributes' => [
'property_id_source' => 'uprn',
'supply_type_mode' => 'fixed',
'import_type' => 'meters',
'name' => '<string>',
'column_headers' => [
'<string>'
],
'uprn_column' => '<string>',
'fixed_supply_type' => '<string>',
'address_columns' => [
'<string>'
],
'supply_identifier_column' => '<string>',
'serial_number_column' => '<string>',
'supply_type_column' => '<string>',
'supply_type_value_mapping' => [
],
'meter_extra_info_rules' => [
[
'type' => 'global',
'display_name' => '<string>',
'field' => '<string>',
'value' => '<string>',
'column' => '<string>',
'match_values' => [
'<string>'
]
]
],
'psr_extra_info_rules' => [
[
'type' => 'global',
'display_name' => '<string>',
'field' => '<string>',
'value' => '<string>',
'column' => '<string>',
'match_values' => [
'<string>'
]
]
],
'psr_column' => '<string>',
'psr_column_value' => '<string>',
'psr_priority_static' => 123,
'psr_priority_column' => '<string>'
],
'relationships' => [
'organisation' => [
'data' => [
'type' => '<string>',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/vnd.api+json",
"X-Session-Token: <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.ctrl-hub.com/v3/import-templates"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"<string>\",\n \"attributes\": {\n \"property_id_source\": \"uprn\",\n \"supply_type_mode\": \"fixed\",\n \"import_type\": \"meters\",\n \"name\": \"<string>\",\n \"column_headers\": [\n \"<string>\"\n ],\n \"uprn_column\": \"<string>\",\n \"fixed_supply_type\": \"<string>\",\n \"address_columns\": [\n \"<string>\"\n ],\n \"supply_identifier_column\": \"<string>\",\n \"serial_number_column\": \"<string>\",\n \"supply_type_column\": \"<string>\",\n \"supply_type_value_mapping\": {},\n \"meter_extra_info_rules\": [\n {\n \"type\": \"global\",\n \"display_name\": \"<string>\",\n \"field\": \"<string>\",\n \"value\": \"<string>\",\n \"column\": \"<string>\",\n \"match_values\": [\n \"<string>\"\n ]\n }\n ],\n \"psr_extra_info_rules\": [\n {\n \"type\": \"global\",\n \"display_name\": \"<string>\",\n \"field\": \"<string>\",\n \"value\": \"<string>\",\n \"column\": \"<string>\",\n \"match_values\": [\n \"<string>\"\n ]\n }\n ],\n \"psr_column\": \"<string>\",\n \"psr_column_value\": \"<string>\",\n \"psr_priority_static\": 123,\n \"psr_priority_column\": \"<string>\"\n },\n \"relationships\": {\n \"organisation\": {\n \"data\": {\n \"type\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-Token", "<api-key>")
req.Header.Add("Content-Type", "application/vnd.api+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.ctrl-hub.com/v3/import-templates")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"<string>\",\n \"attributes\": {\n \"property_id_source\": \"uprn\",\n \"supply_type_mode\": \"fixed\",\n \"import_type\": \"meters\",\n \"name\": \"<string>\",\n \"column_headers\": [\n \"<string>\"\n ],\n \"uprn_column\": \"<string>\",\n \"fixed_supply_type\": \"<string>\",\n \"address_columns\": [\n \"<string>\"\n ],\n \"supply_identifier_column\": \"<string>\",\n \"serial_number_column\": \"<string>\",\n \"supply_type_column\": \"<string>\",\n \"supply_type_value_mapping\": {},\n \"meter_extra_info_rules\": [\n {\n \"type\": \"global\",\n \"display_name\": \"<string>\",\n \"field\": \"<string>\",\n \"value\": \"<string>\",\n \"column\": \"<string>\",\n \"match_values\": [\n \"<string>\"\n ]\n }\n ],\n \"psr_extra_info_rules\": [\n {\n \"type\": \"global\",\n \"display_name\": \"<string>\",\n \"field\": \"<string>\",\n \"value\": \"<string>\",\n \"column\": \"<string>\",\n \"match_values\": [\n \"<string>\"\n ]\n }\n ],\n \"psr_column\": \"<string>\",\n \"psr_column_value\": \"<string>\",\n \"psr_priority_static\": 123,\n \"psr_priority_column\": \"<string>\"\n },\n \"relationships\": {\n \"organisation\": {\n \"data\": {\n \"type\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/import-templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"<string>\",\n \"attributes\": {\n \"property_id_source\": \"uprn\",\n \"supply_type_mode\": \"fixed\",\n \"import_type\": \"meters\",\n \"name\": \"<string>\",\n \"column_headers\": [\n \"<string>\"\n ],\n \"uprn_column\": \"<string>\",\n \"fixed_supply_type\": \"<string>\",\n \"address_columns\": [\n \"<string>\"\n ],\n \"supply_identifier_column\": \"<string>\",\n \"serial_number_column\": \"<string>\",\n \"supply_type_column\": \"<string>\",\n \"supply_type_value_mapping\": {},\n \"meter_extra_info_rules\": [\n {\n \"type\": \"global\",\n \"display_name\": \"<string>\",\n \"field\": \"<string>\",\n \"value\": \"<string>\",\n \"column\": \"<string>\",\n \"match_values\": [\n \"<string>\"\n ]\n }\n ],\n \"psr_extra_info_rules\": [\n {\n \"type\": \"global\",\n \"display_name\": \"<string>\",\n \"field\": \"<string>\",\n \"value\": \"<string>\",\n \"column\": \"<string>\",\n \"match_values\": [\n \"<string>\"\n ]\n }\n ],\n \"psr_column\": \"<string>\",\n \"psr_column_value\": \"<string>\",\n \"psr_priority_static\": 123,\n \"psr_priority_column\": \"<string>\"\n },\n \"relationships\": {\n \"organisation\": {\n \"data\": {\n \"type\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"attributes": {
"property_id_source": "uprn",
"supply_type_mode": "fixed",
"import_type": "meters",
"name": "<string>",
"column_headers": [
"<string>"
],
"uprn_column": "<string>",
"fixed_supply_type": "<string>",
"address_columns": [
"<string>"
],
"supply_identifier_column": "<string>",
"serial_number_column": "<string>",
"supply_type_column": "<string>",
"supply_type_value_mapping": {},
"meter_extra_info_rules": [
{
"type": "global",
"display_name": "<string>",
"field": "<string>",
"value": "<string>",
"column": "<string>",
"match_values": [
"<string>"
]
}
],
"psr_extra_info_rules": [
{
"type": "global",
"display_name": "<string>",
"field": "<string>",
"value": "<string>",
"column": "<string>",
"match_values": [
"<string>"
]
}
],
"psr_column": "<string>",
"psr_column_value": "<string>",
"psr_priority_static": 123,
"psr_priority_column": "<string>"
},
"meta": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
}
}
},
"jsonapi": {
"version": "<string>"
}
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Import Templates
Create an import template
Create an import template
POST
/
v3
/
import-templates
Create an import template
curl --request POST \
--url https://api.ctrl-hub.com/v3/import-templates \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"type": "<string>",
"attributes": {
"property_id_source": "uprn",
"supply_type_mode": "fixed",
"import_type": "meters",
"name": "<string>",
"column_headers": [
"<string>"
],
"uprn_column": "<string>",
"fixed_supply_type": "<string>",
"address_columns": [
"<string>"
],
"supply_identifier_column": "<string>",
"serial_number_column": "<string>",
"supply_type_column": "<string>",
"supply_type_value_mapping": {},
"meter_extra_info_rules": [
{
"type": "global",
"display_name": "<string>",
"field": "<string>",
"value": "<string>",
"column": "<string>",
"match_values": [
"<string>"
]
}
],
"psr_extra_info_rules": [
{
"type": "global",
"display_name": "<string>",
"field": "<string>",
"value": "<string>",
"column": "<string>",
"match_values": [
"<string>"
]
}
],
"psr_column": "<string>",
"psr_column_value": "<string>",
"psr_priority_static": 123,
"psr_priority_column": "<string>"
},
"relationships": {
"organisation": {
"data": {
"type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}
}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/import-templates"
payload = { "data": {
"type": "<string>",
"attributes": {
"property_id_source": "uprn",
"supply_type_mode": "fixed",
"import_type": "meters",
"name": "<string>",
"column_headers": ["<string>"],
"uprn_column": "<string>",
"fixed_supply_type": "<string>",
"address_columns": ["<string>"],
"supply_identifier_column": "<string>",
"serial_number_column": "<string>",
"supply_type_column": "<string>",
"supply_type_value_mapping": {},
"meter_extra_info_rules": [
{
"type": "global",
"display_name": "<string>",
"field": "<string>",
"value": "<string>",
"column": "<string>",
"match_values": ["<string>"]
}
],
"psr_extra_info_rules": [
{
"type": "global",
"display_name": "<string>",
"field": "<string>",
"value": "<string>",
"column": "<string>",
"match_values": ["<string>"]
}
],
"psr_column": "<string>",
"psr_column_value": "<string>",
"psr_priority_static": 123,
"psr_priority_column": "<string>"
},
"relationships": { "organisation": { "data": {
"type": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
} } }
} }
headers = {
"X-Session-Token": "<api-key>",
"Content-Type": "application/vnd.api+json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Session-Token': '<api-key>', 'Content-Type': 'application/vnd.api+json'},
body: JSON.stringify({
data: {
type: '<string>',
attributes: {
property_id_source: 'uprn',
supply_type_mode: 'fixed',
import_type: 'meters',
name: '<string>',
column_headers: ['<string>'],
uprn_column: '<string>',
fixed_supply_type: '<string>',
address_columns: ['<string>'],
supply_identifier_column: '<string>',
serial_number_column: '<string>',
supply_type_column: '<string>',
supply_type_value_mapping: {},
meter_extra_info_rules: [
{
type: 'global',
display_name: '<string>',
field: '<string>',
value: '<string>',
column: '<string>',
match_values: ['<string>']
}
],
psr_extra_info_rules: [
{
type: 'global',
display_name: '<string>',
field: '<string>',
value: '<string>',
column: '<string>',
match_values: ['<string>']
}
],
psr_column: '<string>',
psr_column_value: '<string>',
psr_priority_static: 123,
psr_priority_column: '<string>'
},
relationships: {
organisation: {data: {type: '<string>', id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}}
}
}
})
};
fetch('https://api.ctrl-hub.com/v3/import-templates', 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.ctrl-hub.com/v3/import-templates",
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([
'data' => [
'type' => '<string>',
'attributes' => [
'property_id_source' => 'uprn',
'supply_type_mode' => 'fixed',
'import_type' => 'meters',
'name' => '<string>',
'column_headers' => [
'<string>'
],
'uprn_column' => '<string>',
'fixed_supply_type' => '<string>',
'address_columns' => [
'<string>'
],
'supply_identifier_column' => '<string>',
'serial_number_column' => '<string>',
'supply_type_column' => '<string>',
'supply_type_value_mapping' => [
],
'meter_extra_info_rules' => [
[
'type' => 'global',
'display_name' => '<string>',
'field' => '<string>',
'value' => '<string>',
'column' => '<string>',
'match_values' => [
'<string>'
]
]
],
'psr_extra_info_rules' => [
[
'type' => 'global',
'display_name' => '<string>',
'field' => '<string>',
'value' => '<string>',
'column' => '<string>',
'match_values' => [
'<string>'
]
]
],
'psr_column' => '<string>',
'psr_column_value' => '<string>',
'psr_priority_static' => 123,
'psr_priority_column' => '<string>'
],
'relationships' => [
'organisation' => [
'data' => [
'type' => '<string>',
'id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/vnd.api+json",
"X-Session-Token: <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.ctrl-hub.com/v3/import-templates"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"<string>\",\n \"attributes\": {\n \"property_id_source\": \"uprn\",\n \"supply_type_mode\": \"fixed\",\n \"import_type\": \"meters\",\n \"name\": \"<string>\",\n \"column_headers\": [\n \"<string>\"\n ],\n \"uprn_column\": \"<string>\",\n \"fixed_supply_type\": \"<string>\",\n \"address_columns\": [\n \"<string>\"\n ],\n \"supply_identifier_column\": \"<string>\",\n \"serial_number_column\": \"<string>\",\n \"supply_type_column\": \"<string>\",\n \"supply_type_value_mapping\": {},\n \"meter_extra_info_rules\": [\n {\n \"type\": \"global\",\n \"display_name\": \"<string>\",\n \"field\": \"<string>\",\n \"value\": \"<string>\",\n \"column\": \"<string>\",\n \"match_values\": [\n \"<string>\"\n ]\n }\n ],\n \"psr_extra_info_rules\": [\n {\n \"type\": \"global\",\n \"display_name\": \"<string>\",\n \"field\": \"<string>\",\n \"value\": \"<string>\",\n \"column\": \"<string>\",\n \"match_values\": [\n \"<string>\"\n ]\n }\n ],\n \"psr_column\": \"<string>\",\n \"psr_column_value\": \"<string>\",\n \"psr_priority_static\": 123,\n \"psr_priority_column\": \"<string>\"\n },\n \"relationships\": {\n \"organisation\": {\n \"data\": {\n \"type\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n }\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Session-Token", "<api-key>")
req.Header.Add("Content-Type", "application/vnd.api+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.ctrl-hub.com/v3/import-templates")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"<string>\",\n \"attributes\": {\n \"property_id_source\": \"uprn\",\n \"supply_type_mode\": \"fixed\",\n \"import_type\": \"meters\",\n \"name\": \"<string>\",\n \"column_headers\": [\n \"<string>\"\n ],\n \"uprn_column\": \"<string>\",\n \"fixed_supply_type\": \"<string>\",\n \"address_columns\": [\n \"<string>\"\n ],\n \"supply_identifier_column\": \"<string>\",\n \"serial_number_column\": \"<string>\",\n \"supply_type_column\": \"<string>\",\n \"supply_type_value_mapping\": {},\n \"meter_extra_info_rules\": [\n {\n \"type\": \"global\",\n \"display_name\": \"<string>\",\n \"field\": \"<string>\",\n \"value\": \"<string>\",\n \"column\": \"<string>\",\n \"match_values\": [\n \"<string>\"\n ]\n }\n ],\n \"psr_extra_info_rules\": [\n {\n \"type\": \"global\",\n \"display_name\": \"<string>\",\n \"field\": \"<string>\",\n \"value\": \"<string>\",\n \"column\": \"<string>\",\n \"match_values\": [\n \"<string>\"\n ]\n }\n ],\n \"psr_column\": \"<string>\",\n \"psr_column_value\": \"<string>\",\n \"psr_priority_static\": 123,\n \"psr_priority_column\": \"<string>\"\n },\n \"relationships\": {\n \"organisation\": {\n \"data\": {\n \"type\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n }\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/import-templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Session-Token"] = '<api-key>'
request["Content-Type"] = 'application/vnd.api+json'
request.body = "{\n \"data\": {\n \"type\": \"<string>\",\n \"attributes\": {\n \"property_id_source\": \"uprn\",\n \"supply_type_mode\": \"fixed\",\n \"import_type\": \"meters\",\n \"name\": \"<string>\",\n \"column_headers\": [\n \"<string>\"\n ],\n \"uprn_column\": \"<string>\",\n \"fixed_supply_type\": \"<string>\",\n \"address_columns\": [\n \"<string>\"\n ],\n \"supply_identifier_column\": \"<string>\",\n \"serial_number_column\": \"<string>\",\n \"supply_type_column\": \"<string>\",\n \"supply_type_value_mapping\": {},\n \"meter_extra_info_rules\": [\n {\n \"type\": \"global\",\n \"display_name\": \"<string>\",\n \"field\": \"<string>\",\n \"value\": \"<string>\",\n \"column\": \"<string>\",\n \"match_values\": [\n \"<string>\"\n ]\n }\n ],\n \"psr_extra_info_rules\": [\n {\n \"type\": \"global\",\n \"display_name\": \"<string>\",\n \"field\": \"<string>\",\n \"value\": \"<string>\",\n \"column\": \"<string>\",\n \"match_values\": [\n \"<string>\"\n ]\n }\n ],\n \"psr_column\": \"<string>\",\n \"psr_column_value\": \"<string>\",\n \"psr_priority_static\": 123,\n \"psr_priority_column\": \"<string>\"\n },\n \"relationships\": {\n \"organisation\": {\n \"data\": {\n \"type\": \"<string>\",\n \"id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n }\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>",
"attributes": {
"property_id_source": "uprn",
"supply_type_mode": "fixed",
"import_type": "meters",
"name": "<string>",
"column_headers": [
"<string>"
],
"uprn_column": "<string>",
"fixed_supply_type": "<string>",
"address_columns": [
"<string>"
],
"supply_identifier_column": "<string>",
"serial_number_column": "<string>",
"supply_type_column": "<string>",
"supply_type_value_mapping": {},
"meter_extra_info_rules": [
{
"type": "global",
"display_name": "<string>",
"field": "<string>",
"value": "<string>",
"column": "<string>",
"match_values": [
"<string>"
]
}
],
"psr_extra_info_rules": [
{
"type": "global",
"display_name": "<string>",
"field": "<string>",
"value": "<string>",
"column": "<string>",
"match_values": [
"<string>"
]
}
],
"psr_column": "<string>",
"psr_column_value": "<string>",
"psr_priority_static": 123,
"psr_priority_column": "<string>"
},
"meta": {
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
},
"relationships": {
"organisation": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "<string>"
}
}
}
},
"jsonapi": {
"version": "<string>"
}
}{
"id": "98ca4a78-b66f-4234-9719-aaf832ee6669",
"status": "400",
"title": "A validation error was encountered",
"source": {
"parameter": "include"
},
"meta": {
"resource": "wrong_value"
}
}{
"id": "05fc9c8d-73b9-4697-9337-57f7a567a48f",
"status": "401",
"title": "You are not authorised to access this resource",
"detail": "In order to access this resource, you need the 'admin' role.",
"code": "AUTH.001"
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Authorizations
SessionOAuth2Cookie
Session token for authentication.
Body
application/vnd.api+json
The import template to create.
Show child attributes
Show child attributes
⌘I