Skip to content
/
Create 'Apartmentvacancyl...

Objects (2.0.0)

The 'Objects' application of the Core API

Download OpenAPI description
Download Postman Collection
Download OpenAPI Specification (json)
Download OpenAPI Specification (yaml)
Languages
Servers
https://{environment}.pigello.io

Parkingspot

Operations

Apartmenttargetaudience

Operations

Parkingspotvacancynotation

Operations

Industrialpremises

Operations

Industrialpremisesvacancylossnotation

Operations

Industrialpremisestargetaudience

Operations

Outdoorsectionterms

Operations

Industrialpremisesvacancynotation

Operations

Outdoorsectiontargetaudience

Operations

Commonarea

Operations

Industrialpremisesterms

Operations

Parkingspotvacancylossnotation

Operations

Outdoorsectionvacancynotation

Operations

Parkingspottargetaudience

Operations

Apartmentterms

Operations

Apartmentvacancylossnotation

Operations

Create 'Apartmentvacancylossnotation'

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
valuenumber(float)required
vacancy_notationobject(Apartmentvacancynotation)required
vacancy_notation.​idstring(uuid)
articleobject(Article)required
article.​idstring(uuid)
titlestring<= 255 charactersrequired
vatinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum025126
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
custom_dimension_valuestring or null<= 255 characters
end_datestring or null(date)

Additional Validation Information:

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

indexation_firm_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: indexation_value_quota

This value requires that the following fields are also set: indexation_base_year

indexation_settingobject or null(Indexationsetting)

Additional Validation Information:

This value must be set together with the following fields: indexation_base_year

start_datestring or null(date)

Additional Validation Information:

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

indexation_base_yearinteger or null(int32)[ 1900 .. 9000 ]

Additional Validation Information:

This value must be set together with the following fields: indexation_setting

source_row_content_typeobject or null(Contenttype)

Additional Validation Information:

This value must be set together with the following fields: source_row_object_id

source_row_object_idstring or null(uuid)

Additional Validation Information:

This value must be set together with the following fields: source_row_content_type

indexation_value_quotanumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: indexation_firm_value

This value requires that the following fields are also set: indexation_base_year

curl -i -X POST \
  https://dev.api.pigello.io/objects/spaces/vacancies/apartmentvacancylossnotation/ \
  -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",
    "value": 0.1,
    "custom_dimension_value": "string",
    "end_date": "2019-08-24",
    "indexation_firm_value": 0.1,
    "indexation_setting": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "start_date": "2019-08-24",
    "indexation_base_year": 1900,
    "vacancy_notation": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "source_row_content_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "article": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "source_row_object_id": "d44585c8-7939-493c-aafc-e82e4822bf7c",
    "indexation_value_quota": 0.1,
    "title": "string",
    "vat": 0
  }'

Responses

Successful creation

Bodyapplication/json
valuenumber(float)required
vacancy_notationobject(Apartmentvacancynotation)required
vacancy_notation.​idstring(uuid)
articleobject(Article)required
article.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

titlestring<= 255 charactersrequired
vatinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum025126
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
custom_dimension_valuestring or null<= 255 characters
end_datestring or null(date)

Additional Validation Information:

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

indexation_firm_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: indexation_value_quota

This value requires that the following fields are also set: indexation_base_year

indexation_settingobject or null(Indexationsetting)

Additional Validation Information:

This value must be set together with the following fields: indexation_base_year

start_datestring or null(date)

Additional Validation Information:

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

indexation_base_yearinteger or null(int32)[ 1900 .. 9000 ]

Additional Validation Information:

This value must be set together with the following fields: indexation_setting

source_row_content_typeobject or null(Contenttype)

Additional Validation Information:

This value must be set together with the following fields: source_row_object_id

source_row_object_idstring or null(uuid)

Additional Validation Information:

This value must be set together with the following fields: source_row_content_type

indexation_value_quotanumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: indexation_firm_value

This value requires that the following fields are also set: indexation_base_year

created_atstring(date-time)read-only
Response
application/json
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "value": 0.1,
  "custom_dimension_value": "string",
  "end_date": "2019-08-24",
  "indexation_firm_value": 0.1,
  "indexation_setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "start_date": "2019-08-24",
  "indexation_base_year": 1900,
  "vacancy_notation": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "source_row_content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "source_row_object_id": "d44585c8-7939-493c-aafc-e82e4822bf7c",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "indexation_value_quota": 0.1,
  "created_at": "2019-08-24T14:15:22Z",
  "title": "string",
  "vat": 0
}

