Properties (Property Management)

You can use REST API calls to obtain information about the properties you have been authenticated to manage as well as to update details about these properties.

The following table lists the properties that can be used in the body of a property management-related request and/or are provided in the response body. (In the "Optional" column, if a default value is applicable, it is listed in angle brackets (< >).)

Resource: Properties

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
guid String No orderBy, like Optional on create only, but not on any subsequent uses. The unique identifier for this property.
name String No orderBy, like No The display name for this property, must be unique
address String No orderBy, like Yes The address for this property.
description String No orderBy, like Yes A description for this property.
enforceMaxUnits Boolean No orderBy, like Yes<false> Indicates if a value configured for "max units" will be enforced when adding a unit to the property.
maxUnits int No orderBy, like No<0> The maximum number of units permitted for this property.
allowSeparateGuestSecret Boolean No orderBy, like Yes<true> Indicates whether units asigned to this property will have a separate secret for a separate guest network. This value may not be changed once the first unit is assigned to this property.
ssids Array<String> No No Yes This is the list of ssids that are available to this property by means of the DPSK pool that this property is assigned to.
managementName String No orderBy, like Yes Name that will be assigned in all email and SMS communications.
managementPhone String No orderBy, like Yes Phone that will be assigned in all email and SMS communications.
managementEmail String No orderBy, like Yes Email that will be assigned in all email and SMS communications
tenantPortalHelpText String Yes if permitted by access controls Neither Yes Help text that will be provided to users of the tenant portal.
tenantPortalAnnouncements String Yes if permitted by access controls Neither Yes Announcements that will be provided to users of the tenant portal.
sendEmail
added this for property management section for 5.9R3 (didn't have it) - and also the table entries from here down to the "links" entry
 Boolean Yes Neither Yes<true> Indicates that email will be sent to tenants when there are changes on a unit.
sendSms Boolean Yes Neither Yes<true> Indicates that SMS will be sent to tenants when there are changes on a unit.
smsPassphraseChange String Yes Neither Yes

If enabled, this is the SMS text that gets sent to the unit owner when the passphrase or guest passphrase is changed. Users are responsible for creating text correctly if they are using the guest passphrase or the tenant portal.

what "guidelines" about creating text correctly? What are we warning them about?
The following variables are used to substitute the passphrases and the portal URL in all cases:

${PROPERTY_NAME} , ${UNIT_PASSPHRASE}, ${GUEST_PASSPHRASE}, ${UNIT_PORTAL_URL}, ${UNIT_MANAGER}, ${UNIT_CONTACT_NAME}

what exactly happens with the portal URL?

emailPassphraseSubject String Yes Neither Yes If set, this is the subject for the email that gets sent to the unit owner when either the passphrase or guest passphrase for a unit is changed.
emailPassphraseChange String Yes Neither Yes

If set, this is the email text that will be sent to the unit owner when the passphrase or guest passphrase is changed. Users are responsible for creating text correctly if they are using the guest passphrase or the tenant portal. The following variables are used to substitute the passphrases and the portal URL in all cases:

${PROPERTY_NAME} , ${UNIT_PASSPHRASE}, ${GUEST_PASSPHRASE}, ${UNIT_PORTAL_URL}, ${UNIT_MANAGER}, ${UNIT_CONTACT_NAME}
smsAssigedUnit String Yes Neither Yes

If set, this is the SMS text that gets sent to the unit owner when a unit is created. Users are responsible for creating text correctly if they are using the guest passphrase or the tenant portal. The following variables are used to substitute the passphrases and the portal URL in all cases:

${PROPERTY_NAME} , ${UNIT_PASSPHRASE}, ${GUEST_PASSPHRASE}, ${UNIT_PORTAL_URL}, ${UNIT_MANAGER}, ${UNIT_CONTACT_NAME}
emailAssignedUnitSubject String Yes Neither Yes If set, this is the subject for the email that gets sent to the unit owner when they are assigned a unit.
emailAssignedUnit String Yes Neither Yes

If set, this is the email text that will be sent to the unit owner when a unit is created. Users are responsible for creating text correctly if they are using the guest passphrase or the tenant portal. The following variables are used to substitute the passphrases and the portal URL in all cases:

${PROPERTY_NAME} , ${UNIT_PASSPHRASE}, ${GUEST_PASSPHRASE}, ${UNIT_PORTAL_URL}, ${UNIT_MANAGER}, ${UNIT_CONTACT_NAME}
usingNetworkSegmentation
new for 5.9r3
 Boolean No No Yes True if the property is configured to use network segmentation; false otherwise.
links Link No No Yes Self referencing link, a link to the management portal and link to the list of units associated with this property.

Resource: UiConfiguration

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
tenantTitle String No No Yes The title to use in the management portal UI.
tenantSubtitle String No No Yes The subtitle to use in the management portal UI.
apiAllowed
this name is different in the wiki, but I went with the repsonse I got from running the API
 Boolean Yes No Yes<true> Indicates if access is permitted to the tenant API.
portalAllowed Boolean Yes No Yes<true> Indicates if access is permitted to the tenant portal. The "apiAllowed" property must be enabled for this to be true.
updated this accordingly from the prior comment; wiki should be updated too
tenantSetDpsk
new for 5.9R3 - don't believe I saw it in wiki though
 Boolean
what value here?
what value here?
what value here?
 Indicates if the tenant can manually set the wifi passphrase on the tenant portal to a specific desired value.
Shannon is this correct?
emailTextResetAuth String Yes No Yes

If set, this is the email text that gets sent to the unit owner when the tenant portal authentication token is reset. The user is responsible for creating text correctly and can use the following variables to substitute the passphrases and the tenant portal URL in all cases:

${PROPERTY_NAME} , ${UNIT_PASSPHRASE}, ${GUEST_PASSPHRASE}, ${UNIT_PORTAL_URL}, ${UNIT_MANAGER}, ${UNIT_CONTACT_NAME}
emailSubjectResetAuth String Yes No Yes If set, this is the email subject that gets sent to the unit owner when the tenant portal authentication token is reset.
smsTextResetAuth String Yes No Yes

If set, this is the SMS message that gets sent to the unit owner when the tenant portal authentication token is reset. The user is responsible for creating text correctly and can use the following variables to substitute the passphrases and the tenant portal URL in all cases:

${PROPERTY_NAME} , ${UNIT_PASSPHRASE}, ${GUEST_PASSPHRASE}, ${UNIT_PORTAL_URL}, ${UNIT_MANAGER}, ${UNIT_CONTACT_NAME}
loginText String No No Yes Text to display when logging in to the management portal UI.
mainColor String No No Yes The main color is used for the main header and any buttons or links. White text will be used on top of this color.
accentColor String No No Yes The accent color is used for sub-headers and borders.
separatorColor String No No Yes The separator color is used for lines in between rows of data.
textColor String No No Yes The text color is the default text color used to display information throughout the portal.
logoFileName String No No Yes The name of the logo file, if one has been uploaded. This will be updated when the logo file is changed via the logo file link. The logo is placed on top of a background the same color as the color of the mainColor property.
iconFileName String No No Yes The name of the icon file, if one has been uploaded. This will be updated when the icon file is changed via the icon file link.
links Link No No Yes logoFile, favicon, self, and parent (management portal)

Management Portal URIs and Actions

URI Action Description Return Codes
/propertyMgmtPortals/{portalGuid}/properties GET Returns the list of Properties that this authenticated user can manage.

401 - Unauthorized

200 - OK

/propertyMgmtPortals/{portalGuid}/properties/{propertyGuid} PUT

Updates details about the specified property. The changes are permitted only on tenantPortalHelpText and tenantPortalAnnouncements, and only if the access control configuration for this management portal allows these to be set.

If the change requested is NOT permitted by access controls, a "403 - Forbidden" code is returned.

403 - Forbidden

404 - Not Found

401 - Unauthorized

200 - OK

GET Returns information about the specified property.

404 - Not Found

401 - Unauthorized

200 - OK

/propertyMgmtPortals/{portalGuid}/properties/{guid}/uiConfiguration GET

Returns the UI configuration information for the specified property.

404 - Not Found

401 - Unauthorized

200 - OK

/propertyMgmtPortals/{portalGuid}/properties/{guid}/uiConfiguration/logoFile GET Returns the logo file as an image file. The response includes the file type.

404 - Not Found

401 - Unauthorized

200 - OK

/propertyMgmntPortals/{portalGuid}/properties/{guid}/uiConfiguration/favicon GET The custom icon is returned, if one has been assigned. Otherwise, the default icon is returned.

404 - Not Found

401 - Unauthorized

200 - OK

Example of Using GET for Management Portal Properties

This example demonstrates how to obtain a list of properties that the user is authenticated to manage.

URI:

This example uses the following URI:

example below updated for 5.9R3 to show the new network segmentation boolean property

 https://Jeff245.cloudpath.net/admin/rest/propertyMgmtPortals/MduPortalAccess-62e5f7e6-010e-46ff-91c9-4e71b6168159/properties

where:

  • https://Jeff245.cloudpath.net/admin/rest/propertyMgmtPortals is the root URI (must include https, as shown).
  • MduPortalAccess-62e5f7e6-010e-46ff-91c9-4e71b6168159 is the GUID of the management portal.

Request Headers:

The following table shows the required request headers for this URI example, with an example value of an active token that must be pasted into the Authorization header value:

Request Headers

Key Value
Content-type application/json
Authorization eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJMYWtlIFZpZXcgQXBhcnRtZW50cyBNYW5hZ2VtZW50IFBvcnRhbCIsInBvcnRhbEd1aWQiOiJNZHVQb3J0YWxBY2Nlc3MtNzkyOTNhMzMtMjYyYy00MTViLThmMGMtOThlYmMwMWViNTAzIiwiYWNjb3VudFBrIjoiMSIsInVzZXJFbWFpbCI6ImplZmYucmhvZGllQGNvbW1zY29wZS5jb20iLCJwb3J0YWxTZWNyZXQiOiJzZWNyZXQiLCJpYXQiOjE2Mjg5MDcwOTQsImV4cCI6MTYyODkwNzM5NH0.F_h48OPwUI_F1KDFNpz8zFM1qQzbxyG5KrLyc7HR7IE

Request Body:

None required.

Action:

Use the GET action to send the request.

Response Body:

Once the request is sent, you will receive a "Status: 200 OK" if the GET is successful. The response body provides information about the property or properties the user is authenticated to manage within the specified property management portal. In this example, "Tech Pubs Building 1" is the only property that Sushma A can manage. Also, the property is configured as part of a network segmentation group, as shown in the response for the boolean property: "usingNetworkSegmentation": true 

{
    "page": {
        "page": 1,
        "pageSize": 1,
        "totalCount": 1
    },
    "contents": [
        {
            "guid": "Property-40ac7e72-97ed-4567-a180-7d20967c5a72",
            "name": "Tech Pubs Building 1 ",
            "address": "001 Tech Pubs Road\r\nLake Town, CA",
            "description": "",
            "enforceMaxUnits": false,
            "maxUnits": 0,
            "allowSeparateGuestSecret": true,
            "ssids": [
                "Jeff eDPSK"
            ],
            "managementName": "Sushma A",
            "managementPhone": "0005550200",
            "managementEmail": "sushma@commscope.com",
            "tenantPortalHelpText": "",
            "tenantPortalAnnouncements": "",
            "sendEmail": true,
            "sendSms": true,
            "smsPassphraseChange": null,
            "emailPassphraseSubject": null,
            "emailPassphraseChange": null,
            "smsAssignedUnit": null,
            "emailAssignedUnitSubject": null,
            "emailAssignedUnit": null,
            "usingNetworkSegmentation": true,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/rest/propertyMgmtPortals/MduPortalAccess-62e5f7e6-010e-46ff-91c9-4e71b6168159/properties/Property-40ac7e72-97ed-4567-a180-7d20967c5a72",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "units",
                    "href": "https://jeff245.cloudpath.net/admin/rest/propertyMgmtPortals/MduPortalAccess-62e5f7e6-010e-46ff-91c9-4e71b6168159/properties/Property-40ac7e72-97ed-4567-a180-7d20967c5a72/units?page=1&pageSize=10{&filter,orderBy}",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "mgmtPortal",
                    "href": "https://jeff245.cloudpath.net/admin/rest/propertyMgmtPortals/MduPortalAccess-62e5f7e6-010e-46ff-91c9-4e71b6168159",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}

Parent topic: Property Management APIs