Create or update a listing
Aufruf, Parameter, Antwort und Fehler von PUT /v1/listings/{externalListingId}.
Zuletzt aktualisiert:
Updates the listing with this external id, which is your reference or the id Athaus gave it. It merges like PATCH: a member the body does not name stays, null clears it. An unknown id is a 404 unless createIfMissing=true, which creates it under the id of the path. The body's metadata.source.offererMarketingKey, if present, must equal the id in the path (or the listing's own external id). No media leaves the files; a list orders them and removes the files that came through the API and are not named; media: [] removes all of those. Safe to repeat. Needs write access to listings.
Braucht den Scope propose.
Aufruf
PUT https://api.athaus.ai/v1/listings/{externalListingId}Parameter
Pfad
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
externalListingId | string | ja | Your reference of the listing: the value of metadata.source.offererMarketingKey. A listing without one has its own listingId here, and the listingId always works in the path. 1 to 128 letters, digits, dots, underscores or hyphens, not starting or ending with a dot. |
Abfrage
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
draft | string | nein | Accept an incomplete listing: only metadata.source is required, and the rest is checked when the listing is published. Ours, not OpenImmo. Vorgabe false. |
createIfMissing | string | nein | Create the listing when the id is unknown. Without it an unknown id is a 404. Vorgabe false. |
Kopf
| Name | Typ | Pflicht | Beschreibung |
|---|---|---|---|
Athaus-Version | string | nein | Optional and carries nothing a client needs: the version is the path. Accepted when it says v1 or 1. Any other value is a 400 api_version_unsupported. |
If-Match | string | nein | Only if the current ETag of the resource is listed (or *: only if the resource exists). Otherwise 412 and nothing is written. |
If-None-Match | string | nein | *: only if no resource with this reference exists yet (create, never change). Otherwise 412 and nothing is written. |
Rumpf
JSON mit Content-Type: application/json. Ein Feld, das die API nicht kennt, ist ein 400, und errors[].name nennt das Feld. Der Rumpf ist Pflicht.
| Feld | Typ | Beschreibung |
|---|---|---|
data | object | |
data.estateType | string | Eines von HOUSE, APARTMENT, PLOT, OFFICE, TRADING, GASTRONOMY_HOTEL, STORAGE_PRODUCTION, AGRICULTURE_FORESTRY, PARKING, SENIOR, PROJECT, MISCELLANEOUS. |
data.estateSubType | object | |
data.distributionType | string | Eines von BUY, RENT, COMPULSORY_AUCTION, BUY_AUCTION. |
data.location | object | |
data.location.postalcode | string | |
data.location.city | string | |
data.location.street | string | |
data.location.houseNumber | string | |
data.location.unit | string | |
data.location.staircase | string | |
data.location.floorNumber | integer | -5 bis 999. |
data.location.entrance | string | |
data.location.state | string | |
data.location.country | string | Eine von 249 Angaben der Liste im Standard. |
data.location.geometry | object | |
data.location.geometry.type | string | Immer Point. |
data.location.geometry.coordinates | number[] | |
data.location.showAddress | boolean | Vorgabe true. |
data.location.locationNote | map<string> | |
data.prices | object | |
data.prices.currency | string | Eine von 180 Angaben der Liste im Standard. Vorgabe EUR. |
data.prices.buy | object | |
data.prices.buy.price | any | |
data.prices.buy.isLeaseBuyCombi | boolean | |
data.prices.buy.leasehold | object | |
data.prices.buy.operatingCosts | any | |
data.prices.buy.rentalIncome | any | |
data.prices.buy.rentalIncomeExpect | any | |
data.prices.buy.isParkingPriceIncluded | boolean | |
data.prices.buy.parkingPrices | any[] | |
data.prices.buy.pricePerSqUnit | any | |
data.prices.buy.yieldFactor | number | 0 bis 9999999999999. |
data.prices.buy.countrySpecific | object | |
data.prices.rent | object | |
data.prices.rent.baseRent | any | |
data.prices.rent.baseRentPerYear | any | |
data.prices.rent.totalRent | any | |
data.prices.rent.lease | any | |
data.prices.rent.operatingCosts | any | |
data.prices.rent.heatingCosts | any | |
data.prices.rent.isHeatingIncludedInOC | boolean | |
data.prices.rent.isHeatingIncludedInTR | boolean | |
data.prices.rent.pricePerSqUnit | any | |
data.prices.rent.pricePerSqUnitPerYear | any | |
data.prices.rent.priceTimeUnit | string | Eines von DAY, WEEK, MONTH, YEAR. Vorgabe MONTH. |
data.prices.rent.isParkingPriceIncluded | boolean | |
data.prices.rent.parkingPrices | any[] | |
data.prices.rent.depositNote | map<string> | |
data.prices.rent.countrySpecific | object | |
data.prices.compulsoryAuction | object | |
data.prices.compulsoryAuction.auctionProceeds | any | |
data.prices.compulsoryAuction.biddingGuarantee | any | |
data.prices.compulsoryAuction.marketValue | any | |
data.prices.compulsoryAuction.minimumBid | any | |
data.prices.buyAuction | object | |
data.prices.buyAuction.minPrice | object | |
data.prices.buyAuction.startOfferPhase | string (date) | |
data.prices.buyAuction.endOfferPhase | string (date) | |
data.prices.brokerageFee | any | |
data.prices.showPrice | boolean | |
data.prices.priceNote | map<string> | |
data.prices.countrySpecific | object | |
data.prices.countrySpecific.fr | object | |
data.spaces | object | |
data.spaces.spaceMeasureUnit | string | Eines von SQUARE_METER, SQUARE_INCH, SQUARE_FOOT, SQUARE_YARD, HECTARE, ACRE. Vorgabe SQUARE_METER. |
data.spaces.buildingFront | number | 0 bis 99999999. |
data.spaces.kitchenSpace | number | 0 bis 99999999. |
data.spaces.overallSpace | number | 0 bis 99999999. |
data.spaces.usableFloorSpace | number | 0 bis 99999999. |
data.spaces.spaceMax | number | 0 bis 99999999. |
data.spaces.spaceMin | number | 0 bis 99999999. |
data.spaces.plotSpace | number | 0 bis 99999999. |
data.spaces.plotFront | number | 0 bis 99999999. |
data.spaces.additionalSpace | number | 0 bis 99999999. |
data.spaces.residential | object | |
data.spaces.residential.livingSpace | number | 0 bis 99999999. |
data.spaces.residential.livingRoomSpace | number | 0 bis 99999999. |
data.spaces.residential.atticSpace | number | 0 bis 99999999. |
data.spaces.residential.balconySpace | number | 0 bis 99999999. |
data.spaces.residential.cellarSpace | number | 0 bis 99999999. |
data.spaces.residential.gardenSpace | number | 0 bis 99999999. |
data.spaces.residential.terraceSpace | number | 0 bis 99999999. |
data.spaces.commercial | object | |
data.spaces.commercial.maxDivisible | number | 0 bis 99999999. |
data.spaces.commercial.minDivisible | number | 0 bis 99999999. |
data.spaces.commercial.commercialSpace | number | 0 bis 99999999. |
data.spaces.commercial.shopSpace | number | 0 bis 99999999. |
data.spaces.commercial.storageSpace | number | 0 bis 99999999. |
data.spaces.commercial.sellSpace | number | 0 bis 99999999. |
data.spaces.commercial.officeSpace | number | 0 bis 99999999. |
data.spaces.commercial.officePartSpace | number | 0 bis 99999999. |
data.spaces.commercial.managementSpace | number | 0 bis 99999999. |
data.spaces.commercial.restaurantSpace | number | 0 bis 99999999. |
data.spaces.commercial.countrySpecific | object | |
data.conditions | object | |
data.conditions.buildState | string | Eines von FIRST_TIME_USE, FIRST_TIME_USE_AFTER_REFURBISHMENT, MINT_CONDITION, MODERNISED, REFURBISHED, FULLY_RENOVATED, PARTLY_RENOVATED, NEED_OF_RENOVATION, WELL_KEPT, NEGOTIABLE, RIPE_FOR_DEMOLITION, PROJECTED, NO_INFORMATION, RESTRUCTURED, TO_RESTORE, TO_REFURBISH. |
data.conditions.ageState | string | Eines von OLD, NEW. |
data.conditions.lastModernisation | integer | |
data.conditions.constructionStyle | string | Eines von PREFABRICATED, SOLID, SOLID_PREFABRICATED, TIMBERHOUSE, WOOD_PREFABRICATED, UNSPECIFIED. |
data.conditions.yearOfConstruction | integer | 1000 bis 3000. |
data.energy | object | |
data.energy.energyType | object | |
data.energy.energyType.heatMethod | string | Eines von CENTRAL, INDIVIDUAL, STOREY. |
data.energy.energyType.heatForm | object | |
data.energy.energyType.energySource | object | |
data.energy.energyType.energyGeneration | object | |
data.energy.energyType.maxElectricalPower | integer | |
data.energy.countrySpecific | object | |
data.energy.countrySpecific.de | object | |
data.features | object | |
data.features.accessibleFromStreet | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.aircondition | string | Eines von YES, PART, NO, NOT_APPLICABLE. |
data.features.entranceHall | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering | object | |
data.features.floorCovering.tiles | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.stone | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.carpet | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.parquet | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.laminate | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.synthetic | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.screed | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.linoleum | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.marble | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.terracotta | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.granite | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.raisedFloor | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.quartz | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.concrete | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.antiDustConcrete | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.woodenPlank | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.antiStatic | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.floorCovering.vinyl | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.furnished | string | Eines von PART, FULL, NO, NOT_APPLICABLE. |
data.features.garden | object | |
data.features.garden.part | boolean | |
data.features.garden.private | boolean | |
data.features.garden.shared | boolean | |
data.features.gym | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.internet | object | |
data.features.internet.internetSpeedMbit | integer | 0 bis . |
data.features.internet.internetAvailability | object | |
data.features.internet.propertyInternetAccess | object | |
data.features.lighting | object | |
data.features.lighting.ceiling | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.lighting.led | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.lighting.window | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.mezzanine | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.propertyOrientation | string | Eines von NORTH, EAST, SOUTH, WEST, NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST. |
data.features.receptionist | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.security | object | |
data.features.security.buildingIntercom | string | Eines von YES, NO, NOT_APPLICABLE, VIDEO, DOOR_PHONE. |
data.features.security.cam | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.security.custodian | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.security.custodianRoom | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.security.digitalLock | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.security.emergencyCall | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.security.fireSprinkler | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.security.fireAlarm | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.security.intruderAlarm | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.security.reinforcedDoor | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.security.safe | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.wheelchairUse | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.wineCellar | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.residential | object | |
data.features.residential.assistedLiving | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.residential.chimney | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.residential.flatSharePossible | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.residential.hammam | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.residential.houseCleaningService | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.residential.jacuzzi | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.residential.loggia | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.residential.sauna | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.residential.swimmingPool | string | Eines von YES, NO, INSIDE, OUTSIDE, INSIDE_AND_OUTSIDE, NOT_APPLICABLE. |
data.features.residential.tennisField | string | Eines von YES, NO, NOT_APPLICABLE, PRIVATE, SHARED. |
data.features.residential.tv | string | Eines von SAT, CABLE, OTHER. |
data.features.residential.veranda | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.residential.laundryRoom | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.residential.countrySpecific | object | |
data.features.commercial | object | |
data.features.commercial.accessibleByTrucks | string | Eines von YES, NO, NOT_APPLICABLE, SEPARATED_TRUCK_ACCESS. |
data.features.commercial.auditorium | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.bar | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.buildingVentilation | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.cafeteria | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.coldStore | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.companyRestaurant | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.droppedCeiling | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.engineGenerator | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.exhaustHood | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.flexibleRoomLayout | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.heatedTerrace | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.liftingPlatform | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.numberOfStorageCells | integer | 0 bis 999999. |
data.features.commercial.overheadCrane | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.restaurantSeats | integer | 0 bis 999999. |
data.features.commercial.restaurantSeatsOutside | integer | 0 bis 999999. |
data.features.commercial.teaKitchen | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.truckManeuveringArea | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.verticalSlidingDoor | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.commercial.wallSiding | string | Eines von YES, NO, NOT_APPLICABLE, DOUBLE, DECORATIVE. |
data.features.commercial.countrySpecific | object | |
data.features.parking | object | |
data.features.parking.chargingStation | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.parking.bikeParking | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.plot | object | |
data.features.plot.usageFor | object | |
data.features.plot.developmentInfrastructure | object | |
data.features.plot.shortTermConstructible | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.plot.brownfield | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.plot.buildingPermission | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.plot.demolitionSuggested | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.plot.fencedPlot | string | Eines von YES, NO, NOT_APPLICABLE. |
data.features.plot.isTerracedArea | boolean | |
data.features.plot.tilt | string | Eines von NONE, MINOR, SIGNIFICANT, STEEP. |
data.features.plot.countrySpecific | object | |
data.structure | object | |
data.structure.building | object | |
data.structure.building.attic | string | Eines von CONVERTED, PART_CONVERTED, CONVERTIBLE, ISOLATED, ACCESSIBLE_WITH_FIXED_STAIRS. |
data.structure.building.balconyDirection | string | Eines von NORTH, EAST, SOUTH, WEST, NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST. |
data.structure.building.gardenOrientation | string | Eines von NORTH, EAST, SOUTH, WEST, NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST. |
data.structure.building.barrierFree | string | Eines von YES, NO, NOT_APPLICABLE. |
data.structure.building.bath | object | |
data.structure.building.cellar | string | Eines von YES, NO, PART, NOT_APPLICABLE. |
data.structure.building.elevator | object | |
data.structure.building.kitchen | object | |
data.structure.building.numberOfFloors | integer | 1 bis 999. |
data.structure.building.numberOfFacades | integer | 1 bis 999999. |
data.structure.building.roomHeight | number | 0 bis . |
data.structure.building.offeredFloors | integer | 1 bis 5. |
data.structure.building.roofStyle | string | Eines von HALF_HIPPED_ROOF, GAMBREL, MONO_PITCHED_ROOF, GABLE, HIP_ROOF, FLAT_ROOF, PYRAMIDAL_ROOF, OTHER. |
data.structure.building.locationInBuilding | string | Eines von GROUNDFLOOR, HALF_BASEMENT, ROOF_STOREY. |
data.structure.building.locationAtCorner | string | Eines von YES, NO, NOT_APPLICABLE. |
data.structure.building.calm | string | Eines von YES, NO, NOT_APPLICABLE. |
data.structure.building.withView | object | |
data.structure.building.luminous | string | Eines von YES, NO, NOT_APPLICABLE. |
data.structure.building.window | object | |
data.structure.building.shape | string | Eines von L_SHAPE, U_SHAPE, V_SHAPE, RECTANGULAR, SQUARE, OTHER. |
data.structure.building.hasSplitFloor | boolean | |
data.structure.building.wallConstructionMaterial | string[] | Eines von MASSIVE_WOOD, CINDER_BLOCK, INSULATING_CINDER_BLOCK, CELLULAR_CONCRETE, BRICK, HONEYCOMB_BRICK, LIMESTONE, WOOD_FRAME, METAL_FRAME. |
data.structure.rooms | object | |
data.structure.rooms.numberOfRooms | number | 0 bis 999999. |
data.structure.rooms.numberOfBedRooms | integer | 0 bis 999999. |
data.structure.rooms.numberOfBathRooms | integer | 0 bis 999999. |
data.structure.rooms.numberOfToilets | integer | 0 bis 999999. |
data.structure.rooms.numberOfBalconies | integer | 0 bis 999999. |
data.structure.rooms.numberOfTerraces | integer | 0 bis 999999. |
data.structure.rooms.numberOfKitchens | integer | 0 bis 999999. |
data.structure.rooms.numberOfUnits | integer | 0 bis 999999. |
data.structure.commercial | object | |
data.structure.commercial.floorLoad | integer | |
data.structure.commercial.floorLoadUpperFloors | number | |
data.structure.commercial.hallHeight | number | 0 bis . |
data.structure.commercial.numberOfBeds | integer | 0 bis 999999. |
data.structure.commercial.numberOfLoadingDocks | integer | 0 bis 999999. |
data.structure.commercial.numberOfDesks | integer | 0 bis 999999. |
data.structure.commercial.numberOfMeetingRooms | integer | 0 bis 999999. |
data.structure.commercial.numberOfOfficeRooms | integer | 0 bis 999999. |
data.structure.commercial.windowFront | number | 0 bis . |
data.structure.parkingLots | object | |
data.structure.parkingLots.outside | integer | 0 bis 999999. |
data.structure.parkingLots.streetParking | integer | 0 bis 999999. |
data.structure.parkingLots.carport | integer | 0 bis 999999. |
data.structure.parkingLots.garage | integer | 0 bis 999999. |
data.structure.parkingLots.doubleGarage | integer | 0 bis 999999. |
data.structure.parkingLots.duplex | integer | 0 bis 999999. |
data.structure.parkingLots.garageArea | integer | 0 bis 999999. |
data.structure.parkingLots.parkingArea | integer | 0 bis 999999. |
data.structure.parkingLots.carPark | integer | 0 bis 999999. |
data.structure.parkingLots.underground | integer | 0 bis 999999. |
data.structure.parkingLots.boatDock | integer | 0 bis 999999. |
data.texts | object | |
data.texts.headline | map<string> | |
data.texts.description | map<string> | |
data.texts.features | map<string> | |
data.texts.extendedInformation | map<string> | |
data.texts.area | map<string> | |
data.management | object | |
data.management.isImmediatelyAvailable | boolean | |
data.management.availableFrom | string (date) | |
data.management.availableUntil | string (date) | |
data.management.isForInvestment | boolean | |
data.management.heritageProtected | string | Eines von YES, NO, NOT_APPLICABLE. |
data.management.marketStatus | string | Eines von SOLD, RENTED, REFERENCE, RESERVED, UNDER_OFFER. |
data.management.projectStatus | string | Eines von BUILDING_PERMISSION, COMMERCIAL_LAUNCH, CONSTRUCTION_START, UNDER_CONSTRUCTION, SHELL_WORKS, FINISHING_WORKS, LAST_CHANCE, PROJECT_ENDED. |
data.management.marketLabel | string | |
data.management.isRented | boolean | |
data.management.useFor | string | Eines von LIVING, COMMERCIAL, MIXED, OFFICE, INDUSTRIAL. |
data.management.isForHolidayRental | boolean | |
data.management.rent | object | |
data.management.rent.favouredGender | string | Eines von MALE, FEMALE, OTHER. |
data.management.rent.minRentalTime | integer | |
data.management.rent.maxRentalTime | integer | |
data.management.rent.rentalTimeUnit | string | Eines von DAY, WEEK, MONTH, YEAR. |
data.management.rent.certificateOfEligibilityNeeded | string | Eines von YES, NO, NOT_APPLICABLE. |
data.management.rent.maxPersons | integer | |
data.management.rent.nonSmoker | string | Eines von YES, NO, NOT_APPLICABLE. |
data.management.rent.petsAllowed | string | Eines von YES, NO, NOT_APPLICABLE. |
data.management.rent.isShortTimeRental | boolean | |
data.management.compulsoryAuction | object | |
data.management.compulsoryAuction.auctionLocation | string | |
data.management.compulsoryAuction.auctionSpace | string | |
data.management.compulsoryAuction.cancellationDate | string (date) | |
data.management.compulsoryAuction.coOwnership | string | |
data.management.compulsoryAuction.countyCourt | string | |
data.management.compulsoryAuction.dateOfAuction | string (date) | |
data.management.compulsoryAuction.isDiscretionarySale | boolean | |
data.management.compulsoryAuction.distributionPlanNumber | string | |
data.management.compulsoryAuction.fileReferenceAtCountyCourt | string | |
data.management.compulsoryAuction.lastChangeDate | string (date) | |
data.management.compulsoryAuction.insolvencyAdministrator | string | |
data.management.compulsoryAuction.owner | string | |
data.management.compulsoryAuction.recordationDate | string (date) | |
data.management.compulsoryAuction.additionalDate | string (date) | |
data.management.compulsoryAuction.isWithoutValueLimits | boolean | |
data.management.compulsoryAuction.isSplittingAuction | boolean | |
data.countrySpecific | object | |
data.countrySpecific.de | object | |
data.countrySpecific.fr | object | |
data.countrySpecific.fr.business | object | |
data.contact | object | |
data.contact.salutation | string | Eines von Mr, Mrs, Miss, Ms, Mx, Sir, Dame, Dr, Cllr, Lady, Lord. |
data.contact.firstName | string | |
data.contact.lastName | string | |
data.contact.name | string | |
data.contact.emailAddress | string | |
data.contact.phoneNumber | string | |
data.contact.mobilePhoneNumber | string | |
data.contact.imageURL | string | |
data.contact.userHomepage | string | |
data.contact.postalCode | string | |
data.contact.city | string | |
data.contact.street | string | |
data.contact.houseNumber | string | |
data.contact.country | string | |
data.contact.preferredContactType | string | Eines von ANONYMOUS, BY_PHONE, BY_EMAIL, OWN_WEBSITE. |
data.contact.contactNote | map<string> | |
data.contact.displayedInformation | object | |
data.contact.displayedInformation.mainContactPerson | object | |
data.contact.displayedInformation.additionalContactPerson | object | |
data.links | object | |
data.links.externalLinks | object[] | |
data.links.externalLinks[].url | string | |
data.links.externalLinks[].urlType | string | Eines von MAP, MOVIE, PANORAMA, REVOCATION_INSTRUCTION, OFFERER_DETAIL_PAGE. |
data.links.externalLinks[].title | string | |
data.links.virtualTours | object[] | |
data.links.virtualTours[].url | string | |
data.links.virtualTours[].provider | string | |
data.links.virtualTours[].title | string | |
metadata | object | |
metadata.source | object | |
metadata.source.offererMarketingKey | string | |
metadata.source.offererEstateId | string | |
metadata.source.offererEstateGroupId | string | |
metadata.portalWebKey | string | |
userDefined | object[] | |
userDefined[].name | string | |
userDefined[].value | string | |
userDefined[].utyp | string | Eines von string, integer, boolean, decimal. |
userDefined[].modus | string | |
media | object[] | |
media[].externalMediaId | string | |
media[].title | string | |
contact | object | |
contact.salutation | string | Eines von Mr, Mrs, Miss, Ms, Mx, Sir, Dame, Dr, Cllr, Lady, Lord. |
contact.firstName | string | |
contact.lastName | string | |
contact.name | string | |
contact.emailAddress | string | |
contact.phoneNumber | string | |
contact.mobilePhoneNumber | string | |
contact.imageURL | string | |
contact.userHomepage | string | |
contact.postalCode | string | |
contact.city | string | |
contact.street | string | |
contact.houseNumber | string | |
contact.country | string | |
contact.preferredContactType | string | Eines von ANONYMOUS, BY_PHONE, BY_EMAIL, OWN_WEBSITE. |
contact.contactNote | map<string> | |
contact.displayedInformation | object | |
contact.displayedInformation.mainContactPerson | object | |
contact.displayedInformation.mainContactPerson.name | boolean | |
contact.displayedInformation.mainContactPerson.phone | boolean | |
contact.displayedInformation.mainContactPerson.mobilePhone | boolean | |
contact.displayedInformation.mainContactPerson.email | boolean | |
contact.displayedInformation.mainContactPerson.address | boolean | |
contact.displayedInformation.mainContactPerson.companyName | boolean | |
contact.displayedInformation.mainContactPerson.fax | boolean | |
contact.displayedInformation.additionalContactPerson | object | |
contact.displayedInformation.additionalContactPerson.name | boolean | |
contact.displayedInformation.additionalContactPerson.phone | boolean | |
contact.displayedInformation.additionalContactPerson.mobilePhone | boolean | |
contact.displayedInformation.additionalContactPerson.email | boolean | |
contact.displayedInformation.additionalContactPerson.address | boolean | |
contact.displayedInformation.additionalContactPerson.companyName | boolean | |
contact.displayedInformation.additionalContactPerson.fax | boolean |
Beispiel
curl -X PUT "https://api.athaus.ai/v1/listings/WE-12" \
-H "Authorization: Bearer ath_live_..." \
-H "Content-Type: application/json" \
-d '{"data":{"estateType":"APARTMENT","estateSubType":{"apartment":"MULTI_STOREY"},"distributionType":"BUY","location":{"postalcode":"10435","city":"Berlin","street":"Kastanienallee","houseNumber":"12","country":"DEU","floorNumber":3,"geometry":{"type":"Point","coordinates":[13.4128,52.5395]}},"prices":{"currency":"EUR","buy":{"price":{"amount":350000}}},"spaces":{"spaceMeasureUnit":"SQUARE_METER","residential":{"livingSpace":62}},"structure":{"rooms":{"numberOfRooms":2,"numberOfBedRooms":1,"numberOfBathRooms":1}},"conditions":{"yearOfConstruction":1998},"texts":{"headline":{"de":"Helle Zweizimmerwohnung am Kastanienallee-Kiez","en":"Bright two-room flat"},"description":{"de":"Ruhige Wohnung im dritten Stock mit Balkon zum Hof."}}},"metadata":{"source":{"offererEstateId":"WE-12","offererMarketingKey":"WE-12"}},"userDefined":[{"name":"de.livingSpaceStandard","value":"WOFLV","utyp":"string"},{"name":"price.associationFee","value":"285.50","utyp":"decimal"}]}'Antwort
Bei Erfolg kommt 202 mit ListingReceipt.
ListingReceipt
| Feld | Typ | Beschreibung |
|---|---|---|
requestId | string | |
listingId | string | |
externalListingId | string | |
warnings | object[] | |
warnings[].type | string | |
warnings[].message | string |
Köpfe der Antwort
| Kopf | Beschreibung |
|---|---|
Request-Id | Identifies this request. Quote it in a support request. |
Athaus-Version | The API version of this response: v1. |
Athaus-Release | The release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it. |
RateLimit-Policy | The quota policy of the bucket that applies. |
RateLimit | Remaining quota and seconds until the bucket is full again. |
Fehler
Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.
| Status | Codes | Bedeutung |
|---|---|---|
400 | invalid_query, api_version_unsupported, invalid_input, invalid_body, profile_unsupported | Invalid request. |
401 | unauthorized | Missing or invalid API key. |
403 | insufficient_permissions, plan_required | The key lacks a right, or the plan does not include API access. |
404 | not_found | Nothing under this ID. |
409 | address_already_exists, reference_already_exists | The request conflicts with the state of the resource (for example a duplicate), or with an idempotency key. |
412 | precondition_failed | The condition of If-Match (or If-None-Match) does not hold for the current state of the resource. Nothing was written. |
413 | payload_too_large | The request body is larger than 512 KB. |
415 | invalid_input | The request body is not JSON. Send Content-Type: application/json. |
429 | rate_limited | Rate limit exceeded. |
500 | internal_error | Server error. |
Weiter lesen
REST-API: Anmeldung mit einem API-Key
Jeder Aufruf von /v1 trägt einen API-Key als Bearer-Token. Wo du ihn bekommst, welche Scopes er trägt und was nicht geht.
REST-API: Fehler als Problem Details
Jeder Fehler von /v1 ist ein Problem nach RFC 9457 mit echtem HTTP-Status, einem Code zum Verzweigen und einer Request-Id für den Support.