Skip to content
/
Bulk write 'Apartmentrequ...

Markets (2.0.0)

The 'Markets' 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

Marketconfiguration

Operations

Apartmentrequirementprofile

Operations

List 'Apartmentrequirementprofile'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Query
_jsonlboolean
_order_byArray of strings
Example: _order_by=field_a,-field_b
_pageinteger(int32)>= 1

Additional Validation Information:

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

_page_sizeinteger(int32)

Additional Validation Information:

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

_searchstring
_slimboolean
_statisticsboolean
global_realestatesArray of objects
global_segmentsArray of objects
allow_petsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

allow_smokingany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

audienceany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

created_atany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

custom_idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

guarantor_pre_rent_net_income_factorany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

idany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

is_corporate_allowedany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

is_debt_restructuring_allowedany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

is_guarantor_allowedany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

is_historical_bankruptcy_allowedany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

is_outstanding_debt_balance_allowedany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

is_private_allowedany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

max_ageany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

max_amount_of_active_listing_applicationsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

max_amount_of_current_contractsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

max_amount_of_moves_in_last_three_yearsany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

max_number_of_payment_remarksany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

max_residents_over_room_countany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

min_ageany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: gt, Supports negation (via !): True

Operator: gte, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: lt, Supports negation (via !): True

Operator: lte, Supports negation (via !): True

nameany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

organizationany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

post_rent_normal_income_factorany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

pre_rent_net_income_factorany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

type_of_income_factorany

Filter can be negated by adding a ! to the end of the parameter name.

Additional operators:

Operator: contains, Supports negation (via !): True

Operator: endswith, Supports negation (via !): True

Operator: icontains, Supports negation (via !): True

Operator: iendswith, Supports negation (via !): True

Operator: iexact, Supports negation (via !): True

Operator: in, Supports negation (via !): True

Operator: isnull, Supports negation (via !): True

Operator: istartswith, Supports negation (via !): True

Operator: startswith, Supports negation (via !): True

curl -i -X GET \
  'https://dev.api.pigello.io/markets/requirementprofiles/apartmentrequirementprofile/list/?_jsonl=true&_order_by=field_a%2C-field_b&_page=1&_page_size=0&_search=string&_slim=true&_statistics=true' \
  -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 query

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

is_corporate_allowedbooleanrequired
namestring<= 255 charactersrequired
is_private_allowedbooleanrequired
is_historical_bankruptcy_allowedbooleanrequired
is_guarantor_allowedbooleanrequired
is_outstanding_debt_balance_allowedbooleanrequired
is_debt_restructuring_allowedbooleanrequired
post_rent_normal_income_factorstring or null(decimal)

Additional Validation Information:

Minimum value: 0

max_residents_over_room_countinteger or null(int32)<= 2147483647
allow_smokingboolean
audiencestring<= 255 characters
Enum"SENIOR""EVERYONE""YOUTH""BENEFIT_APARTMENT""STUDENT"
allowed_income_sourcesArray of objects
organizationobject or null(Organization)
guarantor_pre_rent_net_income_factorstring or null(decimal)

Additional Validation Information:

Minimum value: 0

max_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

created_atstring(date-time)read-only
max_amount_of_moves_in_last_three_yearsinteger or null(int32)<= 2147483647
custom_idstring or null<= 128 characters
max_amount_of_current_contractsinteger or null(int32)<= 2147483647
type_of_income_factorstring or null<= 255 characters
Enum"POST_RENT_NORMAL_INCOME""PRE_RENT_NET_INCOME"
max_amount_of_active_listing_applicationsinteger or null(int32)<= 2147483647
max_number_of_payment_remarksinteger or null(int32)<= 2147483647
allow_petsboolean
min_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

pre_rent_net_income_factorstring or null(decimal)

Additional Validation Information:

Minimum value: 0

]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_corporate_allowed": true,
    "post_rent_normal_income_factor": "string",
    "max_residents_over_room_count": 2147483647,
    "name": "string",
    "allow_smoking": true,
    "audience": "SENIOR",
    "allowed_income_sources": [ … ],
    "organization": { … },
    "is_private_allowed": true,
    "guarantor_pre_rent_net_income_factor": "string",
    "max_age": 12,
    "is_historical_bankruptcy_allowed": true,
    "created_at": "2019-08-24T14:15:22Z",
    "max_amount_of_moves_in_last_three_years": 2147483647,
    "custom_id": "string",
    "max_amount_of_current_contracts": 2147483647,
    "type_of_income_factor": "POST_RENT_NORMAL_INCOME",
    "is_guarantor_allowed": true,
    "max_amount_of_active_listing_applications": 2147483647,
    "max_number_of_payment_remarks": 2147483647,
    "allow_pets": true,
    "is_outstanding_debt_balance_allowed": true,
    "is_debt_restructuring_allowed": true,
    "min_age": 12,
    "pre_rent_net_income_factor": "string"
  }
]

