Page Comparison

Tip
Available from CRM.COM R15.0.0

Excerpt
This method returns the portal settings (i.e. portal logo and theme) information

Resource URL

Parameters

Name	Type	Description
token	String	The token retrieved from the login method. The supported options are
fields_set (optional)	List of Strings, comma separated	A list of fields that should be included in the results. If not specified then all the available fields will be returned

Response Data

Include Page

	V4:portal_settings_complete
	V4:portal_settings_complete

Examples

Expand

title	Example 1

HTTP Method: GET

Request

Response

Code Block

theme	Confluence
language	js
linenumbers	true

 {
    "data": {
        "portal_logo": {
            "file_name": "1_key_portal-logo_CRM_Logo_Portal.jpg",
            "file_content_url": "/crm/ImageDownloadServlet?id=1&filename=key_portal_logo",
            "file_mime_type": "image/jpeg"
        },
        "portal_theme": "theme-blue"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Note

To retrieve or display the actual image you need to construct the following URL

Code Block

language	xml

{{server}}{{file_content_url}}&token={{token}}

for example

Code Block

language	xml

https://r15qa.crm.com/crm/ImageDownloadServlet?id=1&token=B18ECEE5918442A0A29B7C1B2D0A4260

Versions Compared

Old Version 1

New Version Current

Key

Resource URL

Parameters

Response Data

Examples