API docs by Redocly

export API (develop:c14720)

Download OpenAPI specification:

License: None

Automatically generated swagger spec for the export stack.

HistoryService

HistoryService_GetLatest

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": {
    }
}

HistoryService_Statistics

Responses

Response samples

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

SchedulerService

TendService

TendService_GetRedXAreaModel

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

TendService_GetRentalIndexCSV

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

ExportService

ExportService_Create

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": {
    }
}

ExportService_Delete

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

ExportService_Find

path Parameters
id
required
string

Responses

Response samples

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

ExportService_List

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": [
    ]
}

ExportService_ListObjectPlatforms

path Parameters
objectId
required
string

Responses

Response samples

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

ExportService_ListPresets

Responses

Response samples

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

ExportService_RemoveAllTargets

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": {
    }
}

ExportService_SendExportUploadCommand

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

ExportService_SetAgencyId

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

ExportService_SetPreset

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

ExportService_Start

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

ExportService_Update

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": {
    }
}

ExportService_UpdatePlatforms

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": [
    ]
}

IdxService

CredentialService

CredentialService_Create

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

CredentialService_FindDecrypted

path Parameters
id
required
string

Responses

Response samples

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

CredentialService_Update

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