Portal (Property Management)

You can use REST API calls to obtain information about management portals, to create or edit management portals, and to delete management portals.

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: Management Portal

Property Name	Type	Editable	Sort/Filter	Optional in Request/Response Body?	Description
guid	String	Yes	orderBy, like	Optional on create only, but not on any subsequent uses	The unique identifier for this management portal.
name	String	Yes	orderBy, like	No	The display name for this management portal; must be unique.
description	String	Yes	orderBy, like	Yes	A description for this management portal.
accessSecret	String	Yes	orderBy, like	No	Not provided from this URI..
links self, properties, users, controlConfiguration, uiConfiguration	Link	No	No	Yes	This includes the following href links that can be used in other API calls: self-referencing link link to the controlConfiguration resource link to the uiConfguration resource link to the list of properties associated with this management portal. link to the list of users associated with this management portal.

Resource: ControlConfiguration

Property Name	Type	Editable	Sort/Filter	Optional in Request/Response Body?	Description
createUnit	Boolean	No	Yes	No	Indicates if the user is allowed to create a unit on this property.
deleteUnit	boolean	No	Yes	No	Indicates if the user is allowed to delete a unit on this property
basicUnitProperties	boolean	No	Yes	No	Indicates if the user is allowed to alter the basic unit properties. This includes the names and descriptions of units as well as all the contact information for units.
changeUnitSecrets	boolean	No	Yes	No	Indicates if the user is allowed to reset the wi-fi secret and guest wi-fi secret on units.
resetUnitAuthToken	boolean	No	Yes	No	Indicates if the user is allowed to set the unit state to "TOKEN_RESET", thereby resetting the tenant portal authentication token on units.
alterUnitState	boolean	No	Yes	No	Indicates if the user is allowed to change the basic state of units between ACTIVE/SUSPENDED.
setHelpText	boolean	No	Yes	No	Indicates if the user is allowed to set the help text for the tenant portal displayed for this property.
setAnnouncements	boolean	No	Yes	No	Indicates if the user is allowed to set the announcements for the tenant portal displayed for this property.
links	Link	No	No	Yes	Self referencing link and link to the parent management portal.

Resource: UiConfiguration

Property Name	Type	Editable	Sort/Filter	Optional in Request/Response Body?	Description
title	String	Yes	No	Yes	The title to use in the management portal UI.
subtitle	String	Yes	No	Yes	The subtitle to use in the management portal UI.
loginText	String	Yes	No	Yes	Text to display when logging in to the management portal UI.
mainColor	String	Yes	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	Yes	No	Yes	The accent color is used for sub-headers and borders.
separatorColor	String	Yes	No	Yes	The separator color is used for lines in between rows of data.
textColor	String	Yes	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.
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					logoFile, favicon, self, and parent (management portal)

Management Portal URIs and Actions

The following table indicates the URIs that you can append to the root URI, along with the actions you can take, and possible return codes you can receive.

Management Portal URIs and Actions

URI	Action	Description	Return Codes
/propertyMgmtPortals/{guid}/token	POST	Authenticates the user and returns a valid security token. The body must include the userName and password, as shown in the following format: { "userName":"user@company.com", "password":"portalAccessSecret" } add xref to this topic	401 - Unauthorized 201 - Created
/propertyMgmtPortals/{guid}	GET	Returns information about the specified management portal.	404 - Not Found 401 - Unauthorized 200 - OK
/propertyMgmtPortals/{guid}/controlConfiguration	GET	Returns the control configuration information for the specified management portal. The control configuration specifies which APIs are accessible to users of this portal.	404 - Not Found 401 - Unauthorized 200 - OK
/propertyMgmtPortals/{guid}/uiConfiguration	GET	Returns the UI configuration information for the specified management portal.	404 - Not Found 401 - Unauthorized 200 - OK

/propertyMgmtPortals/{guid}/uiConfiguration/styles	GET	An unauthenticated endpoint that returns a css detailing the style settings for the management portal. mediaType= "text/css"	200- OK 404 - Not Found
/propertyMgmtPortals/{guid}/uiConfiguration/access	GET	An unauthenticated endpoint that returns access resource data that can be displayed without authentication. The resource returned contains the login text desired for this portal.	200- OK 404 - Not Found
/propertyMgmtPortals/{guid}/uiConfiguration/logoFile	GET	Returns the logo file as an image file to be used for the management portal. The response includes the file type.	404 - Not Found 401 - Unauthorized 200 - OK
/propertyMgmtPortals/{guid}/uiConfiguration/favicon	GET	An unauthenticated endpoint returns an image to be used for the management portal favicon. If no favicon is configured or the user is not authenticated, or if API access is disabled, the default favicon will be returned.	401 - Unauthorized 200 - OK

Example of Using GET for a Property Management API

This example demonstrates how to obtain a listing of a management portal that has already been created in the Cloudpath UI.

URI:

This example uses the following URI:

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

where:

https://Jeff245.cloudpath.net/admin/rest/propertyMgmtPortals is the root URI of the Cloudpath system being used (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 specified management portal in your Cloudpath system. In this example, "Lake View Apartments Management Portal" is the management portal. The information in the response body will match the configuration of Lake View Apartments Management Portal as specified in the UI. Any values that were not specified in the UI are the default values.

{
    "guid": "MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503",
    "name": "Lake View Apartments Management Portal",
    "description": "",
    "accessSecret": null,
    "links": [
        {
            "rel": "self",
            "href": "https://jeff245.cloudpath.net/admin/rest/propertyMgmtPortals/MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        },
        {
            "rel": "property",
            "href": "https://jeff245.cloudpath.net/admin/rest/propertyMgmtPortals/MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503/properties?page=1&pageSize=10{&filter,orderBy}",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        },
        {
            "rel": "uiConfiguration",
            "href": "https://jeff245.cloudpath.net/admin/rest/propertyMgmtPortals/MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503/uiConfiguration",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        },
        {
            "rel": "controlConfiguration",
            "href": "https://jeff245.cloudpath.net/admin/rest/propertyMgmtPortals/MduPortalAccess-79293a33-262c-415b-8f0c-98ebc01eb503/controlConfiguration",
            "hreflang": null,
            "media": null,
            "title": null,
            "type": null,
            "deprecation": null
        }
    ]
}

Cloudpath Enrollment System REST API User Guide, 5.9R4 800-73101-001 Rev A

Portal (Property Management)

Resource: Management Portal

Resource: ControlConfiguration

Resource: UiConfiguration

Management Portal URIs and Actions

Management Portal URIs and Actions

Example of Using GET for a Property Management API

Request Headers