Entities, Enums and Constants

Entities

VirtualTour

Parameter
Type
Meaning
idIDVirtualTour internal identifier.
createdDateDate of creation in Unix format.
modifiedDateDate of modificatoin in Unix format.
nameStringName of the tour.
itemIDIDThe ID associated with the item connected to this tour.
agentIDIDThe ID associated with the agent connected to this tour.
userUserThe user(id, email) if use scope USER_SNIPPET.
limitedAccessBooleanDefines whether the whole tour has limited access (needs registration to visit the images) or not.
grantAccessAutomaticallyBooleanDefines whether the potential buyers, after registration, are going to be accepted automatically or not.
statusIntegerTour status
externalIDStringThe expose external ID where the tour is connected to.
panoramasList<Panorama>The list of images associated with this tour.
integrationLinksIntegrationLinksLinks for integration (or embedding) purpose
addressAddressThe address if use scope address.
utcIntegercustomer UTC zone.
mapsMap<Integer, Floorplan>List of Floorplans related to each floor number
scopeOfWorkVersionStringThe version of scope of work

Floorplan

Parameter
Type
Meaning
nameStringName Of the Floor
hotspotsList<Hotspot>List of Hotspots set on this Floorplan

Panorama

Parameter
Type
Meaning
idStringThe id for panorama
filenameStringName of the uploaded file associated with this panorama,
fileUrls{[key in FileTypeEnum]:String}The object which key is type of file and string is url to this file.
nameStringName of the panorama.
planIntegerFloor number of the panorama.
limitedAccessBooleanDefines the access (if it needs registration or not) to this panorama.
fileWidthInteger
fileHeightInteger
isFirstBooleanDefine whether this panorama is the first which will appear for this floor or not (when a new floor is selected, one floor has to be selected by default as the first).
statusStatusPanoramaEnum

Status for Panorama

hotspotListList of Hotspots: Links in every panorama with other panoramas in a specified position.
externalIDStringexternalID of the the panorama to synchronize with external service
typePanoramaTypeEnumType of panorama

Hotspot

Parameter
Type
Meaning
filenamePanoramaStringName of the associated panorama to this position
namePanoramaStringName of the panorama.
hotspotHPosFloatThe horizontal position where the linked panorama will be displayed.
hotspotVPosFloatThe verttical position where the linked panorama will be displayed.

Item

Parameter
Type
Meaning
idIDItem internal identifier
createdDateDate of creation in Unix format
modifiedDateDate of modificatoin in Unix format
userIdIDThe ID associated with the user connected to this item.
panoIDIDThe ID associated with the tour connected to this item.
agentIDIDThe ID associated with the responsible agent
realExternalIDStringThe expose external ID where the item is connected to.
internalIDLongClipnow internalID. This id has 7 characters
externalIDStringThe realExternalID, cleaned out any character which does not match a-z, A-Z, 0-9 or _
inputsList<PortalInput>List of PortalInput entities, which defines from which portals the item has been obtained or linked.
outputsList<PortalOutput>List of PortalOutput entities, which defines in which portals the item is integrated.
fullErrorStringIn case there is an error on the item, here it will be displayed.
tourVirtualTourThe tour connected to this item.
metadataItemMetadataSummaryThe metadata of this item.
statusIntegerItem status
integrationLinksIntegrationLinksLinks for integration (or embedding) purpose

PortalInput

Parameter
Type
Meaning
portalTypeEnumThe portal associated with this input.
objectIDStringThe expose internal ID (from the point of view of the portal) where the input is connected to.
externalIDStringThe expose external ID (from the point of view of the portal) where the input is connected to.
statusIntegerThe status of the input
statusActionIntegerThe status of the last action performed.
statusPortalIntegerThe status of the expose in the portal (visibility in the portal).

PortalOutput

Parameter
Type
Meaning
portalTypeEnumThe portal associated with this output.
actionEnumWhich Entities, Enums and Constants#action we perform in the portal portalType for this output.
statusIntegerThe status of the output
statusActionIntegerThe status of the action performed.
fullErrorStringIn case there is an error on the output integration, here it will be displayed.

ItemMetadataSummary

Parameter
Type
Meaning
titleStringTitle of the expose in the portal
imagesList<Image>List of images in the expose
urlStringImage url
hashStringImage MD5
descriptionStringImage description

User

