Propose a change to a pre-construction information
curl --request POST \
--url https://api.ctrl-hub.com/v3/pre-construction-informations/{pre_construction_information_id}/proposed-changes \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"type": "pre-construction-information-proposed-changes",
"attributes": {
"reason": "<string>",
"proposed": {
"project_information": {
"description": "<string>",
"location": "<string>",
"planned_start_date": "2023-12-25",
"planned_end_date": "2023-12-25",
"existing_information": "<string>",
"client_requirements": "<string>"
},
"notifiability": {
"person_days": 1,
"working_days": 1,
"peak_workers": 1
},
"duty_holders": {
"client": {
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"principal_designer": {
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"designers": [
{
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
},
"planning_information": {
"existing_services": {
"relevant": true,
"comments": "<string>"
},
"ground_conditions": {
"relevant": true,
"comments": "<string>"
},
"contaminated_land": {
"relevant": true,
"comments": "<string>"
},
"asbestos": {
"relevant": true,
"comments": "<string>"
},
"existing_structures": {
"relevant": true,
"comments": "<string>"
},
"hazardous_materials": {
"relevant": true,
"comments": "<string>"
},
"adjacent_land_use": {
"relevant": true,
"comments": "<string>"
},
"access_and_traffic": {
"relevant": true,
"comments": "<string>"
},
"working_hours_restrictions": {
"relevant": true,
"comments": "<string>"
},
"security": {
"relevant": true,
"comments": "<string>"
},
"environmental_constraints": {
"relevant": true,
"comments": "<string>"
},
"unexploded_ordnance": {
"relevant": true,
"comments": "<string>"
}
},
"file_log": [
{
"title": "<string>",
"reference": "<string>",
"issued_on": "2023-12-25",
"notes": "<string>"
}
]
}
},
"relationships": {}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/pre-construction-informations/{pre_construction_information_id}/proposed-changes"
payload = { "data": {
"type": "pre-construction-information-proposed-changes",
"attributes": {
"reason": "<string>",
"proposed": {
"project_information": {
"description": "<string>",
"location": "<string>",
"planned_start_date": "2023-12-25",
"planned_end_date": "2023-12-25",
"existing_information": "<string>",
"client_requirements": "<string>"
},
"notifiability": {
"person_days": 1,
"working_days": 1,
"peak_workers": 1
},
"duty_holders": {
"client": {
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"principal_designer": {
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"designers": [
{
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
},
"planning_information": {
"existing_services": {
"relevant": True,
"comments": "<string>"
},
"ground_conditions": {
"relevant": True,
"comments": "<string>"
},
"contaminated_land": {
"relevant": True,
"comments": "<string>"
},
"asbestos": {
"relevant": True,
"comments": "<string>"
},
"existing_structures": {
"relevant": True,
"comments": "<string>"
},
"hazardous_materials": {
"relevant": True,
"comments": "<string>"
},
"adjacent_land_use": {
"relevant": True,
"comments": "<string>"
},
"access_and_traffic": {
"relevant": True,
"comments": "<string>"
},
"working_hours_restrictions": {
"relevant": True,
"comments": "<string>"
},
"security": {
"relevant": True,
"comments": "<string>"
},
"environmental_constraints": {
"relevant": True,
"comments": "<string>"
},
"unexploded_ordnance": {
"relevant": True,
"comments": "<string>"
}
},
"file_log": [
{
"title": "<string>",
"reference": "<string>",
"issued_on": "2023-12-25",
"notes": "<string>"
}
]
}
},
"relationships": {}
} }
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: 'pre-construction-information-proposed-changes',
attributes: {
reason: '<string>',
proposed: {
project_information: {
description: '<string>',
location: '<string>',
planned_start_date: '2023-12-25',
planned_end_date: '2023-12-25',
existing_information: '<string>',
client_requirements: '<string>'
},
notifiability: {person_days: 1, working_days: 1, peak_workers: 1},
duty_holders: {
client: {
name: '<string>',
organisation: '<string>',
phone: '<string>',
email: '<string>',
user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
organisation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
},
principal_designer: {
name: '<string>',
organisation: '<string>',
phone: '<string>',
email: '<string>',
user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
organisation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
},
designers: [
{
name: '<string>',
organisation: '<string>',
phone: '<string>',
email: '<string>',
user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
organisation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
]
},
planning_information: {
existing_services: {relevant: true, comments: '<string>'},
ground_conditions: {relevant: true, comments: '<string>'},
contaminated_land: {relevant: true, comments: '<string>'},
asbestos: {relevant: true, comments: '<string>'},
existing_structures: {relevant: true, comments: '<string>'},
hazardous_materials: {relevant: true, comments: '<string>'},
adjacent_land_use: {relevant: true, comments: '<string>'},
access_and_traffic: {relevant: true, comments: '<string>'},
working_hours_restrictions: {relevant: true, comments: '<string>'},
security: {relevant: true, comments: '<string>'},
environmental_constraints: {relevant: true, comments: '<string>'},
unexploded_ordnance: {relevant: true, comments: '<string>'}
},
file_log: [
{
title: '<string>',
reference: '<string>',
issued_on: '2023-12-25',
notes: '<string>'
}
]
}
},
relationships: {}
}
})
};
fetch('https://api.ctrl-hub.com/v3/pre-construction-informations/{pre_construction_information_id}/proposed-changes', 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/pre-construction-informations/{pre_construction_information_id}/proposed-changes",
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' => 'pre-construction-information-proposed-changes',
'attributes' => [
'reason' => '<string>',
'proposed' => [
'project_information' => [
'description' => '<string>',
'location' => '<string>',
'planned_start_date' => '2023-12-25',
'planned_end_date' => '2023-12-25',
'existing_information' => '<string>',
'client_requirements' => '<string>'
],
'notifiability' => [
'person_days' => 1,
'working_days' => 1,
'peak_workers' => 1
],
'duty_holders' => [
'client' => [
'name' => '<string>',
'organisation' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'organisation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'principal_designer' => [
'name' => '<string>',
'organisation' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'organisation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'designers' => [
[
'name' => '<string>',
'organisation' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'organisation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
],
'planning_information' => [
'existing_services' => [
'relevant' => true,
'comments' => '<string>'
],
'ground_conditions' => [
'relevant' => true,
'comments' => '<string>'
],
'contaminated_land' => [
'relevant' => true,
'comments' => '<string>'
],
'asbestos' => [
'relevant' => true,
'comments' => '<string>'
],
'existing_structures' => [
'relevant' => true,
'comments' => '<string>'
],
'hazardous_materials' => [
'relevant' => true,
'comments' => '<string>'
],
'adjacent_land_use' => [
'relevant' => true,
'comments' => '<string>'
],
'access_and_traffic' => [
'relevant' => true,
'comments' => '<string>'
],
'working_hours_restrictions' => [
'relevant' => true,
'comments' => '<string>'
],
'security' => [
'relevant' => true,
'comments' => '<string>'
],
'environmental_constraints' => [
'relevant' => true,
'comments' => '<string>'
],
'unexploded_ordnance' => [
'relevant' => true,
'comments' => '<string>'
]
],
'file_log' => [
[
'title' => '<string>',
'reference' => '<string>',
'issued_on' => '2023-12-25',
'notes' => '<string>'
]
]
]
],
'relationships' => [
]
]
]),
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/pre-construction-informations/{pre_construction_information_id}/proposed-changes"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"pre-construction-information-proposed-changes\",\n \"attributes\": {\n \"reason\": \"<string>\",\n \"proposed\": {\n \"project_information\": {\n \"description\": \"<string>\",\n \"location\": \"<string>\",\n \"planned_start_date\": \"2023-12-25\",\n \"planned_end_date\": \"2023-12-25\",\n \"existing_information\": \"<string>\",\n \"client_requirements\": \"<string>\"\n },\n \"notifiability\": {\n \"person_days\": 1,\n \"working_days\": 1,\n \"peak_workers\": 1\n },\n \"duty_holders\": {\n \"client\": {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"principal_designer\": {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"designers\": [\n {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n },\n \"planning_information\": {\n \"existing_services\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"ground_conditions\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"contaminated_land\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"asbestos\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"existing_structures\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"hazardous_materials\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"adjacent_land_use\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"access_and_traffic\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"working_hours_restrictions\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"security\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"environmental_constraints\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"unexploded_ordnance\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n }\n },\n \"file_log\": [\n {\n \"title\": \"<string>\",\n \"reference\": \"<string>\",\n \"issued_on\": \"2023-12-25\",\n \"notes\": \"<string>\"\n }\n ]\n }\n },\n \"relationships\": {}\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/pre-construction-informations/{pre_construction_information_id}/proposed-changes")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"pre-construction-information-proposed-changes\",\n \"attributes\": {\n \"reason\": \"<string>\",\n \"proposed\": {\n \"project_information\": {\n \"description\": \"<string>\",\n \"location\": \"<string>\",\n \"planned_start_date\": \"2023-12-25\",\n \"planned_end_date\": \"2023-12-25\",\n \"existing_information\": \"<string>\",\n \"client_requirements\": \"<string>\"\n },\n \"notifiability\": {\n \"person_days\": 1,\n \"working_days\": 1,\n \"peak_workers\": 1\n },\n \"duty_holders\": {\n \"client\": {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"principal_designer\": {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"designers\": [\n {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n },\n \"planning_information\": {\n \"existing_services\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"ground_conditions\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"contaminated_land\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"asbestos\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"existing_structures\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"hazardous_materials\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"adjacent_land_use\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"access_and_traffic\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"working_hours_restrictions\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"security\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"environmental_constraints\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"unexploded_ordnance\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n }\n },\n \"file_log\": [\n {\n \"title\": \"<string>\",\n \"reference\": \"<string>\",\n \"issued_on\": \"2023-12-25\",\n \"notes\": \"<string>\"\n }\n ]\n }\n },\n \"relationships\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/pre-construction-informations/{pre_construction_information_id}/proposed-changes")
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\": \"pre-construction-information-proposed-changes\",\n \"attributes\": {\n \"reason\": \"<string>\",\n \"proposed\": {\n \"project_information\": {\n \"description\": \"<string>\",\n \"location\": \"<string>\",\n \"planned_start_date\": \"2023-12-25\",\n \"planned_end_date\": \"2023-12-25\",\n \"existing_information\": \"<string>\",\n \"client_requirements\": \"<string>\"\n },\n \"notifiability\": {\n \"person_days\": 1,\n \"working_days\": 1,\n \"peak_workers\": 1\n },\n \"duty_holders\": {\n \"client\": {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"principal_designer\": {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"designers\": [\n {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n },\n \"planning_information\": {\n \"existing_services\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"ground_conditions\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"contaminated_land\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"asbestos\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"existing_structures\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"hazardous_materials\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"adjacent_land_use\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"access_and_traffic\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"working_hours_restrictions\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"security\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"environmental_constraints\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"unexploded_ordnance\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n }\n },\n \"file_log\": [\n {\n \"title\": \"<string>\",\n \"reference\": \"<string>\",\n \"issued_on\": \"2023-12-25\",\n \"notes\": \"<string>\"\n }\n ]\n }\n },\n \"relationships\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "pre-construction-information-proposed-changes",
"attributes": {
"reason": "<string>",
"section": "project_information",
"operation": "replace",
"state": "pending",
"base_revision": 123,
"proposed": {
"project_information": {
"description": "<string>",
"location": "<string>",
"planned_start_date": "2023-12-25",
"planned_end_date": "2023-12-25",
"existing_information": "<string>",
"client_requirements": "<string>"
},
"notifiability": {
"person_days": 1,
"working_days": 1,
"peak_workers": 1
},
"duty_holders": {
"client": {
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"principal_designer": {
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"designers": [
{
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
},
"planning_information": {
"existing_services": {
"relevant": true,
"comments": "<string>"
},
"ground_conditions": {
"relevant": true,
"comments": "<string>"
},
"contaminated_land": {
"relevant": true,
"comments": "<string>"
},
"asbestos": {
"relevant": true,
"comments": "<string>"
},
"existing_structures": {
"relevant": true,
"comments": "<string>"
},
"hazardous_materials": {
"relevant": true,
"comments": "<string>"
},
"adjacent_land_use": {
"relevant": true,
"comments": "<string>"
},
"access_and_traffic": {
"relevant": true,
"comments": "<string>"
},
"working_hours_restrictions": {
"relevant": true,
"comments": "<string>"
},
"security": {
"relevant": true,
"comments": "<string>"
},
"environmental_constraints": {
"relevant": true,
"comments": "<string>"
},
"unexploded_ordnance": {
"relevant": true,
"comments": "<string>"
}
},
"file_log": [
{
"title": "<string>",
"reference": "<string>",
"issued_on": "2023-12-25",
"notes": "<string>"
}
],
"hazard": {
"description": "<string>",
"associated_activity": "<string>",
"identified_by": "<string>",
"identified_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"identified_on": "2023-12-25"
}
},
"proposed_by": {
"acting_role": "client_and_principal_designer",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at": "2023-11-07T05:31:56Z",
"principal_type": "users",
"principal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"access": {
"can_resolve": true
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"resolved_by": {
"acting_role": "client_and_principal_designer",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at": "2023-11-07T05:31:56Z",
"principal_type": "users",
"principal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"rejection_reason": "<string>",
"resulting_revision": 123
},
"relationships": {
"pre_construction_information": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "pre-construction-informations"
}
},
"hazard": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "pre-construction-information-hazards"
}
},
"superseded_by": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "pre-construction-information-proposed-changes"
}
}
}
},
"jsonapi": {
"version": "1.0"
}
}{
"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"
}{
"errors": [
{
"id": "1b3f2c30-2d56-4d3a-9c44-9be9c2cbf2f0",
"status": "403",
"title": "Forbidden",
"detail": "You do not hold the grant required for this action.",
"code": "AUTH.002"
}
]
}{
"id": "7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f",
"status": "404",
"title": "Resource not found",
"detail": "The requested resource could not be found or does not exist.",
"code": "NOT_FOUND.001"
}{
"id": "8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g",
"status": "409",
"title": "Conflict",
"detail": "The request conflicts with the current state of the resource.",
"code": "CONFLICT.001"
}{
"id": "fe9d9a69-f0a7-4fdc-bb2c-176027f316c5",
"status": "500",
"title": "Internal Server Error",
"detail": "An unexpected error occurred on the server."
}Pre-Construction Information
Propose a change to a pre-construction information
Propose a change after the document’s handover. The Client and the Principal Contractor can propose; the other party accepts or rejects.
POST
/
v3
/
pre-construction-informations
/
{pre_construction_information_id}
/
proposed-changes
Propose a change to a pre-construction information
curl --request POST \
--url https://api.ctrl-hub.com/v3/pre-construction-informations/{pre_construction_information_id}/proposed-changes \
--header 'Content-Type: application/vnd.api+json' \
--header 'X-Session-Token: <api-key>' \
--data '
{
"data": {
"type": "pre-construction-information-proposed-changes",
"attributes": {
"reason": "<string>",
"proposed": {
"project_information": {
"description": "<string>",
"location": "<string>",
"planned_start_date": "2023-12-25",
"planned_end_date": "2023-12-25",
"existing_information": "<string>",
"client_requirements": "<string>"
},
"notifiability": {
"person_days": 1,
"working_days": 1,
"peak_workers": 1
},
"duty_holders": {
"client": {
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"principal_designer": {
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"designers": [
{
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
},
"planning_information": {
"existing_services": {
"relevant": true,
"comments": "<string>"
},
"ground_conditions": {
"relevant": true,
"comments": "<string>"
},
"contaminated_land": {
"relevant": true,
"comments": "<string>"
},
"asbestos": {
"relevant": true,
"comments": "<string>"
},
"existing_structures": {
"relevant": true,
"comments": "<string>"
},
"hazardous_materials": {
"relevant": true,
"comments": "<string>"
},
"adjacent_land_use": {
"relevant": true,
"comments": "<string>"
},
"access_and_traffic": {
"relevant": true,
"comments": "<string>"
},
"working_hours_restrictions": {
"relevant": true,
"comments": "<string>"
},
"security": {
"relevant": true,
"comments": "<string>"
},
"environmental_constraints": {
"relevant": true,
"comments": "<string>"
},
"unexploded_ordnance": {
"relevant": true,
"comments": "<string>"
}
},
"file_log": [
{
"title": "<string>",
"reference": "<string>",
"issued_on": "2023-12-25",
"notes": "<string>"
}
]
}
},
"relationships": {}
}
}
'import requests
url = "https://api.ctrl-hub.com/v3/pre-construction-informations/{pre_construction_information_id}/proposed-changes"
payload = { "data": {
"type": "pre-construction-information-proposed-changes",
"attributes": {
"reason": "<string>",
"proposed": {
"project_information": {
"description": "<string>",
"location": "<string>",
"planned_start_date": "2023-12-25",
"planned_end_date": "2023-12-25",
"existing_information": "<string>",
"client_requirements": "<string>"
},
"notifiability": {
"person_days": 1,
"working_days": 1,
"peak_workers": 1
},
"duty_holders": {
"client": {
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"principal_designer": {
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"designers": [
{
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
},
"planning_information": {
"existing_services": {
"relevant": True,
"comments": "<string>"
},
"ground_conditions": {
"relevant": True,
"comments": "<string>"
},
"contaminated_land": {
"relevant": True,
"comments": "<string>"
},
"asbestos": {
"relevant": True,
"comments": "<string>"
},
"existing_structures": {
"relevant": True,
"comments": "<string>"
},
"hazardous_materials": {
"relevant": True,
"comments": "<string>"
},
"adjacent_land_use": {
"relevant": True,
"comments": "<string>"
},
"access_and_traffic": {
"relevant": True,
"comments": "<string>"
},
"working_hours_restrictions": {
"relevant": True,
"comments": "<string>"
},
"security": {
"relevant": True,
"comments": "<string>"
},
"environmental_constraints": {
"relevant": True,
"comments": "<string>"
},
"unexploded_ordnance": {
"relevant": True,
"comments": "<string>"
}
},
"file_log": [
{
"title": "<string>",
"reference": "<string>",
"issued_on": "2023-12-25",
"notes": "<string>"
}
]
}
},
"relationships": {}
} }
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: 'pre-construction-information-proposed-changes',
attributes: {
reason: '<string>',
proposed: {
project_information: {
description: '<string>',
location: '<string>',
planned_start_date: '2023-12-25',
planned_end_date: '2023-12-25',
existing_information: '<string>',
client_requirements: '<string>'
},
notifiability: {person_days: 1, working_days: 1, peak_workers: 1},
duty_holders: {
client: {
name: '<string>',
organisation: '<string>',
phone: '<string>',
email: '<string>',
user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
organisation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
},
principal_designer: {
name: '<string>',
organisation: '<string>',
phone: '<string>',
email: '<string>',
user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
organisation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
},
designers: [
{
name: '<string>',
organisation: '<string>',
phone: '<string>',
email: '<string>',
user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
organisation_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
}
]
},
planning_information: {
existing_services: {relevant: true, comments: '<string>'},
ground_conditions: {relevant: true, comments: '<string>'},
contaminated_land: {relevant: true, comments: '<string>'},
asbestos: {relevant: true, comments: '<string>'},
existing_structures: {relevant: true, comments: '<string>'},
hazardous_materials: {relevant: true, comments: '<string>'},
adjacent_land_use: {relevant: true, comments: '<string>'},
access_and_traffic: {relevant: true, comments: '<string>'},
working_hours_restrictions: {relevant: true, comments: '<string>'},
security: {relevant: true, comments: '<string>'},
environmental_constraints: {relevant: true, comments: '<string>'},
unexploded_ordnance: {relevant: true, comments: '<string>'}
},
file_log: [
{
title: '<string>',
reference: '<string>',
issued_on: '2023-12-25',
notes: '<string>'
}
]
}
},
relationships: {}
}
})
};
fetch('https://api.ctrl-hub.com/v3/pre-construction-informations/{pre_construction_information_id}/proposed-changes', 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/pre-construction-informations/{pre_construction_information_id}/proposed-changes",
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' => 'pre-construction-information-proposed-changes',
'attributes' => [
'reason' => '<string>',
'proposed' => [
'project_information' => [
'description' => '<string>',
'location' => '<string>',
'planned_start_date' => '2023-12-25',
'planned_end_date' => '2023-12-25',
'existing_information' => '<string>',
'client_requirements' => '<string>'
],
'notifiability' => [
'person_days' => 1,
'working_days' => 1,
'peak_workers' => 1
],
'duty_holders' => [
'client' => [
'name' => '<string>',
'organisation' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'organisation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'principal_designer' => [
'name' => '<string>',
'organisation' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'organisation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'designers' => [
[
'name' => '<string>',
'organisation' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'organisation_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]
]
],
'planning_information' => [
'existing_services' => [
'relevant' => true,
'comments' => '<string>'
],
'ground_conditions' => [
'relevant' => true,
'comments' => '<string>'
],
'contaminated_land' => [
'relevant' => true,
'comments' => '<string>'
],
'asbestos' => [
'relevant' => true,
'comments' => '<string>'
],
'existing_structures' => [
'relevant' => true,
'comments' => '<string>'
],
'hazardous_materials' => [
'relevant' => true,
'comments' => '<string>'
],
'adjacent_land_use' => [
'relevant' => true,
'comments' => '<string>'
],
'access_and_traffic' => [
'relevant' => true,
'comments' => '<string>'
],
'working_hours_restrictions' => [
'relevant' => true,
'comments' => '<string>'
],
'security' => [
'relevant' => true,
'comments' => '<string>'
],
'environmental_constraints' => [
'relevant' => true,
'comments' => '<string>'
],
'unexploded_ordnance' => [
'relevant' => true,
'comments' => '<string>'
]
],
'file_log' => [
[
'title' => '<string>',
'reference' => '<string>',
'issued_on' => '2023-12-25',
'notes' => '<string>'
]
]
]
],
'relationships' => [
]
]
]),
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/pre-construction-informations/{pre_construction_information_id}/proposed-changes"
payload := strings.NewReader("{\n \"data\": {\n \"type\": \"pre-construction-information-proposed-changes\",\n \"attributes\": {\n \"reason\": \"<string>\",\n \"proposed\": {\n \"project_information\": {\n \"description\": \"<string>\",\n \"location\": \"<string>\",\n \"planned_start_date\": \"2023-12-25\",\n \"planned_end_date\": \"2023-12-25\",\n \"existing_information\": \"<string>\",\n \"client_requirements\": \"<string>\"\n },\n \"notifiability\": {\n \"person_days\": 1,\n \"working_days\": 1,\n \"peak_workers\": 1\n },\n \"duty_holders\": {\n \"client\": {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"principal_designer\": {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"designers\": [\n {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n },\n \"planning_information\": {\n \"existing_services\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"ground_conditions\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"contaminated_land\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"asbestos\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"existing_structures\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"hazardous_materials\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"adjacent_land_use\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"access_and_traffic\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"working_hours_restrictions\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"security\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"environmental_constraints\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"unexploded_ordnance\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n }\n },\n \"file_log\": [\n {\n \"title\": \"<string>\",\n \"reference\": \"<string>\",\n \"issued_on\": \"2023-12-25\",\n \"notes\": \"<string>\"\n }\n ]\n }\n },\n \"relationships\": {}\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/pre-construction-informations/{pre_construction_information_id}/proposed-changes")
.header("X-Session-Token", "<api-key>")
.header("Content-Type", "application/vnd.api+json")
.body("{\n \"data\": {\n \"type\": \"pre-construction-information-proposed-changes\",\n \"attributes\": {\n \"reason\": \"<string>\",\n \"proposed\": {\n \"project_information\": {\n \"description\": \"<string>\",\n \"location\": \"<string>\",\n \"planned_start_date\": \"2023-12-25\",\n \"planned_end_date\": \"2023-12-25\",\n \"existing_information\": \"<string>\",\n \"client_requirements\": \"<string>\"\n },\n \"notifiability\": {\n \"person_days\": 1,\n \"working_days\": 1,\n \"peak_workers\": 1\n },\n \"duty_holders\": {\n \"client\": {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"principal_designer\": {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"designers\": [\n {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n },\n \"planning_information\": {\n \"existing_services\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"ground_conditions\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"contaminated_land\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"asbestos\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"existing_structures\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"hazardous_materials\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"adjacent_land_use\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"access_and_traffic\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"working_hours_restrictions\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"security\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"environmental_constraints\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"unexploded_ordnance\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n }\n },\n \"file_log\": [\n {\n \"title\": \"<string>\",\n \"reference\": \"<string>\",\n \"issued_on\": \"2023-12-25\",\n \"notes\": \"<string>\"\n }\n ]\n }\n },\n \"relationships\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ctrl-hub.com/v3/pre-construction-informations/{pre_construction_information_id}/proposed-changes")
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\": \"pre-construction-information-proposed-changes\",\n \"attributes\": {\n \"reason\": \"<string>\",\n \"proposed\": {\n \"project_information\": {\n \"description\": \"<string>\",\n \"location\": \"<string>\",\n \"planned_start_date\": \"2023-12-25\",\n \"planned_end_date\": \"2023-12-25\",\n \"existing_information\": \"<string>\",\n \"client_requirements\": \"<string>\"\n },\n \"notifiability\": {\n \"person_days\": 1,\n \"working_days\": 1,\n \"peak_workers\": 1\n },\n \"duty_holders\": {\n \"client\": {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"principal_designer\": {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n },\n \"designers\": [\n {\n \"name\": \"<string>\",\n \"organisation\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"organisation_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n }\n ]\n },\n \"planning_information\": {\n \"existing_services\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"ground_conditions\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"contaminated_land\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"asbestos\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"existing_structures\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"hazardous_materials\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"adjacent_land_use\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"access_and_traffic\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"working_hours_restrictions\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"security\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"environmental_constraints\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n },\n \"unexploded_ordnance\": {\n \"relevant\": true,\n \"comments\": \"<string>\"\n }\n },\n \"file_log\": [\n {\n \"title\": \"<string>\",\n \"reference\": \"<string>\",\n \"issued_on\": \"2023-12-25\",\n \"notes\": \"<string>\"\n }\n ]\n }\n },\n \"relationships\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "pre-construction-information-proposed-changes",
"attributes": {
"reason": "<string>",
"section": "project_information",
"operation": "replace",
"state": "pending",
"base_revision": 123,
"proposed": {
"project_information": {
"description": "<string>",
"location": "<string>",
"planned_start_date": "2023-12-25",
"planned_end_date": "2023-12-25",
"existing_information": "<string>",
"client_requirements": "<string>"
},
"notifiability": {
"person_days": 1,
"working_days": 1,
"peak_workers": 1
},
"duty_holders": {
"client": {
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"principal_designer": {
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"designers": [
{
"name": "<string>",
"organisation": "<string>",
"phone": "<string>",
"email": "<string>",
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
]
},
"planning_information": {
"existing_services": {
"relevant": true,
"comments": "<string>"
},
"ground_conditions": {
"relevant": true,
"comments": "<string>"
},
"contaminated_land": {
"relevant": true,
"comments": "<string>"
},
"asbestos": {
"relevant": true,
"comments": "<string>"
},
"existing_structures": {
"relevant": true,
"comments": "<string>"
},
"hazardous_materials": {
"relevant": true,
"comments": "<string>"
},
"adjacent_land_use": {
"relevant": true,
"comments": "<string>"
},
"access_and_traffic": {
"relevant": true,
"comments": "<string>"
},
"working_hours_restrictions": {
"relevant": true,
"comments": "<string>"
},
"security": {
"relevant": true,
"comments": "<string>"
},
"environmental_constraints": {
"relevant": true,
"comments": "<string>"
},
"unexploded_ordnance": {
"relevant": true,
"comments": "<string>"
}
},
"file_log": [
{
"title": "<string>",
"reference": "<string>",
"issued_on": "2023-12-25",
"notes": "<string>"
}
],
"hazard": {
"description": "<string>",
"associated_activity": "<string>",
"identified_by": "<string>",
"identified_by_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"identified_on": "2023-12-25"
}
},
"proposed_by": {
"acting_role": "client_and_principal_designer",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at": "2023-11-07T05:31:56Z",
"principal_type": "users",
"principal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"access": {
"can_resolve": true
},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"resolved_by": {
"acting_role": "client_and_principal_designer",
"organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"at": "2023-11-07T05:31:56Z",
"principal_type": "users",
"principal_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"rejection_reason": "<string>",
"resulting_revision": 123
},
"relationships": {
"pre_construction_information": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "pre-construction-informations"
}
},
"hazard": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "pre-construction-information-hazards"
}
},
"superseded_by": {
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "pre-construction-information-proposed-changes"
}
}
}
},
"jsonapi": {
"version": "1.0"
}
}{
"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"
}{
"errors": [
{
"id": "1b3f2c30-2d56-4d3a-9c44-9be9c2cbf2f0",
"status": "403",
"title": "Forbidden",
"detail": "You do not hold the grant required for this action.",
"code": "AUTH.002"
}
]
}{
"id": "7b4c8f12-3e9a-4d5b-8c6f-1a2b3c4d5e6f",
"status": "404",
"title": "Resource not found",
"detail": "The requested resource could not be found or does not exist.",
"code": "NOT_FOUND.001"
}{
"id": "8e2f9a34-b5c6-4d7e-9f8a-2b3c4d5e6f7g",
"status": "409",
"title": "Conflict",
"detail": "The request conflicts with the current state of the resource.",
"code": "CONFLICT.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.
Path Parameters
The unique identifier for the pre-construction information resource.
Body
application/vnd.api+json
Propose a change to one section, or one hazard create, update or delete. proposed holds
exactly the property section names (hazard for a hazard create or update) and nothing
for a deletion. A hazard update or delete names the hazard in relationships.hazard.
Who proposed it, and when, are taken from the request.
Show child attributes
Show child attributes
Response
A proposed change to a pre-construction information.