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

Apartmentlisting

Operations

Create 'Apartmentlisting'

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
short_term_contractbooleanrequired
is_earlier_move_in_date_possiblebooleanrequired
move_in_datestring(date)required

Additional Validation Information:

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

requirement_profileobject(Apartmentrequirementprofile)required
requirement_profile.​idstring(uuid)
market_configurationobject(Marketconfiguration)required
market_configuration.​idstring(uuid)
market_apartmentobject(Marketapartment)required
market_apartment.​idstring(uuid)
monthly_rentinteger(int32)<= 2147483647required
move_out_datestring or null(date)

Additional Validation Information:

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

custom_idstring or null<= 128 characters
organizationobject or null(Organization)
unpublish_atstring or null(date)

Additional Validation Information:

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

publish_atstring or null(date)

Additional Validation Information:

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

curl -i -X POST \
  https://dev.api.pigello.io/markets/listings/apartmentlisting/ \
  -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 '{
    "short_term_contract": true,
    "is_earlier_move_in_date_possible": true,
    "move_in_date": "2019-08-24",
    "requirement_profile": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "market_configuration": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "move_out_date": "2019-08-24",
    "custom_id": "string",
    "market_apartment": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "unpublish_at": "2019-08-24",
    "monthly_rent": 2147483647,
    "publish_at": "2019-08-24"
  }'

Responses

Successful creation

Bodyapplication/json
short_term_contractbooleanrequired
is_earlier_move_in_date_possiblebooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

move_in_datestring(date)required

Additional Validation Information:

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

requirement_profileobject(Apartmentrequirementprofile)required
requirement_profile.​idstring(uuid)
market_configurationobject(Marketconfiguration)required
market_configuration.​idstring(uuid)
market_apartmentobject(Marketapartment)required
market_apartment.​idstring(uuid)
monthly_rentinteger(int32)<= 2147483647required
move_out_datestring or null(date)

Additional Validation Information:

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

custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
unpublish_atstring or null(date)

Additional Validation Information:

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

publish_atstring or null(date)

Additional Validation Information:

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

Response
application/json
{
  "short_term_contract": true,
  "is_earlier_move_in_date_possible": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "move_in_date": "2019-08-24",
  "requirement_profile": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "market_configuration": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "move_out_date": "2019-08-24",
  "custom_id": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "market_apartment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "unpublish_at": "2019-08-24",
  "monthly_rent": 2147483647,
  "publish_at": "2019-08-24"
}

List 'Apartmentlisting'

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

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_earlier_move_in_date_possibleany

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

market_apartmentany

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

market_configurationany

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

monthly_rentany

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

move_in_dateany

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

move_out_dateany

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

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

publish_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

requirement_profileany

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

short_term_contractany

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

unpublish_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

curl -i -X GET \
  'https://dev.api.pigello.io/markets/listings/apartmentlisting/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 [
short_term_contractbooleanrequired
is_earlier_move_in_date_possiblebooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

move_in_datestring(date)required

Additional Validation Information:

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

requirement_profileobject(Apartmentrequirementprofile)required
requirement_profile.​idstring(uuid)
market_configurationobject(Marketconfiguration)required
market_configuration.​idstring(uuid)
market_apartmentobject(Marketapartment)required
market_apartment.​idstring(uuid)
monthly_rentinteger(int32)<= 2147483647required
move_out_datestring or null(date)

Additional Validation Information:

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

custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
unpublish_atstring or null(date)

Additional Validation Information:

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

publish_atstring or null(date)

Additional Validation Information:

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

]
Response
application/json
[
  {
    "short_term_contract": true,
    "is_earlier_move_in_date_possible": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "move_in_date": "2019-08-24",
    "requirement_profile": { … },
    "market_configuration": { … },
    "move_out_date": "2019-08-24",
    "custom_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "market_apartment": { … },
    "organization": { … },
    "unpublish_at": "2019-08-24",
    "monthly_rent": 2147483647,
    "publish_at": "2019-08-24"
  }
]

Bulk write 'Apartmentlisting'

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 [
short_term_contractbooleanrequired
is_earlier_move_in_date_possiblebooleanrequired
move_in_datestring(date)required

Additional Validation Information:

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

requirement_profileobject(Apartmentrequirementprofile)required
requirement_profile.​idstring(uuid)
market_configurationobject(Marketconfiguration)required
market_configuration.​idstring(uuid)
market_apartmentobject(Marketapartment)required
market_apartment.​idstring(uuid)
monthly_rentinteger(int32)<= 2147483647required
move_out_datestring or null(date)

Additional Validation Information:

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

custom_idstring or null<= 128 characters
organizationobject or null(Organization)
unpublish_atstring or null(date)

Additional Validation Information:

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

publish_atstring or null(date)

Additional Validation Information:

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

]
curl -i -X POST \
  https://dev.api.pigello.io/markets/listings/apartmentlisting/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 '[
    {
      "short_term_contract": true,
      "is_earlier_move_in_date_possible": true,
      "move_in_date": "2019-08-24",
      "requirement_profile": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "market_configuration": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "move_out_date": "2019-08-24",
      "custom_id": "string",
      "market_apartment": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "organization": {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      },
      "unpublish_at": "2019-08-24",
      "monthly_rent": 2147483647,
      "publish_at": "2019-08-24"
    }
  ]'

Responses

Successful bulk create/update

Bodyapplication/jsonArray [
short_term_contractbooleanrequired
is_earlier_move_in_date_possiblebooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

move_in_datestring(date)required

Additional Validation Information:

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

requirement_profileobject(Apartmentrequirementprofile)required
requirement_profile.​idstring(uuid)
market_configurationobject(Marketconfiguration)required
market_configuration.​idstring(uuid)
market_apartmentobject(Marketapartment)required
market_apartment.​idstring(uuid)
monthly_rentinteger(int32)<= 2147483647required
move_out_datestring or null(date)

Additional Validation Information:

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

custom_idstring or null<= 128 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
unpublish_atstring or null(date)

Additional Validation Information:

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

publish_atstring or null(date)

Additional Validation Information:

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

]
Response
application/json
[
  {
    "short_term_contract": true,
    "is_earlier_move_in_date_possible": true,
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "move_in_date": "2019-08-24",
    "requirement_profile": { … },
    "market_configuration": { … },
    "move_out_date": "2019-08-24",
    "custom_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "market_apartment": { … },
    "organization": { … },
    "unpublish_at": "2019-08-24",
    "monthly_rent": 2147483647,
    "publish_at": "2019-08-24"
  }
]

Marketapartmentmedia

Operations

Marketmedia

Operations

Marketapartment

Operations
© Pigello. All rights reserved.