RESTServiceHelper Class

Provides utility methods for REST.

Inheritance Hierarchy

System.Object
  CMS.Base.CoreMethods
    CMS.Base.AbstractHelper
      CMS.Base.AbstractHelper<RESTServiceHelper>
        CMS.WebServices.RESTServiceHelper

Namespace: CMS.WebServices
Assembly: CMS.WebServices (in CMS.WebServices.dll) Version: 13.0.131

Syntax

public class RESTServiceHelper : AbstractHelper<RESTServiceHelper>

The RESTServiceHelper type exposes the following members.

Constructors

	Name	Description
Public method	RESTServiceHelper

Methods

	Name	Description
Public method Static member	GetUrlPathAndQueryHash	Returns hash string to be used for given URL path and query instead of authentication.
Protected method	GetUrlPathAndQueryHashInternal	Returns hash string to be used for given URL path and query instead of authentication.
Public method Static member	IsUrlPathAndQueryHashValid	Tests whether hash computed for pathAndQuery matches expectedHash.
Protected method	IsUrlPathAndQueryHashValidInternal	Tests whether hash computed for pathAndQuery matches expectedHash. Validates hash expiration query parameter hashExpirationUtc if provided.
Public method	SetAsDefaultHelper	Sets this object as the default helper (Inherited from AbstractHelper<HelperType>.)
Public method Static member Code example	TryParseRestUrlPath	Tries to parse an absolute URL of a REST service endpoint and splits the absolute path to absolute path prefix and relative REST path.
Protected method Code example	TryParseRestUrlPathInternal	Tries to parse an absolute URL of a REST service endpoint and splits the absolute path to absolute path prefix and relative REST path.