API docs by Redocly

export API (develop:84871a)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the export stack.

CredentialService

Create export credentials

Creates FTP credentials (hostname, port, username, password) for platform exports. Username and password are stored AES encrypted. Returns the new credentials ID.

Request Body schema: application/json
required
hostname
required
string (FTP hostname)
password
required
string (FTP password (stored AES encrypted))
port
required
string <int64> (FTP port)
username
required
string (FTP username (stored AES encrypted))

Responses

Request samples

Content type
application/json
{
  • "hostname": "string",
  • "password": "string",
  • "port": "string",
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "credentialsId": "string"
}

Find decrypted credentials by ID

Returns the FTP credentials for the given ID with username and password decrypted.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "credentials": {
    }
}

Update export credentials

Updates FTP credentials by ID (hostname, port, username). Password is updated only when updatePassword is true.

Request Body schema: application/json
required
hostname
required
string (FTP hostname)
id
required
string (xid)
password
required
string (FTP password (stored AES encrypted))
port
required
string <int64> (FTP port)
updatePassword
required
boolean (If true password is updated, otherwise not)
username
required
string (FTP username (stored AES encrypted))

Responses

Request samples

Content type
application/json
{
  • "hostname": "string",
  • "id": "string",
  • "password": "string",
  • "port": "string",
  • "updatePassword": true,
  • "username": "string"
}

Response samples

Content type
application/json
{
  • "credentials": {
    }
}

DocumentBundleService

ExportService

Create an export

Creates a new export for the given account with credentials, platform, export type, and optional object targets. Custom name, image URL, and agency ID may be supplied.

Request Body schema: application/json
required
accountId
required
string <int64>
agencyId
required
string
credentialsId
required
string
customImageUrl
required
string
customName
required
string
objects
required
Array of strings
platform
required
string (v2Platform)
Default: "UNDEFINED_PLATFORM"
Enum: "UNDEFINED_PLATFORM" "PROPBASE_PLATFORM" "HOMEGATE_PLATFORM" "COMPARIS_PLATFORM" "NEWHOME_PLATFORM" "IMMOSCOUT_PLATFORM" "IMMOWELT_PLATFORM" "CASAONE_PLATFORM" "FLATFOX_PLATFORM" "URBANHOME_PLATFORM" "PROPERSTAR_PLATFORM" "MAISON_PLATFORM" "REALADVISOR_PLATFORM" "ROBINREAL_PLATFORM"
type
required
string (v2ExportType)
Default: "UNDEFINED_EXPORT_TYPE"
Enum: "UNDEFINED_EXPORT_TYPE" "IDX_EXPORT_TYPE" "SWISSRETS_EXPORT_TYPE"

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "agencyId": "string",
  • "credentialsId": "string",
  • "customImageUrl": "string",
  • "customName": "string",
  • "objects": [
    ],
  • "platform": "UNDEFINED_PLATFORM",
  • "type": "UNDEFINED_EXPORT_TYPE"
}

Response samples

Content type
application/json
{
  • "export": {
    }
}

Delete an export

Deletes the export configuration identified by the given ID.

path Parameters
id
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{ }

Find an export by ID

Returns the export configuration identified by the given ID.

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "export": {
    }
}

List exports for an account

Returns all export configurations belonging to the given account ID.

path Parameters
accountId
required
string <int64>

The coozzy account ID

Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "exports": [
    ]
}

List platforms for an object

Returns the platforms associated with the given object ID.

path Parameters
objectId
required
string

Responses

Response samples

Content type
application/json
{
  • "platforms": [
    ]
}

List export presets

Returns the available export presets (e.g. all fields disabled, full agency without visit, full). The request has no parameters.

Responses

Response samples

Content type
application/json
{
  • "presets": [
    ]
}

Remove all targets from an export

Removes all targets from the given export and returns the updated export configuration.

path Parameters
exportId
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "export": {
    }
}

Send an export upload command

Sends a command to upload export data from the given source path to the target platform using the provided FTP credentials and export/run IDs.

Request Body schema: application/json
required
required
object (credentialsCredentials)
exportId
required
string (the export which triggered this command)
exportRunId
required
string (the export run this upload belongs to)
platform
required
string (v2Platform)
Default: "UNDEFINED_PLATFORM"
Enum: "UNDEFINED_PLATFORM" "PROPBASE_PLATFORM" "HOMEGATE_PLATFORM" "COMPARIS_PLATFORM" "NEWHOME_PLATFORM" "IMMOSCOUT_PLATFORM" "IMMOWELT_PLATFORM" "CASAONE_PLATFORM" "FLATFOX_PLATFORM" "URBANHOME_PLATFORM" "PROPERSTAR_PLATFORM" "MAISON_PLATFORM" "REALADVISOR_PLATFORM" "ROBINREAL_PLATFORM"
sourcePath
required
string (data source path: upload everything inside this folder)

Responses

Request samples

Content type
application/json
{
  • "credentials": {
    },
  • "exportId": "string",
  • "exportRunId": "string",
  • "platform": "UNDEFINED_PLATFORM",
  • "sourcePath": "string"
}

Response samples

Content type
application/json
{ }

Set agency ID on an export

Sets the agency ID used when encoding the export for the given export ID.

