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
same as for Core ES Properties?

Property Name	Type	Editable	Sort/Filter	Optional in Request/Response Body?	Description
guid	String	No	sortBy, like	Optional on create only, but not on any subsequent uses.	The unique identifier for this property.
name	String	No	sortBy, like	No	The display name for this property, must be unique
address	String	No	sortBy, like	Yes	The address for this property.
description	String	No	sortBy, like	Yes	A description for this property.
enforceMaxUnits	Boolean	No	sortBy, like	Yes<false>	Indicates if a value configured for "max units" will be enforced when adding a unit to the property.
maxUnits	int	No	sortBy, like	No<0>	The maximum number of units permitted for this property.
allowSeparateGuestSecret	Boolean	No	sortBy, 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	sortBy, like	Yes	Name that will be assigned in all email and SMS communications.
managementPhone	String	No	sortBy, like	Yes	Phone that will be assigned in all email and SMS communications.
managementEmail	String	No	sortBy, 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.
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
same as for Core ES Mgmt portal?

Property Name	Type	Editable	Sort/Filter	Optional in Request/Response Body?	Description
title	String	No	No	Yes	The title to use in the management portal UI.
subtitle	String	No	No	Yes	The subtitle to use in the management portal UI.
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
/propertyMgmtPortals/{portalGuid}/properties/{propertyGuid}	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:

 https://Jeff245.cloudpath.net/admin/rest/propertyMgmtPortals/MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503/properties

where:

https://Jeff245.cloudpath.net/admin/rest/propertyMgmtPortals is the root URI (must include https, as shown).

MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503 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 properties the user is authenticate to manage within the specified management portal. In this example, "Lake View Apartments Management Portal" is the management portal, and the properties are "Building 1" and "Building 2" that J. Smith can manage.

{
    "page": {
        "page": 1,
        "pageSize": 2,
        "totalCount": 2
    },
    "contents": [
        {
            "guid": "Property-c7268d2a-a527-46df-9696-6975424a106b",
            "name": "Building 1",
            "address": "000 Lake View Road Lake Town, MN",
            "description": "",
            "enforceMaxUnits": false,
            "maxUnits": 0,
            "allowSeparateGuestSecret": true,
            "ssids": [
                "ssid1"
            ],
            "managementName": "J. Smith",
            "managementPhone": "0005550100",
            "managementEmail": "js@ltapts.com",
            "tenantPortalHelpText": " ",
            "tenantPortalAnnouncements": "",
            "sendEmail": true,
            "sendSms": true,
            "smsPassphraseChange": null,
            "emailPassphraseSubject": null,
            "emailPassphraseChange": null,
            "smsAssignedUnit": null,
            "emailAssignedUnitSubject": null,
            "emailAssignedUnit": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/rest/propertyMgmtPortals/MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503/properties/Property-c7268d2a-a527-46df-9696-6975424a106b",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "units",
                    "href": "https://jeff245.cloudpath.net/admin/rest/propertyMgmtPortals/MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503/properties/Property-c7268d2a-a527-46df-9696-6975424a106b/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-79293a33-262c-415b-8f0c-98ebc01eb503",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        },
        {
            "guid": "Property-4567d598-5a6d-4847-b9d5-32f7ba34df8d",
            "name": "Building 2",
            "address": "200 Lake View Road Lake Town, MN",
            "description": "",
            "enforceMaxUnits": false,
            "maxUnits": 0,
            "allowSeparateGuestSecret": true,
            "ssids": [
                "ssid2"
            ],
            "managementName": "J. Smith",
            "managementPhone": "0005550100",
            "managementEmail": "js@ltapts.com",
            "tenantPortalHelpText": "",
            "tenantPortalAnnouncements": "",
            "sendEmail": true,
            "sendSms": true,
            "smsPassphraseChange": null,
            "emailPassphraseSubject": null,
            "emailPassphraseChange": null,
            "smsAssignedUnit": null,
            "emailAssignedUnitSubject": null,
            "emailAssignedUnit": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://jeff245.cloudpath.net/admin/rest/propertyMgmtPortals/MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503/properties/Property-4567d598-5a6d-4847-b9d5-32f7ba34df8d",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                },
                {
                    "rel": "units",
                    "href": "https://jeff245.cloudpath.net/admin/rest/propertyMgmtPortals/MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503/properties/Property-4567d598-5a6d-4847-b9d5-32f7ba34df8d/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-79293a33-262c-415b-8f0c-98ebc01eb503",
                    "hreflang": null,
                    "media": null,
                    "title": null,
                    "type": null,
                    "deprecation": null
                }
            ]
        }
    ]
}

Cloudpath Enrollment System REST API User Guide, 5.9 800-73035-001 Rev B