Search
K
[dev] 🇩🇪 Listings Management Germany

Request a presigned URL for media upload

Request a presigned URL to upload a media file to the system.
The presigned URL is valid for 60 seconds. During this time:

  • The upload must be completed.
  • The media must be attached to a listing.

If these conditions are not met, the media will be automatically deleted. Supported media types include images, videos, and other multimedia content. Note: The maximum file size allowed is 40MB.

post

Body

application/json; charset=utf-8

mediaPresignedUrlRequest

* Additional properties are NOT allowed.
externalMediaIdstringrequired

The ID of the media into the software

>= 1 characters

Example:media_01

fileNamestringrequired

The name of the media file.

Match pattern:.*\S.*

>= 1 characters

Example:my_media.jpg

Response

application/json; charset=utf-8

Created

mediaPresignedUrlResponse

externalMediaIdstringrequired

The external media identifier provided by the client

presignedURLstring(uri)required

Presigned URL to upload media

Example:https://s3.eu-central-1.amazonaws.com/aviv-media/1234567890.jpg

post/medias

Body

{ "externalMediaId": "media_01", "fileName": "my_media.jpg" }
 
application/json; charset=utf-8

Health

Health of the service.

Healthcheck endpoint

Get the operational status of the API

get

Response

application/json; charset=utf-8

Pass

One Of
statusstringrequired

Allowed values:PASS

Example:PASS

componentsOne Of
arrayrequired

>= 1 items

pingComponentobject
Show Child Parameters
get/health
 
application/json; charset=utf-8

Retrieves all projects for a customer.

Retrieve all projects for a customer.

get

Response

application/json; charset=utf-8

Successful retrieval of projects.

externalProjectIdsarray[string]

The external project IDs returned in this page of results.

get/projects
 
application/json; charset=utf-8

Create a new project

Create a new project. A project is a collection of listings that are related to each other. For instance, a project can be a building that contains several apartments for sale. This endpoint allows you to create a new project

post

Body

application/json; charset=utf-8

projectRequest

Request wrapper for Data

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
mediaarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
metadataobjectrequired

metadata associated with the project in Immowelt system.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json; charset=utf-8

Created

projectResponse

Response wrapper for Data

* Additional properties are NOT allowed.
dataobjectrequired
* Additional properties are NOT allowed.
Show Child Parameters
metadataobject

metadata associated with the project in Immowelt system.

* Additional properties are NOT allowed.
Show Child Parameters
contactobject
* Additional properties are NOT allowed.
Show Child Parameters
mediaarray[object]

Array of media items attached to the listing.

Show Child Parameters
post/projects

Body

{ "data": {}, "metadata": { "source": { "offererMarketingKey": "HH-AH61a-WE15a-1", "offererEstateId": "c1b1160a-2502-4dff-8037-3888c9845981" } } }
 
application/json; charset=utf-8