Request Body schema: application/json
required
AgencyId
required
string
ExportId
required
string

Responses

Request samples

Content type
application/json
{
  • "AgencyId": "string",
  • "ExportId": "string"
}

Response samples

Content type
application/json
{ }

Set preset on an export

Sets the field preset for all targets of the given export ID.

Request Body schema: application/json
required
exportId
required
string
preset
required
string (- ALL_FIELDS_DISABLED_PRESET: includes NO values - FULL_AGENCY_NO_VISIT_PRESET: includes ALL agency values but NO visit values - FULL_PRESET: includes ALL availbale idx fields (if set))
Default: "UNDEFINED_PRESET"
Enum: "UNDEFINED_PRESET" "ALL_FIELDS_DISABLED_PRESET" "FULL_AGENCY_NO_VISIT_PRESET" "FULL_PRESET"

Responses

Request samples

Content type
application/json
{
  • "exportId": "string",
  • "preset": "UNDEFINED_PRESET"
}

Response samples

Content type
application/json
{ }

Start an export run

Starts an export run for the given export configuration ID and returns the export run ID.

path Parameters
id
required
string
Request Body schema: application/json
required
object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "exportRunId": "string"
}

Update an export

Updates an existing export by ID, including account, credentials, platform, type, custom name, image URL, and target IDs.

Request Body schema: application/json
required
accountId
required
string <int64>
credentialsId
required
string
customImageUrl
required
string
customName
required
string
id
required
string
platform
required
string (v2Platform)
Default: "UNDEFINED_PLATFORM"
Enum: "UNDEFINED_PLATFORM" "PROPBASE_PLATFORM" "HOMEGATE_PLATFORM" "COMPARIS_PLATFORM" "NEWHOME_PLATFORM" "IMMOSCOUT_PLATFORM" "IMMOWELT_PLATFORM" "CASAONE_PLATFORM" "FLATFOX_PLATFORM" "URBANHOME_PLATFORM" "PROPERSTAR_PLATFORM" "MAISON_PLATFORM" "REALADVISOR_PLATFORM" "ROBINREAL_PLATFORM"
targets
required
Array of strings
type
required
string (v2ExportType)
Default: "UNDEFINED_EXPORT_TYPE"
Enum: "UNDEFINED_EXPORT_TYPE" "IDX_EXPORT_TYPE" "SWISSRETS_EXPORT_TYPE"

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "credentialsId": "string",
  • "customImageUrl": "string",
  • "customName": "string",
  • "id": "string",
  • "platform": "UNDEFINED_PLATFORM",
  • "targets": [
    ],
  • "type": "UNDEFINED_EXPORT_TYPE"
}

Response samples

Content type
application/json
{
  • "export": {
    }
}

Update platforms for an object

Updates the platforms for the given account and object ID. Returns the affected export configurations.

Request Body schema: application/json
required
accountId
required
string <int64>
objectId
required
string
platforms
required
Array of strings (v2Platform)
Items Enum: "UNDEFINED_PLATFORM" "PROPBASE_PLATFORM" "HOMEGATE_PLATFORM" "COMPARIS_PLATFORM" "NEWHOME_PLATFORM" "IMMOSCOUT_PLATFORM" "IMMOWELT_PLATFORM" "CASAONE_PLATFORM" "FLATFOX_PLATFORM" "URBANHOME_PLATFORM" "PROPERSTAR_PLATFORM" "MAISON_PLATFORM" "REALADVISOR_PLATFORM" "ROBINREAL_PLATFORM"

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "objectId": "string",
  • "platforms": [
    ]
}

Response samples

Content type
application/json
{
  • "exports": [
    ]
}

HistoryService

Get latest export runs by platform

Returns the latest export run per platform (e.g. Homegate, ImmoScout, Newhome) for the given account ID.

path Parameters
accountId
required
string <int64>

Responses

Response samples

Content type
application/json
{
  • "casaone": {
    },
  • "comparis": {
    },
  • "flatfox": {
    },
  • "homegate": {
    },
  • "immoscout": {
    },
  • "immowelt": {
    },
  • "maison": {
    },
  • "newhome": {
    },
  • "properstar": {
    },
  • "realadvisor": {
    },
  • "robinreal": {
    },
  • "urbanhome": {
    }
}

Get export run statistics

Returns overall and today counts of export runs, broken down by status (started, failed, finished) and platform. The request has no parameters.

Responses

Response samples

Content type
application/json
{
  • "counts": {
    }
}

IdxService

SchedulerService

TendService

Get RedX area model

Returns RedX area model data (zip UBS PK and zip UBS Sima) for the given end date.

query Parameters
endDate.year
integer <int32>

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

endDate.month
integer <int32>

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

endDate.day
integer <int32>

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

Responses

Response samples

Content type
application/json
{
  • "zipUbsPk": "string",
  • "zipUbsSima": "string"
}

Get rental index CSV

Returns rental index CSV data (and UBS PK CSV) for the given end date.

query Parameters
endDate.year
integer <int32>

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

endDate.month
integer <int32>

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

endDate.day
integer <int32>

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

Responses

Response samples

Content type
application/json
{
  • "csv": "string",
  • "csvUbsPk": "string"
}