Bulk write 'Apartmentrequirementprofile'

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/jsonArray [
is_corporate_allowedbooleanrequired
namestring<= 255 charactersrequired
is_private_allowedbooleanrequired
is_historical_bankruptcy_allowedbooleanrequired
is_guarantor_allowedbooleanrequired
is_outstanding_debt_balance_allowedbooleanrequired
is_debt_restructuring_allowedbooleanrequired
post_rent_normal_income_factorstring or null(decimal)

Additional Validation Information:

Minimum value: 0

max_residents_over_room_countinteger or null(int32)<= 2147483647
allow_smokingboolean
audiencestring<= 255 characters
Enum"SENIOR""EVERYONE""YOUTH""BENEFIT_APARTMENT""STUDENT"
allowed_income_sourcesArray of objects
organizationobject or null(Organization)
guarantor_pre_rent_net_income_factorstring or null(decimal)

Additional Validation Information:

Minimum value: 0

max_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

max_amount_of_moves_in_last_three_yearsinteger or null(int32)<= 2147483647
custom_idstring or null<= 128 characters
max_amount_of_current_contractsinteger or null(int32)<= 2147483647
type_of_income_factorstring or null<= 255 characters
Enum"POST_RENT_NORMAL_INCOME""PRE_RENT_NET_INCOME"
max_amount_of_active_listing_applicationsinteger or null(int32)<= 2147483647
max_number_of_payment_remarksinteger or null(int32)<= 2147483647
allow_petsboolean
min_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

pre_rent_net_income_factorstring or null(decimal)

Additional Validation Information:

Minimum value: 0

]
curl -i -X POST \
  https://dev.api.pigello.io/markets/requirementprofiles/apartmentrequirementprofile/list/ \
  -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 '[
    {
      "is_corporate_allowed": true,
      "post_rent_normal_income_factor": "string",
      "max_residents_over_room_count": 2147483647,
      "name": "string",
      "allow_smoking": true,
      "audience": "SENIOR",
      "allowed_income_sources": [
        null
      ],
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "is_private_allowed": true,
      "guarantor_pre_rent_net_income_factor": "string",
      "max_age": 12,
      "is_historical_bankruptcy_allowed": true,
      "max_amount_of_moves_in_last_three_years": 2147483647,
      "custom_id": "string",
      "max_amount_of_current_contracts": 2147483647,
      "type_of_income_factor": "POST_RENT_NORMAL_INCOME",
      "is_guarantor_allowed": true,
      "max_amount_of_active_listing_applications": 2147483647,
      "max_number_of_payment_remarks": 2147483647,
      "allow_pets": true,
      "is_outstanding_debt_balance_allowed": true,
      "is_debt_restructuring_allowed": true,
      "min_age": 12,
      "pre_rent_net_income_factor": "string"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

is_corporate_allowedbooleanrequired
namestring<= 255 charactersrequired
is_private_allowedbooleanrequired
is_historical_bankruptcy_allowedbooleanrequired
is_guarantor_allowedbooleanrequired
is_outstanding_debt_balance_allowedbooleanrequired
is_debt_restructuring_allowedbooleanrequired
post_rent_normal_income_factorstring or null(decimal)

Additional Validation Information:

Minimum value: 0

max_residents_over_room_countinteger or null(int32)<= 2147483647
allow_smokingboolean
audiencestring<= 255 characters
Enum"SENIOR""EVERYONE""YOUTH""BENEFIT_APARTMENT""STUDENT"
allowed_income_sourcesArray of objects
organizationobject or null(Organization)
guarantor_pre_rent_net_income_factorstring or null(decimal)

Additional Validation Information:

Minimum value: 0

max_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

created_atstring(date-time)read-only
max_amount_of_moves_in_last_three_yearsinteger or null(int32)<= 2147483647
custom_idstring or null<= 128 characters
max_amount_of_current_contractsinteger or null(int32)<= 2147483647
type_of_income_factorstring or null<= 255 characters
Enum"POST_RENT_NORMAL_INCOME""PRE_RENT_NET_INCOME"
max_amount_of_active_listing_applicationsinteger or null(int32)<= 2147483647
max_number_of_payment_remarksinteger or null(int32)<= 2147483647
allow_petsboolean
min_ageinteger or null(int32)[ 12 .. 2147483647 ]

Additional Validation Information:

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

pre_rent_net_income_factorstring or null(decimal)

Additional Validation Information:

Minimum value: 0

]
Response
application/json
[
  {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "is_corporate_allowed": true,
    "post_rent_normal_income_factor": "string",
    "max_residents_over_room_count": 2147483647,
    "name": "string",
    "allow_smoking": true,
    "audience": "SENIOR",
    "allowed_income_sources": [ … ],
    "organization": { … },
    "is_private_allowed": true,
    "guarantor_pre_rent_net_income_factor": "string",
    "max_age": 12,
    "is_historical_bankruptcy_allowed": true,
    "created_at": "2019-08-24T14:15:22Z",
    "max_amount_of_moves_in_last_three_years": 2147483647,
    "custom_id": "string",
    "max_amount_of_current_contracts": 2147483647,
    "type_of_income_factor": "POST_RENT_NORMAL_INCOME",
    "is_guarantor_allowed": true,
    "max_amount_of_active_listing_applications": 2147483647,
    "max_number_of_payment_remarks": 2147483647,
    "allow_pets": true,
    "is_outstanding_debt_balance_allowed": true,
    "is_debt_restructuring_allowed": true,
    "min_age": 12,
    "pre_rent_net_income_factor": "string"
  }
]

Apartmentlisting

Operations

Marketapartmentmedia

Operations

Marketmedia

Operations

Marketapartment

Operations
© Pigello. All rights reserved.