Skip to content

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
articleobject(Article)required
titlestring, <= 255 charactersrequired
vatinteger, (int32), [ -2147483648 .. 2147483647 ]required

Additional Validation Information:

Enum Descriptions:

  • 0 - Vat 0

  • 6 - Vat 6

  • 12 - Vat 12

  • 25 - Vat 25

Enum:061225
indexation_settingobject or null(Indexationsetting)

Additional Validation Information:

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

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

source_row_content_typeobject or null(Contenttype)

Additional Validation Information:

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

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

Additional Validation Information:

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

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_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

custom_dimension_valuestring or null, <= 255 characters
source_row_object_idstring or null, (uuid)

Additional Validation Information:

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

organizationobject or null(Organization)
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

custom_idstring or null, <= 128 characters
POST
/objects/spaces/vacancies/apartmentvacancylossnotation/
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 '{
    "value": 0.1,
    "indexation_setting": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "indexation_firm_value": 0.1,
    "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"
    },
    "indexation_base_year": 1900,
    "start_date": "2019-08-24",
    "indexation_value_quota": 0.1,
    "custom_dimension_value": "string",
    "source_row_object_id": "d44585c8-7939-493c-aafc-e82e4822bf7c",
    "title": "string",
    "vat": 0,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "end_date": "2019-08-24",
    "custom_id": "string"
  }'

Responses

Successful creation

Bodyapplication/json
valuenumber, (float)required
vacancy_notationobject(Apartmentvacancynotation)required
articleobject(Article)required
idstring, (uuid)read-onlyrequired

Additional Validation Information:

Must be unique

titlestring, <= 255 charactersrequired
vatinteger, (int32), [ -2147483648 .. 2147483647 ]required

Additional Validation Information:

Enum Descriptions:

  • 0 - Vat 0

  • 6 - Vat 6

  • 12 - Vat 12

  • 25 - Vat 25

Enum:061225
indexation_settingobject or null(Indexationsetting)

Additional Validation Information:

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

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

source_row_content_typeobject or null(Contenttype)

Additional Validation Information:

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

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

Additional Validation Information:

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

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_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
custom_dimension_valuestring or null, <= 255 characters
source_row_object_idstring or null, (uuid)

Additional Validation Information:

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

organizationobject or null(Organization)
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

custom_idstring or null, <= 128 characters
Response
{
  "value": 0.1,
  "indexation_setting": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "indexation_firm_value": 0.1,
  "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"
  },
  "indexation_base_year": 1900,
  "start_date": "2019-08-24",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "indexation_value_quota": 0.1,
  "created_at": "2019-08-24T14:15:22Z",
  "custom_dimension_value": "string",
  "source_row_object_id": "d44585c8-7939-493c-aafc-e82e4822bf7c",
  "title": "string",
  "vat": 0,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "end_date": "2019-08-24",
  "custom_id": "string"
}
© Pigello. All rights reserved.