Update 'Apartmentvacancylossnotation'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
Bodyapplication/json
valuenumber(float)required
vacancy_notationobject(Apartmentvacancynotation)required
vacancy_notation.​idstring(uuid)
articleobject(Article)required
article.​idstring(uuid)
titlestring<= 255 charactersrequired
vatinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum025126
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
custom_dimension_valuestring or null<= 255 characters
end_datestring or null(date)

Additional Validation Information:

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

indexation_firm_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: indexation_value_quota

This value requires that the following fields are also set: indexation_base_year

indexation_settingobject or null(Indexationsetting)

Additional Validation Information:

This value must be set together with the following fields: indexation_base_year

start_datestring or null(date)

Additional Validation Information:

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

indexation_base_yearinteger or null(int32)[ 1900 .. 9000 ]

Additional Validation Information:

This value must be set together with the following fields: indexation_setting

source_row_content_typeobject or null(Contenttype)

Additional Validation Information:

This value must be set together with the following fields: source_row_object_id

source_row_object_idstring or null(uuid)

Additional Validation Information:

This value must be set together with the following fields: source_row_content_type

indexation_value_quotanumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: indexation_firm_value

This value requires that the following fields are also set: indexation_base_year

curl -i -X PATCH \
  'https://dev.api.pigello.io/objects/spaces/vacancies/apartmentvacancylossnotation/{pk}/' \
  -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",
    "value": 0.1,
    "custom_dimension_value": "string",
    "end_date": "2019-08-24",
    "indexation_firm_value": 0.1,
    "indexation_setting": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "start_date": "2019-08-24",
    "indexation_base_year": 1900,
    "vacancy_notation": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "source_row_content_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "article": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "source_row_object_id": "d44585c8-7939-493c-aafc-e82e4822bf7c",
    "indexation_value_quota": 0.1,
    "title": "string",
    "vat": 0
  }'

Responses

Successful update

Bodyapplication/json
valuenumber(float)required
vacancy_notationobject(Apartmentvacancynotation)required
vacancy_notation.​idstring(uuid)
articleobject(Article)required
article.​idstring(uuid)
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

titlestring<= 255 charactersrequired
vatinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum025126
organizationobject or null(Organization)
custom_idstring or null<= 128 characters
custom_dimension_valuestring or null<= 255 characters
end_datestring or null(date)

Additional Validation Information:

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

indexation_firm_valuenumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: indexation_value_quota

This value requires that the following fields are also set: indexation_base_year

indexation_settingobject or null(Indexationsetting)

Additional Validation Information:

This value must be set together with the following fields: indexation_base_year

start_datestring or null(date)

Additional Validation Information:

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

indexation_base_yearinteger or null(int32)[ 1900 .. 9000 ]

Additional Validation Information:

This value must be set together with the following fields: indexation_setting

source_row_content_typeobject or null(Contenttype)

Additional Validation Information:

This value must be set together with the following fields: source_row_object_id

source_row_object_idstring or null(uuid)

Additional Validation Information:

This value must be set together with the following fields: source_row_content_type

indexation_value_quotanumber or null(float)

Additional Validation Information:

This value can't bet set, when any of the following fields are set: indexation_firm_value

This value requires that the following fields are also set: indexation_base_year

created_atstring(date-time)read-only
Response
application/json
{
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "custom_id": "string",
  "value": 0.1,
  "custom_dimension_value": "string",
  "end_date": "2019-08-24",
  "indexation_firm_value": 0.1,
  "indexation_setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "start_date": "2019-08-24",
  "indexation_base_year": 1900,
  "vacancy_notation": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "source_row_content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "article": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "source_row_object_id": "d44585c8-7939-493c-aafc-e82e4822bf7c",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "indexation_value_quota": 0.1,
  "created_at": "2019-08-24T14:15:22Z",
  "title": "string",
  "vat": 0
}

Delete 'Apartmentvacancylossnotation'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
curl -i -X DELETE \
  'https://dev.api.pigello.io/objects/spaces/vacancies/apartmentvacancylossnotation/{pk}/' \
  -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'

Responses

Successful deletion

Response
No content

Outdoorsectionvacancylossnotation

Operations

Parkingspotterms

Operations

Brfapartment

Operations

Apartment

Operations

Apartmentvacancynotation

Operations

Outdoorsection

Operations

Componentmodel

Operations

Componenttype

Operations

Parkinglot

Operations

Realestate

Operations

Building

Operations

Region

Operations

Community

Operations

Outdoorarea

Operations

Structurerenovationnotation

Operations

Spacerenovationnotation

Operations

Taxationsubrecord

Operations

Taxationrecord

Operations

Spacebaserentvatstatusnotation

Operations

Realestatevatkeyquotanotation

Operations

Roomcategory

Operations
© Pigello. All rights reserved.