Parameter
Type
Meaning
idIDUser internal identifier
createdDateDate of creation in Unix format
modifiedDateDate of modificatoin in Unix format
emailStringThe email of the user
identityStringThe identity of the user. This identity String is user in several places.
nameStringThe user name.
langENUMThe user predefined Language. The language code is the code in the ISO 639-1
bucketStringThe S3 bucket for the user.
folderStringThe S3 folder for that user.
statusIntegerThe status of the user.
emailValidatedBoolean
  • false = User did not validate the email address (he needs to click in a verification mail sent to him).
  • true = User validated the email address.


professionalSphereStringCustomer profession sphere (available values INSPECTION, RESTORATION)
contactsList<ContactData>User's contacts
parentIdIDidentity of the parent user
officeEmailStringThe email of the root user (office)
floorplanOrderConfigObjectorderConfig of the user. 

FloorplanOrderConfig

Parameter
TypeFormat
Meaning
estimateAvailableBooleanoptionalshows the availability of the estimate feature 

Agent

Parameter
Type
Meaning
idIDAgent internal identifier
contactDetails

ContactData

The contact data associated with the agent

ContactData

Parameter
Type
Meaning
firstNameStringFirst name of the contact
lastNameStringSurname of the contact
contactEMailStringEmail of the contact
genderEnum

The gender of the contact.

  • NO_GENDER

  • MALE

  • FEMALE
contactFaxStringFax of the contact
contactCellPhoneStringCell phone of the contact
contactPhoneStringPhone of the contact
contactLocationStringContact locatoin (cty ZIP)
cityStringCity of the contact
contactStreetStringStreet of the contact
companyNameStringName of the contact's company
companyUrlStringURL of the contact's company
companyIdStringID of the contact's company
zipCodeStringZIP code of the contact
contactImageUrlStringURL of the contact's image
infoStringextra info field
langEnumThe user predefined Language. The language code is the code in the ISO 639-1
portalEnumThe portal associated with the contact

TourAttachmentAPI

Parameter
Type
Meaning
IDStringinternal ID to access in the future that attachment
xPosDoublehorizontal coordinate for the positoin of the attachment in the image
yPosDoublevertical coordinate for the position of the attachment in the image
nameStringname of the attachment
descriptionStringDescription of the attachment
attachmentTypeEnumType of attachment
linkedRoomStringfilename of the linked Room (in case of hotspots)
urlStringURL for the media attachment
externalIDStringexternal ID of the attachment to synchronize with external service

TourAttachmentAPI.Post

Parameter
Type
Meaning
xPosDoublehorizontal coordinate for the positoin of the attachment in the image
yPosDoublevertical coordinate for the position of the attachment in the image
nameStringname of the attachment
descriptionStringDescription of the attachment
attachmentTypeEnumType of attachment
linkedRoomStringfilename of the existing room this point should link to (only used in case AttachmentTyp == HOSTPOT)
urlStringwebURL this infopoint should link to
externalIDStringexternal ID of the attachment to synchronize with external service
Parameter
Meaning
pdf
Direct link to the pdf generated for the tour
qrCodeDirect link to the qrCode generated for the tour (256x256).
iframeA blank website which only contains a tour player (useful for iframe integration in your own website)
landingThe URL to the landing page (provided by Clipnow)

Hotspot

Parameter
Type
Meaning
idIDUser internal identifier

Address

Parameter
Type
Meaning
streetStringStreet
houseNumberStringHouse Number
floorStringFloor number
postcodeStringPostcode
cityStringCity
coordinatesCoordinatesCoordinates of object
countryStringCountry code. Default value "DE".
regionStringRegion
quarterStringQuarter
showPreciseBooleanDefines whether show precise or doesn't.
apartmentStringApartment
addressConfidentialBooleanDefines whether Address is Confidential or isn't.

Coordinates

Parameter
Type
Meaning
fromMapsAPIBooleanDefines whether coordinates are from Maps API or aren't.
latitudeDoubleLatitude
longitudeDoubleLongitude

Constants

StatusPanoramaEnum

ValueMeaning
1active
2inactive

status (common)

Value
Meaning
1active
2inactive
3deleted
4not updatable
5hidden
6incomplete

status (portal)

Value
Meaning
1online
2offline
3private

status (action)

Value
Meaning
1succeed
2failed
0running

status (panorama)

Value
Meaning
1processed
2failed_move
3failed_other

Enums

PortalType

Parameter
IMMOBILIENSCOUT24
IMMONET
IMMOWELT
LANDING

AttachmentType

Parameter
HOTSPOT
VIDEO
IMAGE

TEXT

PDF
EMBED_URL
FRONT_VIEW

Action

Parameter
POST
VIDEO
VIRTUAL_TOUR
EXPOSE

PanoramaTypeEnum

Parameter
PANORAMA
TURNTABLE
STILL
MERGE_PLACEHOLDER



linkedRoom