Search
K
[dev] 🇩🇪 Listings Management Germany

metadata

object

metadatas associated to listing in Aviv system

* Additional properties are NOT allowed.
sourceobjectrequired

metadata related to the source / sender system

* Additional properties are NOT allowed.
Show Child Parameters
portalWebKeystring

short id of the real estate classified on a public website. generated by the portal/receiver.

Example:2rqww3y

Example

contact

object
* Additional properties are NOT allowed.
salutationstring

Listing contact salutation.

Allowed values:MrMrsMissMsMxSirDameDrCllrLadyLord

<= 10 characters

Example:Mr

firstNamestring

Listing contact firstName.

<= 255 characters

Example:John

lastNamestring

Listing contact lastName.

<= 255 characters

Example:Doe

namestring

Listing contact name or customer’s default name.

<= 255 characters

Example:Mr John DOE

emailAddressstring

Listing contact email address or customer’s default email address.

<= 320 characters

Example:john.doe@johndoe.com

phoneNumberstring

Listing contact phone number or customer’s default phone number.

<= 36 characters

Example:4915165500000

mobilePhoneNumberstring

Listing contact mobile phone number or customer’s default mobile phone number.

<= 36 characters

Example:4965165500000

imageURLstring

This imageURL field defined for imageURLofcontact. phone number.

<= 2048 characters

Example://filestore.immowelt.de/ProfilBilder/150_7360cdfde1634fe38bf3d0dacee3aa3f.jpg

userHomepagestring

URL of the user’s homepage or website

<= 2048 characters

Example:https://www.example.com

postalCodestring

Postal code of the contact person

Match pattern:^[a-zA-Z0-9\s-]{3,12}$

>= 3 characters<= 12 characters

Example:22455

citystring

City of the contact person

<= 128 characters

Example:Hamburg

streetstring

Street of the contact person

<= 512 characters

Example:Hauptstrasse

houseNumberstring

House number of the contact person

<= 64 characters

Example:10

countrystring

Country of the contact person

<= 64 characters

Example:DEU

preferredContactTypestring

Preferred method of contact

Allowed values:ANONYMOUSBY_PHONEBY_EMAILOWN_WEBSITE

Example:BY_EMAIL

contactNoteobject

Contact note in multiple languages

Example:{"de":"Hallo!","en":"Hello!","fr":"Bonjour!","nl":"Hallo!"}

* Additional properties are NOT allowed.
Show Child Parameters
displayedInformationobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

flexOfficeCoworkingSpace

object
* Additional properties are NOT allowed.
typestring

enum value that defines the type

Allowed values:NOMAD_WORKSTATIONRESIDENT_WORKSTATIONPRIVATE_OFFICEMEETING_ROOM

roomNamestring

value that indicates the name of the room when type = MEETING_ROOM

Example:Salle 1

nextHoursPricenumber

value that indicates the price for extra hours

>= 0<= 9999999999999

Example:20

numberOfWorkstationinteger

value that indicates the number of places

>= 0<= 999999

Example:15

openHourstring

value that indicates the open hour (in the format HH:mm)

Example:08:00

closeHourstring

value that indicates the close hour (in the format HH:mm)

Example:20:00

isSeparateSocialRoomboolean

value that indicates if the social room for interactions is separated from the space

noticeTypestring

enum value that defines the notice type

Allowed values:NO_NOTICEHOURS_24HOURS_48WEEKS_1MONTHS_1OTHER

otherNoticestring

value that indicates the notice when noticeType is OTHER

Example:3 months

equipmentsarray[string]

value that indicates the set of features of the coworking space

Allowed values:HIGH_SPEED_INTERNETPRINTERSCANNERPHOTOCOPIERTV_SCREENPAPERBOARDTWENTY_FOUR_SEVEN_ACCESSLOCKERSUPPLIESPROJECTOR

reservationOptionsobject

contains all reservation options

* Additional properties are NOT allowed.
Show Child Parameters
Example

flexOfficeCoworkingSpaceReservationInformation

object
* Additional properties are NOT allowed.
availableboolean

value that indicates if the reservation is possible

pricenumber

value that indicates the price for the reservation option

>= 0<= 9999999999999

Example:50

Example

flexOfficeCoworkingEquipment

object
* Additional properties are NOT allowed.
isPaidboolean

values that indicate whether or not the use of the equipment is charged

typestring

values that indicate the type of the equipment

Allowed values:DISABLED_ACCESSMAIL_RECEPTIONBUSINESS_ADDRESS_SERVICERECEPTIONISTSHOPSECURITY_GUARDACCESS_BADGEPRIVATE_LOCKERAIR_CONDITIONINGCLEANING_SERVICEPARKINGBIKE_STORAGEBREAK_ROOMKITCHENCAFETERIAHOT_DRINKSHIGH_SPEED_INTERNETPRINTERSCANNERPHOTOCOPIERPHONE_BOOTHSTV_SCREENOTHER_SERVICESOUTDOOR_SPACEGYMBACKGROUND_MUSICBARBER_HAIRDRESSERMICROWAVEREFRIGERATORDAYCAREPETS_ALLOWEDSHOWERFRUITS_AVAILABLEDISHWASHERWAITING_AREANEWSPAPERS

Example