AthausDoku

Retrieve a project

Aufruf, Parameter, Antwort und Fehler von GET /v1/projects/{externalProjectId}.

Zuletzt aktualisiert:

Returns the project in the OpenImmo 2.0 shape. data.units carries the figures of its units (their number, price and area range); the units themselves are listings, named by assignedListings (ours, not OpenImmo; a project holds at most 1000 units, so the list is never longer) and readable with GET /listings/{externalListingId}, where projectId marks them. Needs read access to projects.

Braucht den Scope read und mindestens die Stufe read auf projects.

In der Konsole ausprobieren

Aufruf

GET https://api.athaus.ai/v1/projects/{externalProjectId}

Parameter

Pfad

NameTypPflichtBeschreibung
externalProjectIdstringjaYour reference of the project: the value of metadata.source.offererMarketingKey. A project without one has its own projectId here, and the projectId always works in the path. 1 to 128 letters, digits, dots, underscores or hyphens, not starting or ending with a dot.

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-None-MatchstringneinAn ETag you hold. If it is still current, the answer is 304 without a body.

Beispiel

curl "https://api.athaus.ai/v1/projects/PRJ-1-ext" \
  -H "Authorization: Bearer ath_live_..."

Antwort

Bei Erfolg kommt 200 mit ProjectResponse.

ProjectResponse

FeldTypBeschreibung
projectIdstring (uuid)Ours, not OpenImmo: the id Athaus gave the project; it always works in the path.
statusstring | anyOurs, not OpenImmo: the project state of the office, by name.
createdAtstring (date-time)
updatedAtstring (date-time)
dataobject
data.estateTypestringEines von NEW_BUILD_PROJECT, NEW_HOME_PROJECT.
data.estateSubTypestring | object | null | any
data.distributionTypestringEines von BUY, RENT, BUY_RENT.
data.unitsobject
data.units.numberOfUnitsnumber0 bis 999999.
data.units.priceFromnumber0 bis .
data.units.priceTonumber0 bis .
data.units.livingSpaceFromnumber0 bis .
data.units.livingSpaceTonumber0 bis .
data.units.numberOfRoomsFromnumber0 bis .
data.units.numberOfRoomsTonumber0 bis .
data.units.furnishingLevelstringEines von NOT_PROVIDED, STANDARD, UPSCALE, FULL.
data.units.provisionTypestringEines von PROVISION_FREE, PROVISION_FOR_BUYER, NOT_PROVIDED.
data.units.provisionPercentnumber0 bis .
data.units.provisionIsVatIncludedstringEines von YES, NO, NOT_PROVIDED.
data.units.soldOutPercentagenumber0 bis .
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.programobject
data.program.projectStatusstringEines von CONSTRUCTION_START, PROJECT_ENDED.
data.deliveryDatestring
data.structureobject
data.structure.buildingobject
data.structure.building.numberOfFloorsinteger1 bis 999.
data.textsobject
data.texts.headlinemap<string>
data.texts.descriptionmap<string>
data.texts.featuresmap<string>
data.texts.extendedInformationmap<string>
data.texts.areamap<string>
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
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
metadataobject
metadata.sourceobject
metadata.source.offererMarketingKeystring
metadata.source.offererEstateIdstring
metadata.portalWebKeystring
assignedListingsobject[]
assignedListings[].externalListingIdstring

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.
ETagA strong entity tag of this state of the resource. Send it as If-Match to change or delete the resource only if it is unchanged, or as If-None-Match to read it only if it changed.
RateLimit-PolicyThe quota policy of the bucket that applies.
RateLimitRemaining quota and seconds until the bucket is full again.

Mit If-None-Match auf den aktuellen ETag antwortet die Operation 304 ohne Rumpf.

Fehler

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

StatusCodesBedeutung
400api_version_unsupported, invalid_inputInvalid 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.
429rate_limitedRate limit exceeded.
500internal_errorServer error.

Weiter lesen

Auf dieser Seite