AthausDoku

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

NameTypPflichtBeschreibung
externalListingIdstringjaYour 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

NameTypPflichtBeschreibung
draftstringneinAccept an incomplete listing: only metadata.source is required, and the rest is checked when the listing is published. Ours, not OpenImmo. Vorgabe false.
createIfMissingstringneinCreate the listing when the id is unknown. Without it an unknown id is a 404. Vorgabe false.

Kopf

NameTypPflichtBeschreibung
Athaus-VersionstringneinOptional 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-MatchstringneinOnly if the current ETag of the resource is listed (or *: only if the resource exists). Otherwise 412 and nothing is written.
If-None-Matchstringnein*: 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.

FeldTypBeschreibung
dataobject
data.estateTypestringEines von HOUSE, APARTMENT, PLOT, OFFICE, TRADING, GASTRONOMY_HOTEL, STORAGE_PRODUCTION, AGRICULTURE_FORESTRY, PARKING, SENIOR, PROJECT, MISCELLANEOUS.
data.estateSubTypeobject
data.distributionTypestringEines von BUY, RENT, COMPULSORY_AUCTION, BUY_AUCTION.
data.locationobject
data.location.postalcodestring
data.location.citystring
data.location.streetstring
data.location.houseNumberstring
data.location.unitstring
data.location.staircasestring
data.location.floorNumberinteger-5 bis 999.
data.location.entrancestring
data.location.statestring
data.location.countrystringEine von 249 Angaben der Liste im Standard.
data.location.geometryobject
data.location.geometry.typestringImmer Point.
data.location.geometry.coordinatesnumber[]
data.location.showAddressbooleanVorgabe true.
data.location.locationNotemap<string>
data.pricesobject
data.prices.currencystringEine von 180 Angaben der Liste im Standard. Vorgabe EUR.
data.prices.buyobject
data.prices.buy.priceany
data.prices.buy.isLeaseBuyCombiboolean
data.prices.buy.leaseholdobject
data.prices.buy.operatingCostsany
data.prices.buy.rentalIncomeany
data.prices.buy.rentalIncomeExpectany
data.prices.buy.isParkingPriceIncludedboolean
data.prices.buy.parkingPricesany[]
data.prices.buy.pricePerSqUnitany
data.prices.buy.yieldFactornumber0 bis 9999999999999.
data.prices.buy.countrySpecificobject
data.prices.rentobject
data.prices.rent.baseRentany
data.prices.rent.baseRentPerYearany
data.prices.rent.totalRentany
data.prices.rent.leaseany
data.prices.rent.operatingCostsany
data.prices.rent.heatingCostsany
data.prices.rent.isHeatingIncludedInOCboolean
data.prices.rent.isHeatingIncludedInTRboolean
data.prices.rent.pricePerSqUnitany
data.prices.rent.pricePerSqUnitPerYearany
data.prices.rent.priceTimeUnitstringEines von DAY, WEEK, MONTH, YEAR. Vorgabe MONTH.
data.prices.rent.isParkingPriceIncludedboolean
data.prices.rent.parkingPricesany[]
data.prices.rent.depositNotemap<string>
data.prices.rent.countrySpecificobject
data.prices.compulsoryAuctionobject
data.prices.compulsoryAuction.auctionProceedsany
data.prices.compulsoryAuction.biddingGuaranteeany
data.prices.compulsoryAuction.marketValueany
data.prices.compulsoryAuction.minimumBidany
data.prices.buyAuctionobject
data.prices.buyAuction.minPriceobject
data.prices.buyAuction.startOfferPhasestring (date)
data.prices.buyAuction.endOfferPhasestring (date)
data.prices.brokerageFeeany
data.prices.showPriceboolean
data.prices.priceNotemap<string>
data.prices.countrySpecificobject
data.prices.countrySpecific.frobject
data.spacesobject
data.spaces.spaceMeasureUnitstringEines von SQUARE_METER, SQUARE_INCH, SQUARE_FOOT, SQUARE_YARD, HECTARE, ACRE. Vorgabe SQUARE_METER.
data.spaces.buildingFrontnumber0 bis 99999999.
data.spaces.kitchenSpacenumber0 bis 99999999.
data.spaces.overallSpacenumber0 bis 99999999.
data.spaces.usableFloorSpacenumber0 bis 99999999.
data.spaces.spaceMaxnumber0 bis 99999999.
data.spaces.spaceMinnumber0 bis 99999999.
data.spaces.plotSpacenumber0 bis 99999999.
data.spaces.plotFrontnumber0 bis 99999999.
data.spaces.additionalSpacenumber0 bis 99999999.
data.spaces.residentialobject
data.spaces.residential.livingSpacenumber0 bis 99999999.
data.spaces.residential.livingRoomSpacenumber0 bis 99999999.
data.spaces.residential.atticSpacenumber0 bis 99999999.
data.spaces.residential.balconySpacenumber0 bis 99999999.
data.spaces.residential.cellarSpacenumber0 bis 99999999.
data.spaces.residential.gardenSpacenumber0 bis 99999999.
data.spaces.residential.terraceSpacenumber0 bis 99999999.
data.spaces.commercialobject
data.spaces.commercial.maxDivisiblenumber0 bis 99999999.
data.spaces.commercial.minDivisiblenumber0 bis 99999999.
data.spaces.commercial.commercialSpacenumber0 bis 99999999.
data.spaces.commercial.shopSpacenumber0 bis 99999999.
data.spaces.commercial.storageSpacenumber0 bis 99999999.
data.spaces.commercial.sellSpacenumber0 bis 99999999.
data.spaces.commercial.officeSpacenumber0 bis 99999999.
data.spaces.commercial.officePartSpacenumber0 bis 99999999.
data.spaces.commercial.managementSpacenumber0 bis 99999999.
data.spaces.commercial.restaurantSpacenumber0 bis 99999999.
data.spaces.commercial.countrySpecificobject
data.conditionsobject
data.conditions.buildStatestringEines 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.ageStatestringEines von OLD, NEW.
data.conditions.lastModernisationinteger
data.conditions.constructionStylestringEines von PREFABRICATED, SOLID, SOLID_PREFABRICATED, TIMBERHOUSE, WOOD_PREFABRICATED, UNSPECIFIED.
data.conditions.yearOfConstructioninteger1000 bis 3000.
data.energyobject
data.energy.energyTypeobject
data.energy.energyType.heatMethodstringEines von CENTRAL, INDIVIDUAL, STOREY.
data.energy.energyType.heatFormobject
data.energy.energyType.energySourceobject
data.energy.energyType.energyGenerationobject
data.energy.energyType.maxElectricalPowerinteger
data.energy.countrySpecificobject
data.energy.countrySpecific.deobject
data.featuresobject
data.features.accessibleFromStreetstringEines von YES, NO, NOT_APPLICABLE.
data.features.airconditionstringEines von YES, PART, NO, NOT_APPLICABLE.
data.features.entranceHallstringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCoveringobject
data.features.floorCovering.tilesstringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.stonestringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.carpetstringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.parquetstringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.laminatestringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.syntheticstringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.screedstringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.linoleumstringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.marblestringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.terracottastringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.granitestringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.raisedFloorstringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.quartzstringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.concretestringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.antiDustConcretestringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.woodenPlankstringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.antiStaticstringEines von YES, NO, NOT_APPLICABLE.
data.features.floorCovering.vinylstringEines von YES, NO, NOT_APPLICABLE.
data.features.furnishedstringEines von PART, FULL, NO, NOT_APPLICABLE.
data.features.gardenobject
data.features.garden.partboolean
data.features.garden.privateboolean
data.features.garden.sharedboolean
data.features.gymstringEines von YES, NO, NOT_APPLICABLE.
data.features.internetobject
data.features.internet.internetSpeedMbitinteger0 bis .
data.features.internet.internetAvailabilityobject
data.features.internet.propertyInternetAccessobject
data.features.lightingobject
data.features.lighting.ceilingstringEines von YES, NO, NOT_APPLICABLE.
data.features.lighting.ledstringEines von YES, NO, NOT_APPLICABLE.
data.features.lighting.windowstringEines von YES, NO, NOT_APPLICABLE.
data.features.mezzaninestringEines von YES, NO, NOT_APPLICABLE.
data.features.propertyOrientationstringEines von NORTH, EAST, SOUTH, WEST, NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST.
data.features.receptioniststringEines von YES, NO, NOT_APPLICABLE.
data.features.securityobject
data.features.security.buildingIntercomstringEines von YES, NO, NOT_APPLICABLE, VIDEO, DOOR_PHONE.
data.features.security.camstringEines von YES, NO, NOT_APPLICABLE.
data.features.security.custodianstringEines von YES, NO, NOT_APPLICABLE.
data.features.security.custodianRoomstringEines von YES, NO, NOT_APPLICABLE.
data.features.security.digitalLockstringEines von YES, NO, NOT_APPLICABLE.
data.features.security.emergencyCallstringEines von YES, NO, NOT_APPLICABLE.
data.features.security.fireSprinklerstringEines von YES, NO, NOT_APPLICABLE.
data.features.security.fireAlarmstringEines von YES, NO, NOT_APPLICABLE.
data.features.security.intruderAlarmstringEines von YES, NO, NOT_APPLICABLE.
data.features.security.reinforcedDoorstringEines von YES, NO, NOT_APPLICABLE.
data.features.security.safestringEines von YES, NO, NOT_APPLICABLE.
data.features.wheelchairUsestringEines von YES, NO, NOT_APPLICABLE.
data.features.wineCellarstringEines von YES, NO, NOT_APPLICABLE.
data.features.residentialobject
data.features.residential.assistedLivingstringEines von YES, NO, NOT_APPLICABLE.
data.features.residential.chimneystringEines von YES, NO, NOT_APPLICABLE.
data.features.residential.flatSharePossiblestringEines von YES, NO, NOT_APPLICABLE.
data.features.residential.hammamstringEines von YES, NO, NOT_APPLICABLE.
data.features.residential.houseCleaningServicestringEines von YES, NO, NOT_APPLICABLE.
data.features.residential.jacuzzistringEines von YES, NO, NOT_APPLICABLE.
data.features.residential.loggiastringEines von YES, NO, NOT_APPLICABLE.
data.features.residential.saunastringEines von YES, NO, NOT_APPLICABLE.
data.features.residential.swimmingPoolstringEines von YES, NO, INSIDE, OUTSIDE, INSIDE_AND_OUTSIDE, NOT_APPLICABLE.
data.features.residential.tennisFieldstringEines von YES, NO, NOT_APPLICABLE, PRIVATE, SHARED.
data.features.residential.tvstringEines von SAT, CABLE, OTHER.
data.features.residential.verandastringEines von YES, NO, NOT_APPLICABLE.
data.features.residential.laundryRoomstringEines von YES, NO, NOT_APPLICABLE.
data.features.residential.countrySpecificobject
data.features.commercialobject
data.features.commercial.accessibleByTrucksstringEines von YES, NO, NOT_APPLICABLE, SEPARATED_TRUCK_ACCESS.
data.features.commercial.auditoriumstringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.barstringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.buildingVentilationstringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.cafeteriastringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.coldStorestringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.companyRestaurantstringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.droppedCeilingstringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.engineGeneratorstringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.exhaustHoodstringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.flexibleRoomLayoutstringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.heatedTerracestringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.liftingPlatformstringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.numberOfStorageCellsinteger0 bis 999999.
data.features.commercial.overheadCranestringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.restaurantSeatsinteger0 bis 999999.
data.features.commercial.restaurantSeatsOutsideinteger0 bis 999999.
data.features.commercial.teaKitchenstringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.truckManeuveringAreastringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.verticalSlidingDoorstringEines von YES, NO, NOT_APPLICABLE.
data.features.commercial.wallSidingstringEines von YES, NO, NOT_APPLICABLE, DOUBLE, DECORATIVE.
data.features.commercial.countrySpecificobject
data.features.parkingobject
data.features.parking.chargingStationstringEines von YES, NO, NOT_APPLICABLE.
data.features.parking.bikeParkingstringEines von YES, NO, NOT_APPLICABLE.
data.features.plotobject
data.features.plot.usageForobject
data.features.plot.developmentInfrastructureobject
data.features.plot.shortTermConstructiblestringEines von YES, NO, NOT_APPLICABLE.
data.features.plot.brownfieldstringEines von YES, NO, NOT_APPLICABLE.
data.features.plot.buildingPermissionstringEines von YES, NO, NOT_APPLICABLE.
data.features.plot.demolitionSuggestedstringEines von YES, NO, NOT_APPLICABLE.
data.features.plot.fencedPlotstringEines von YES, NO, NOT_APPLICABLE.
data.features.plot.isTerracedAreaboolean
data.features.plot.tiltstringEines von NONE, MINOR, SIGNIFICANT, STEEP.
data.features.plot.countrySpecificobject
data.structureobject
data.structure.buildingobject
data.structure.building.atticstringEines von CONVERTED, PART_CONVERTED, CONVERTIBLE, ISOLATED, ACCESSIBLE_WITH_FIXED_STAIRS.
data.structure.building.balconyDirectionstringEines von NORTH, EAST, SOUTH, WEST, NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST.
data.structure.building.gardenOrientationstringEines von NORTH, EAST, SOUTH, WEST, NORTH_EAST, SOUTH_EAST, SOUTH_WEST, NORTH_WEST.
data.structure.building.barrierFreestringEines von YES, NO, NOT_APPLICABLE.
data.structure.building.bathobject
data.structure.building.cellarstringEines von YES, NO, PART, NOT_APPLICABLE.
data.structure.building.elevatorobject
data.structure.building.kitchenobject
data.structure.building.numberOfFloorsinteger1 bis 999.
data.structure.building.numberOfFacadesinteger1 bis 999999.
data.structure.building.roomHeightnumber0 bis .
data.structure.building.offeredFloorsinteger1 bis 5.
data.structure.building.roofStylestringEines von HALF_HIPPED_ROOF, GAMBREL, MONO_PITCHED_ROOF, GABLE, HIP_ROOF, FLAT_ROOF, PYRAMIDAL_ROOF, OTHER.
data.structure.building.locationInBuildingstringEines von GROUNDFLOOR, HALF_BASEMENT, ROOF_STOREY.
data.structure.building.locationAtCornerstringEines von YES, NO, NOT_APPLICABLE.
data.structure.building.calmstringEines von YES, NO, NOT_APPLICABLE.
data.structure.building.withViewobject
data.structure.building.luminousstringEines von YES, NO, NOT_APPLICABLE.
data.structure.building.windowobject
data.structure.building.shapestringEines von L_SHAPE, U_SHAPE, V_SHAPE, RECTANGULAR, SQUARE, OTHER.
data.structure.building.hasSplitFloorboolean
data.structure.building.wallConstructionMaterialstring[]Eines von MASSIVE_WOOD, CINDER_BLOCK, INSULATING_CINDER_BLOCK, CELLULAR_CONCRETE, BRICK, HONEYCOMB_BRICK, LIMESTONE, WOOD_FRAME, METAL_FRAME.
data.structure.roomsobject
data.structure.rooms.numberOfRoomsnumber0 bis 999999.
data.structure.rooms.numberOfBedRoomsinteger0 bis 999999.
data.structure.rooms.numberOfBathRoomsinteger0 bis 999999.
data.structure.rooms.numberOfToiletsinteger0 bis 999999.
data.structure.rooms.numberOfBalconiesinteger0 bis 999999.
data.structure.rooms.numberOfTerracesinteger0 bis 999999.
data.structure.rooms.numberOfKitchensinteger0 bis 999999.
data.structure.rooms.numberOfUnitsinteger0 bis 999999.
data.structure.commercialobject
data.structure.commercial.floorLoadinteger
data.structure.commercial.floorLoadUpperFloorsnumber
data.structure.commercial.hallHeightnumber0 bis .
data.structure.commercial.numberOfBedsinteger0 bis 999999.
data.structure.commercial.numberOfLoadingDocksinteger0 bis 999999.
data.structure.commercial.numberOfDesksinteger0 bis 999999.
data.structure.commercial.numberOfMeetingRoomsinteger0 bis 999999.
data.structure.commercial.numberOfOfficeRoomsinteger0 bis 999999.
data.structure.commercial.windowFrontnumber0 bis .
data.structure.parkingLotsobject
data.structure.parkingLots.outsideinteger0 bis 999999.
data.structure.parkingLots.streetParkinginteger0 bis 999999.
data.structure.parkingLots.carportinteger0 bis 999999.
data.structure.parkingLots.garageinteger0 bis 999999.
data.structure.parkingLots.doubleGarageinteger0 bis 999999.
data.structure.parkingLots.duplexinteger0 bis 999999.
data.structure.parkingLots.garageAreainteger0 bis 999999.
data.structure.parkingLots.parkingAreainteger0 bis 999999.
data.structure.parkingLots.carParkinteger0 bis 999999.
data.structure.parkingLots.undergroundinteger0 bis 999999.
data.structure.parkingLots.boatDockinteger0 bis 999999.
data.textsobject
data.texts.headlinemap<string>
data.texts.descriptionmap<string>
data.texts.featuresmap<string>
data.texts.extendedInformationmap<string>
data.texts.areamap<string>
data.managementobject
data.management.isImmediatelyAvailableboolean
data.management.availableFromstring (date)
data.management.availableUntilstring (date)
data.management.isForInvestmentboolean
data.management.heritageProtectedstringEines von YES, NO, NOT_APPLICABLE.
data.management.marketStatusstringEines von SOLD, RENTED, REFERENCE, RESERVED, UNDER_OFFER.
data.management.projectStatusstringEines von BUILDING_PERMISSION, COMMERCIAL_LAUNCH, CONSTRUCTION_START, UNDER_CONSTRUCTION, SHELL_WORKS, FINISHING_WORKS, LAST_CHANCE, PROJECT_ENDED.
data.management.marketLabelstring
data.management.isRentedboolean
data.management.useForstringEines von LIVING, COMMERCIAL, MIXED, OFFICE, INDUSTRIAL.
data.management.isForHolidayRentalboolean
data.management.rentobject
data.management.rent.favouredGenderstringEines von MALE, FEMALE, OTHER.
data.management.rent.minRentalTimeinteger
data.management.rent.maxRentalTimeinteger
data.management.rent.rentalTimeUnitstringEines von DAY, WEEK, MONTH, YEAR.
data.management.rent.certificateOfEligibilityNeededstringEines von YES, NO, NOT_APPLICABLE.
data.management.rent.maxPersonsinteger
data.management.rent.nonSmokerstringEines von YES, NO, NOT_APPLICABLE.
data.management.rent.petsAllowedstringEines von YES, NO, NOT_APPLICABLE.
data.management.rent.isShortTimeRentalboolean
data.management.compulsoryAuctionobject
data.management.compulsoryAuction.auctionLocationstring
data.management.compulsoryAuction.auctionSpacestring
data.management.compulsoryAuction.cancellationDatestring (date)
data.management.compulsoryAuction.coOwnershipstring
data.management.compulsoryAuction.countyCourtstring
data.management.compulsoryAuction.dateOfAuctionstring (date)
data.management.compulsoryAuction.isDiscretionarySaleboolean
data.management.compulsoryAuction.distributionPlanNumberstring
data.management.compulsoryAuction.fileReferenceAtCountyCourtstring
data.management.compulsoryAuction.lastChangeDatestring (date)
data.management.compulsoryAuction.insolvencyAdministratorstring
data.management.compulsoryAuction.ownerstring
data.management.compulsoryAuction.recordationDatestring (date)
data.management.compulsoryAuction.additionalDatestring (date)
data.management.compulsoryAuction.isWithoutValueLimitsboolean
data.management.compulsoryAuction.isSplittingAuctionboolean
data.countrySpecificobject
data.countrySpecific.deobject
data.countrySpecific.frobject
data.countrySpecific.fr.businessobject
data.contactobject
data.contact.salutationstringEines von Mr, Mrs, Miss, Ms, Mx, Sir, Dame, Dr, Cllr, Lady, Lord.
data.contact.firstNamestring
data.contact.lastNamestring
data.contact.namestring
data.contact.emailAddressstring
data.contact.phoneNumberstring
data.contact.mobilePhoneNumberstring
data.contact.imageURLstring
data.contact.userHomepagestring
data.contact.postalCodestring
data.contact.citystring
data.contact.streetstring
data.contact.houseNumberstring
data.contact.countrystring
data.contact.preferredContactTypestringEines von ANONYMOUS, BY_PHONE, BY_EMAIL, OWN_WEBSITE.
data.contact.contactNotemap<string>
data.contact.displayedInformationobject
data.contact.displayedInformation.mainContactPersonobject
data.contact.displayedInformation.additionalContactPersonobject
data.linksobject
data.links.externalLinksobject[]
data.links.externalLinks[].urlstring
data.links.externalLinks[].urlTypestringEines von MAP, MOVIE, PANORAMA, REVOCATION_INSTRUCTION, OFFERER_DETAIL_PAGE.
data.links.externalLinks[].titlestring
data.links.virtualToursobject[]
data.links.virtualTours[].urlstring
data.links.virtualTours[].providerstring
data.links.virtualTours[].titlestring
metadataobject
metadata.sourceobject
metadata.source.offererMarketingKeystring
metadata.source.offererEstateIdstring
metadata.source.offererEstateGroupIdstring
metadata.portalWebKeystring
userDefinedobject[]
userDefined[].namestring
userDefined[].valuestring
userDefined[].utypstringEines von string, integer, boolean, decimal.
userDefined[].modusstring
mediaobject[]
media[].externalMediaIdstring
media[].titlestring
contactobject
contact.salutationstringEines von Mr, Mrs, Miss, Ms, Mx, Sir, Dame, Dr, Cllr, Lady, Lord.
contact.firstNamestring
contact.lastNamestring
contact.namestring
contact.emailAddressstring
contact.phoneNumberstring
contact.mobilePhoneNumberstring
contact.imageURLstring
contact.userHomepagestring
contact.postalCodestring
contact.citystring
contact.streetstring
contact.houseNumberstring
contact.countrystring
contact.preferredContactTypestringEines von ANONYMOUS, BY_PHONE, BY_EMAIL, OWN_WEBSITE.
contact.contactNotemap<string>
contact.displayedInformationobject
contact.displayedInformation.mainContactPersonobject
contact.displayedInformation.mainContactPerson.nameboolean
contact.displayedInformation.mainContactPerson.phoneboolean
contact.displayedInformation.mainContactPerson.mobilePhoneboolean
contact.displayedInformation.mainContactPerson.emailboolean
contact.displayedInformation.mainContactPerson.addressboolean
contact.displayedInformation.mainContactPerson.companyNameboolean
contact.displayedInformation.mainContactPerson.faxboolean
contact.displayedInformation.additionalContactPersonobject
contact.displayedInformation.additionalContactPerson.nameboolean
contact.displayedInformation.additionalContactPerson.phoneboolean
contact.displayedInformation.additionalContactPerson.mobilePhoneboolean
contact.displayedInformation.additionalContactPerson.emailboolean
contact.displayedInformation.additionalContactPerson.addressboolean
contact.displayedInformation.additionalContactPerson.companyNameboolean
contact.displayedInformation.additionalContactPerson.faxboolean

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

FeldTypBeschreibung
requestIdstring
listingIdstring
externalListingIdstring
warningsobject[]
warnings[].typestring
warnings[].messagestring

Köpfe der Antwort

KopfBeschreibung
Request-IdIdentifies this request. Quote it in a support request.
Athaus-VersionThe API version of this response: v1.
Athaus-ReleaseThe release of v1 that answered, for example 1.0. A label for support and changelogs; no request can select it.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Fehler

Jeder Fehler kommt als Problem Details. Verzweige auf code, nicht auf title oder detail.

StatusCodesBedeutung
400invalid_query, api_version_unsupported, invalid_input, invalid_body, profile_unsupportedInvalid request.
401unauthorizedMissing or invalid API key.
403insufficient_permissions, plan_requiredThe key lacks a right, or the plan does not include API access.
404not_foundNothing under this ID.
409address_already_exists, reference_already_existsThe request conflicts with the state of the resource (for example a duplicate), or with an idempotency key.
412precondition_failedThe condition of If-Match (or If-None-Match) does not hold for the current state of the resource. Nothing was written.
413payload_too_largeThe request body is larger than 512 KB.
415invalid_inputThe request body is not JSON. Send Content-Type: application/json.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Weiter lesen

Auf dieser Seite