Skip to main content

IGuideDetails

iGUIDE resource.

aliasstring
attrs object
property name*any
createdAtstring

The time the iGUIDE was created. Only populated when reading a single iGUIDE.

editorsstring[]
editorsPublicstring[]
idstring
images object[]
  • Array [
  • namestring
    Example: gallery_front.jpg
  • ]
  • licenseestring
    managerstring
    previewStatusstring
    primaryContactstring
    primaryContactPublicstring
    property object

    Property an iGUIDE belongs to.

    apartmentinteger
    buildingClientIdstring
    buildingIdstring
    buildingNamestring
    buildingTypestring
    citystring
    codestring
    countrystring
    housestring
    idstring
    noAddressboolean
    provincestring
    streetstring
    unitstring
    propertyIndustrystring
    typestring
    views object[]

    A summary of the iGUIDE's views. An iGUIDE always has at least its default view, so this is non-empty when present. Only populated (and serialized) when reading a single iGUIDE.

  • Array [
  • bannerIdstring

    The public ID of the banner applied to this View, if any.

    expiresAtstring

    The expiration date of the View in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ)

    idstring

    The View ID.

    isDefaultboolean

    Indicates if the View is the default View or not.

    isLockedboolean

    Indicates if the View is locked (its expiration date has passed).

    titlestring

    The View title.

  • ]
  • zeroedOutAtstring
    IGuideDetails
    {
    "alias": "string",
    "attrs": {},
    "createdAt": "string",
    "editors": [
    "string"
    ],
    "editorsPublic": [
    "string"
    ],
    "id": "string",
    "images": [
    {
    "name": "gallery_front.jpg"
    }
    ],
    "licensee": "string",
    "manager": "string",
    "previewStatus": "string",
    "primaryContact": "string",
    "primaryContactPublic": "string",
    "property": {
    "apartment": 0,
    "buildingClientId": "string",
    "buildingId": "string",
    "buildingName": "string",
    "buildingType": "string",
    "city": "string",
    "code": "string",
    "country": "string",
    "house": "string",
    "id": "string",
    "noAddress": true,
    "province": "string",
    "street": "string",
    "unit": "string"
    },
    "propertyIndustry": "string",
    "type": "string",
    "views": [
    {
    "bannerId": "string",
    "expiresAt": "string",
    "id": "string",
    "isDefault": true,
    "isLocked": true,
    "title": "string"
    }
    ],
    "zeroedOutAt": "string"
    }