Worksite creation
curl --request POST \
--url https://api.opx.co/partners/v1/worksites \
--header 'Content-Type: application/json' \
--data '
{
"convention_id": 123,
"beneficiary_id": 123,
"external_reference": "<string>",
"address": "<string>",
"city": "<string>",
"zipcode": "<string>",
"country": "<string>",
"additional_address": "<string>",
"indivision": true,
"cadastral_parcel": "<string>",
"fiscal_informations": [
{
"firstname": "<string>",
"lastname": "<string>",
"fiscal_number": "<string>",
"fiscal_reference": "<string>"
}
]
}
'import requests
url = "https://api.opx.co/partners/v1/worksites"
payload = {
"convention_id": 123,
"beneficiary_id": 123,
"external_reference": "<string>",
"address": "<string>",
"city": "<string>",
"zipcode": "<string>",
"country": "<string>",
"additional_address": "<string>",
"indivision": True,
"cadastral_parcel": "<string>",
"fiscal_informations": [
{
"firstname": "<string>",
"lastname": "<string>",
"fiscal_number": "<string>",
"fiscal_reference": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
convention_id: 123,
beneficiary_id: 123,
external_reference: '<string>',
address: '<string>',
city: '<string>',
zipcode: '<string>',
country: '<string>',
additional_address: '<string>',
indivision: true,
cadastral_parcel: '<string>',
fiscal_informations: [
{
firstname: '<string>',
lastname: '<string>',
fiscal_number: '<string>',
fiscal_reference: '<string>'
}
]
})
};
fetch('https://api.opx.co/partners/v1/worksites', 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.opx.co/partners/v1/worksites",
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([
'convention_id' => 123,
'beneficiary_id' => 123,
'external_reference' => '<string>',
'address' => '<string>',
'city' => '<string>',
'zipcode' => '<string>',
'country' => '<string>',
'additional_address' => '<string>',
'indivision' => true,
'cadastral_parcel' => '<string>',
'fiscal_informations' => [
[
'firstname' => '<string>',
'lastname' => '<string>',
'fiscal_number' => '<string>',
'fiscal_reference' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"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.opx.co/partners/v1/worksites"
payload := strings.NewReader("{\n \"convention_id\": 123,\n \"beneficiary_id\": 123,\n \"external_reference\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"country\": \"<string>\",\n \"additional_address\": \"<string>\",\n \"indivision\": true,\n \"cadastral_parcel\": \"<string>\",\n \"fiscal_informations\": [\n {\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"fiscal_number\": \"<string>\",\n \"fiscal_reference\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.opx.co/partners/v1/worksites")
.header("Content-Type", "application/json")
.body("{\n \"convention_id\": 123,\n \"beneficiary_id\": 123,\n \"external_reference\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"country\": \"<string>\",\n \"additional_address\": \"<string>\",\n \"indivision\": true,\n \"cadastral_parcel\": \"<string>\",\n \"fiscal_informations\": [\n {\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"fiscal_number\": \"<string>\",\n \"fiscal_reference\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opx.co/partners/v1/worksites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"convention_id\": 123,\n \"beneficiary_id\": 123,\n \"external_reference\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"country\": \"<string>\",\n \"additional_address\": \"<string>\",\n \"indivision\": true,\n \"cadastral_parcel\": \"<string>\",\n \"fiscal_informations\": [\n {\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"fiscal_number\": \"<string>\",\n \"fiscal_reference\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"reference": "<string>",
"external_reference": "<string>",
"convention_id": 123,
"beneficiary_id": 123,
"installer_name": "<string>",
"zipcode": "<string>",
"address": "<string>",
"city": "<string>",
"status": "<string>",
"created_at": "<string>",
"precarity_type": "<string>",
"fiscal_informations": [
{
"firstname": "<string>",
"lastname": "<string>",
"fiscal_number": "<string>",
"fiscal_reference": "<string>"
}
],
"indivision": true
}
}{
"message": "<string>",
"errors": {}
}Worksites
Worksite creation
POST
/
v1
/
worksites
Worksite creation
curl --request POST \
--url https://api.opx.co/partners/v1/worksites \
--header 'Content-Type: application/json' \
--data '
{
"convention_id": 123,
"beneficiary_id": 123,
"external_reference": "<string>",
"address": "<string>",
"city": "<string>",
"zipcode": "<string>",
"country": "<string>",
"additional_address": "<string>",
"indivision": true,
"cadastral_parcel": "<string>",
"fiscal_informations": [
{
"firstname": "<string>",
"lastname": "<string>",
"fiscal_number": "<string>",
"fiscal_reference": "<string>"
}
]
}
'import requests
url = "https://api.opx.co/partners/v1/worksites"
payload = {
"convention_id": 123,
"beneficiary_id": 123,
"external_reference": "<string>",
"address": "<string>",
"city": "<string>",
"zipcode": "<string>",
"country": "<string>",
"additional_address": "<string>",
"indivision": True,
"cadastral_parcel": "<string>",
"fiscal_informations": [
{
"firstname": "<string>",
"lastname": "<string>",
"fiscal_number": "<string>",
"fiscal_reference": "<string>"
}
]
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
convention_id: 123,
beneficiary_id: 123,
external_reference: '<string>',
address: '<string>',
city: '<string>',
zipcode: '<string>',
country: '<string>',
additional_address: '<string>',
indivision: true,
cadastral_parcel: '<string>',
fiscal_informations: [
{
firstname: '<string>',
lastname: '<string>',
fiscal_number: '<string>',
fiscal_reference: '<string>'
}
]
})
};
fetch('https://api.opx.co/partners/v1/worksites', 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.opx.co/partners/v1/worksites",
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([
'convention_id' => 123,
'beneficiary_id' => 123,
'external_reference' => '<string>',
'address' => '<string>',
'city' => '<string>',
'zipcode' => '<string>',
'country' => '<string>',
'additional_address' => '<string>',
'indivision' => true,
'cadastral_parcel' => '<string>',
'fiscal_informations' => [
[
'firstname' => '<string>',
'lastname' => '<string>',
'fiscal_number' => '<string>',
'fiscal_reference' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"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.opx.co/partners/v1/worksites"
payload := strings.NewReader("{\n \"convention_id\": 123,\n \"beneficiary_id\": 123,\n \"external_reference\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"country\": \"<string>\",\n \"additional_address\": \"<string>\",\n \"indivision\": true,\n \"cadastral_parcel\": \"<string>\",\n \"fiscal_informations\": [\n {\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"fiscal_number\": \"<string>\",\n \"fiscal_reference\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
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.opx.co/partners/v1/worksites")
.header("Content-Type", "application/json")
.body("{\n \"convention_id\": 123,\n \"beneficiary_id\": 123,\n \"external_reference\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"country\": \"<string>\",\n \"additional_address\": \"<string>\",\n \"indivision\": true,\n \"cadastral_parcel\": \"<string>\",\n \"fiscal_informations\": [\n {\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"fiscal_number\": \"<string>\",\n \"fiscal_reference\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opx.co/partners/v1/worksites")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"convention_id\": 123,\n \"beneficiary_id\": 123,\n \"external_reference\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"zipcode\": \"<string>\",\n \"country\": \"<string>\",\n \"additional_address\": \"<string>\",\n \"indivision\": true,\n \"cadastral_parcel\": \"<string>\",\n \"fiscal_informations\": [\n {\n \"firstname\": \"<string>\",\n \"lastname\": \"<string>\",\n \"fiscal_number\": \"<string>\",\n \"fiscal_reference\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": 123,
"reference": "<string>",
"external_reference": "<string>",
"convention_id": 123,
"beneficiary_id": 123,
"installer_name": "<string>",
"zipcode": "<string>",
"address": "<string>",
"city": "<string>",
"status": "<string>",
"created_at": "<string>",
"precarity_type": "<string>",
"fiscal_informations": [
{
"firstname": "<string>",
"lastname": "<string>",
"fiscal_number": "<string>",
"fiscal_reference": "<string>"
}
],
"indivision": true
}
}{
"message": "<string>",
"errors": {}
}Body
application/json
Available options:
direct, indirect type de précarité, par défaut "classic". Seul "classic" est accepté pour les chantiers b2b
Available options:
very-low, low, mid, classic référence cadastrale de la parcelle (préfixe-section-numéro) : "O11-AD-250"
Show child attributes
Show child attributes
Response
WorksiteResource
Show child attributes
Show child attributes
⌘I