Skip to content
/
Create 'Building'

Create 'Building'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/json
namestring, <= 255 charactersrequired
realestateobject(RealEstate)required
organizationobject or null(Organization)
custom_idstring or null, <= 128 characters
addressobject or null(Address)

Content Type: common.address

registered_usable_areanumber or null, (float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_gross_area

registered_building_areanumber or null, (float)
registered_gross_areanumber or null, (float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_bi_area, registered_usable_area

registered_bi_areanumber or null, (float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_gross_area

built_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_end_date, availability_start_date, demolition_date

availability_start_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_end_date, demolition_date, built_date

availability_end_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: demolition_date, availability_start_date, built_date

demolition_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_end_date, availability_start_date, built_date

public_descriptionstring or null
sales_descriptionstring or null
custom_dimension_valuestring or null, <= 255 characters
structure_operation_typeinteger or null, (int32), [ -2147483648 .. 2147483647 ]

Additional Validation Information:

Enum Descriptions:

  • 1 - Electricity Heat Station

  • 2 - Electricity Water Station

  • 3 - Electricity Wind Low Taxation

  • 5 - Rentable Housing

  • 7 - Rentable Industrial Premises

  • 6 - Rentable Housing Outdoor Area

  • 8 - Rentable Industrial Premises Outdoor Area

  • 10 - Industry Office

  • 11 - Industry Storage

  • 12 - Industry Production

  • 13 - Industry Construction

  • 14 - Industry Production Method Structure

  • 15 - Beat Office

  • 16 - Beat Storage

  • 17 - Beat Production

  • 18 - Beat Construction

  • 25 - Agriculture Small Housing

  • 27 - Special Unit

  • 28 - Other

Enum:1235768101112
structure_typestring or null, <= 64 characters

Additional Validation Information:

Enum Descriptions:

  • AAA - Aaa

  • AAB - Aab

  • AAC - Aac

  • ABA - Aba

  • ABB - Abb

  • ABC - Abc

  • ACB - Acb

  • ADA - Ada

  • ADB - Adb

  • AEA - Aea

  • AEB - Aeb

  • AEC - Aec

  • AED - Aed

  • AFA - Afa

  • AGA - Aga

  • AGB - Agb

  • AGD - Agd

  • AHA - Aha

  • AHB - Ahb

  • AJA - Aja

  • AJB - Ajb

  • AJC - Ajc

  • AJF - Ajf

  • AKA - Aka

  • AKE - Ake

  • ALA - Ala

  • ALC - Alc

  • ALD - Ald

  • ALF - Alf

  • ALG - Alg

  • AMA - Ama

  • AMB - Amb

  • AMC - Amc

  • AMG - Amg

  • ANA - Ana

  • ANC - Anc

  • AND - And

  • APA - Apa

  • APC - Apc

  • APE - Ape

  • BAA - Baa

  • BAB - Bab

  • BAC - Bac

  • BAD - Bad

  • BAE - Bae

  • BAK - Bak

  • BBB - Bbb

  • BBC - Bbc

  • BBH - Bbh

  • BEA - Bea

  • BEF - Bef

  • BFA - Bfa

  • BFB - Bfb

  • BFD - Bfd

  • BFE - Bfe

  • BFF - Bff

  • BFG - Bfg

  • CBD - Cbd

  • CBE - Cbe

  • CBF - Cbf

  • CBG - Cbg

  • CBH - Cbh

  • CBJ - Cbj

  • XBA - Xba

  • PX_OTHER - Px Other

  • PX_HOSPITAL - Px Hospital

  • PX_CINEMA - Px Cinema

  • PX_KINDERGARDEN - Px Kindergarden

  • PX_LIBRARY - Px Library

  • PX_WORKSHOP - Px Workshop

  • PX_INDUSTRIAL_PREMISES - Px Industrial Premises

Enum:"AAA""AAB""AAC""ABA""ABB""ABC""ACB""ADA""ADB""AEA"
registered_tempered_areanumber or null, (float)
POST
/objects/structural/building/
curl -i -X POST \
  https://dev.api.pigello.io/objects/structural/building/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "custom_id": "string",
    "name": "string",
    "realestate": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "address": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "registered_usable_area": 0.1,
    "registered_building_area": 0.1,
    "registered_gross_area": 0.1,
    "registered_bi_area": 0.1,
    "built_date": "2019-08-24",
    "availability_start_date": "2019-08-24",
    "availability_end_date": "2019-08-24",
    "demolition_date": "2019-08-24",
    "public_description": "string",
    "sales_description": "string",
    "custom_dimension_value": "string",
    "structure_operation_type": 1,
    "structure_type": "AAA",
    "registered_tempered_area": 0.1
  }'

Responses

Successful creation

Bodyapplication/json
idstring, (uuid)read-onlyrequired

Additional Validation Information:

Must be unique

namestring, <= 255 charactersrequired
realestateobject(RealEstate)required
organizationobject or null(Organization)
custom_idstring or null, <= 128 characters
created_atstring, (date-time)read-only
addressobject or null(Address)

Content Type: common.address

registered_usable_areanumber or null, (float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_gross_area

registered_building_areanumber or null, (float)
registered_gross_areanumber or null, (float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_bi_area, registered_usable_area

registered_bi_areanumber or null, (float)

Additional Validation Information:

This value must be set with a proper magnitude, in relation to the following fields: registered_gross_area

calculated_usable_areanumber, (float)read-only
calculated_bi_areanumber, (float)read-only
calculated_usable_area_rentablenumber, (float)read-only
calculated_bi_area_rentablenumber, (float)read-only
calculated_usable_area_rentable_base_rent_vatnumber, (float)read-only
calculated_bi_area_rentable_base_rent_vatnumber, (float)read-only
built_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_end_date, availability_start_date, demolition_date

availability_start_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_end_date, demolition_date, built_date

availability_end_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: demolition_date, availability_start_date, built_date

demolition_datestring or null, (date)

Additional Validation Information:

This value must be set in an proper order, in relation to the following fields: availability_end_date, availability_start_date, built_date

public_descriptionstring or null
sales_descriptionstring or null
custom_dimension_valuestring or null, <= 255 characters
structure_operation_typeinteger or null, (int32), [ -2147483648 .. 2147483647 ]

Additional Validation Information:

Enum Descriptions:

  • 1 - Electricity Heat Station

  • 2 - Electricity Water Station

  • 3 - Electricity Wind Low Taxation

  • 5 - Rentable Housing

  • 7 - Rentable Industrial Premises

  • 6 - Rentable Housing Outdoor Area

  • 8 - Rentable Industrial Premises Outdoor Area

  • 10 - Industry Office

  • 11 - Industry Storage

  • 12 - Industry Production

  • 13 - Industry Construction

  • 14 - Industry Production Method Structure

  • 15 - Beat Office

  • 16 - Beat Storage

  • 17 - Beat Production

  • 18 - Beat Construction

  • 25 - Agriculture Small Housing

  • 27 - Special Unit

  • 28 - Other

Enum:1235768101112
structure_typestring or null, <= 64 characters

Additional Validation Information:

Enum Descriptions:

  • AAA - Aaa

  • AAB - Aab

  • AAC - Aac

  • ABA - Aba

  • ABB - Abb

  • ABC - Abc

  • ACB - Acb

  • ADA - Ada

  • ADB - Adb

  • AEA - Aea

  • AEB - Aeb

  • AEC - Aec

  • AED - Aed

  • AFA - Afa

  • AGA - Aga

  • AGB - Agb

  • AGD - Agd

  • AHA - Aha

  • AHB - Ahb

  • AJA - Aja

  • AJB - Ajb

  • AJC - Ajc

  • AJF - Ajf

  • AKA - Aka

  • AKE - Ake

  • ALA - Ala

  • ALC - Alc

  • ALD - Ald

  • ALF - Alf

  • ALG - Alg

  • AMA - Ama

  • AMB - Amb

  • AMC - Amc

  • AMG - Amg

  • ANA - Ana

  • ANC - Anc

  • AND - And

  • APA - Apa

  • APC - Apc

  • APE - Ape

  • BAA - Baa

  • BAB - Bab

  • BAC - Bac

  • BAD - Bad

  • BAE - Bae

  • BAK - Bak

  • BBB - Bbb

  • BBC - Bbc

  • BBH - Bbh

  • BEA - Bea

  • BEF - Bef

  • BFA - Bfa

  • BFB - Bfb

  • BFD - Bfd

  • BFE - Bfe

  • BFF - Bff

  • BFG - Bfg

  • CBD - Cbd

  • CBE - Cbe

  • CBF - Cbf

  • CBG - Cbg

  • CBH - Cbh

  • CBJ - Cbj

  • XBA - Xba

  • PX_OTHER - Px Other

  • PX_HOSPITAL - Px Hospital

  • PX_CINEMA - Px Cinema

  • PX_KINDERGARDEN - Px Kindergarden

  • PX_LIBRARY - Px Library

  • PX_WORKSHOP - Px Workshop

  • PX_INDUSTRIAL_PREMISES - Px Industrial Premises

Enum:"AAA""AAB""AAC""ABA""ABB""ABC""ACB""ADA""ADB""AEA"
registered_tempered_areanumber or null, (float)
calculated_tempered_areanumber, (float)read-only
tagsanyread-only
customer_columnsanyread-only
pending_monitor_approval_amountanyread-only
Response
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "name": "string",
  "realestate": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "address": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "organization": { … },
    "custom_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "care_of": "string",
    "attention": "string",
    "street": "string",
    "street_number": "string",
    "postal_code": "string",
    "city": "string",
    "country": "string",
    "longitude": -180,
    "latitude": -90
  },
  "registered_usable_area": 0.1,
  "registered_building_area": 0.1,
  "registered_gross_area": 0.1,
  "registered_bi_area": 0.1,
  "calculated_usable_area": 0.1,
  "calculated_bi_area": 0.1,
  "calculated_usable_area_rentable": 0.1,
  "calculated_bi_area_rentable": 0.1,
  "calculated_usable_area_rentable_base_rent_vat": 0.1,
  "calculated_bi_area_rentable_base_rent_vat": 0.1,
  "built_date": "2019-08-24",
  "availability_start_date": "2019-08-24",
  "availability_end_date": "2019-08-24",
  "demolition_date": "2019-08-24",
  "public_description": "string",
  "sales_description": "string",
  "custom_dimension_value": "string",
  "structure_operation_type": 1,
  "structure_type": "AAA",
  "registered_tempered_area": 0.1,
  "calculated_tempered_area": 0.1,
  "tags": null,
  "customer_columns": null,
  "pending_monitor_approval_amount": null
}
© Pigello. All rights reserved.