View Source

Interface IApiDocumentUrlService

Defines a service that retrieves document information by URL route for the Delivery API.

Namespace: Umbraco.Cms.Core.DeliveryApi
Assembly: Umbraco.Core.dll
Syntax
public interface IApiDocumentUrlService

Methods

View Source

GetDocumentKeyByRoute(string, string?, bool)

Gets the document key (unique identifier) for the specified route.

Declaration
Guid? GetDocumentKeyByRoute(string route, string? culture, bool preview)
Parameters
Type Name Description
string route

The URL route to look up.
string culture

The culture to use for the lookup, or null for the default culture.
bool preview

Whether to include unpublished preview content in the lookup.
Returns
Type Description
Guid?

The document key if found, or null if no document exists at the specified route.