Skip to content

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

Create '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/json
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/ \
  -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 creation

Bodyapplication/json
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": [
    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,
  "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"
}

Delete '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
Path
pkstringwrite-onlyrequired
curl -i -X DELETE \
  'https://dev.api.pigello.io/markets/requirementprofiles/apartmentrequirementprofile/{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

Get '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
Path
pkstringwrite-onlyrequired
curl -i -X GET \
  'https://dev.api.pigello.io/markets/requirementprofiles/apartmentrequirementprofile/{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 selection

Bodyapplication/json
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": [
    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,
  "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.