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

Marketapartmentmedia

Operations

Marketmedia

Operations

Create 'Marketmedia'

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
auto_include_for_related_objectsbooleanrequired
object_idstring(uuid)required
media_fileobjectrequired
media_file.​namestring

wanted filename of the file

media_file.​md5_hashstring

base64 encoded md5hash of the file

media_file.​getstring(url)
media_file.​postobject
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
custom_idstring or null<= 128 characters
titlestring or null<= 1024 characters
organizationobject or null(Organization)
media_typestring or null<= 255 characters
Enum"DRONE_FOOTAGE""FLOOR_PLAN"
curl -i -X POST \
  https://dev.api.pigello.io/markets/media/marketmedia/ \
  -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 '{
    "auto_include_for_related_objects": true,
    "custom_id": "string",
    "title": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "media_type": "DRONE_FOOTAGE",
    "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
    "media_file": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    },
    "content_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  }'

Responses

Successful creation

Bodyapplication/json
auto_include_for_related_objectsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

object_idstring(uuid)required
media_fileobjectrequired
media_file.​namestring

wanted filename of the file

media_file.​md5_hashstring

base64 encoded md5hash of the file

media_file.​getstring(url)
media_file.​postobject
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
custom_idstring or null<= 128 characters
titlestring or null<= 1024 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
media_typestring or null<= 255 characters
Enum"DRONE_FOOTAGE""FLOOR_PLAN"
Response
application/json
{
  "auto_include_for_related_objects": true,
  "custom_id": "string",
  "title": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "media_type": "DRONE_FOOTAGE",
  "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  "media_file": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Get 'Marketmedia'

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/media/marketmedia/{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
auto_include_for_related_objectsbooleanrequired
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

object_idstring(uuid)required
media_fileobjectrequired
media_file.​namestring

wanted filename of the file

media_file.​md5_hashstring

base64 encoded md5hash of the file

media_file.​getstring(url)
media_file.​postobject
content_typeobject(Contenttype)required
content_type.​idstring(uuid)
custom_idstring or null<= 128 characters
titlestring or null<= 1024 characters
created_atstring(date-time)read-only
organizationobject or null(Organization)
media_typestring or null<= 255 characters
Enum"DRONE_FOOTAGE""FLOOR_PLAN"
Response
application/json
{
  "auto_include_for_related_objects": true,
  "custom_id": "string",
  "title": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "media_type": "DRONE_FOOTAGE",
  "object_id": "463a83d0-a816-4902-abba-2486e0c0a0bb",
  "media_file": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
}

Delete 'Marketmedia'

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/media/marketmedia/{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

Marketapartment

Operations
© Pigello. All rights reserved.