Websydian v6.1 online documentationOnline documentation - WebsydianExpress v3.5

API: GetServiceURLForSite

Scoped Name

APIServer.WebServices.GetServiceURLForSite

Interface

Field Variable ...as Description
ServiceURLMask Position Input The URL Mask (extension) specified for the URL element.

This value is used for positioning.

Sitekey Position Input The unique identification of the site.

This value is used to restrict the output.

Position Control Input Controls whether the information in the Position variable is used to position the output.
RowsFetched Control Input Dual field that specifies how many rows that is written to the FetchedData output variable.
ServiceURLSurrogate FetchedData(64) Output The unique identification of the URL element that is defined for the site.
ActiveStatus FetchedData(64) Output Specifies whether the services offered by the URL are publicly available. If the ActiveStatus is Active, the services are available, if the ActiveStatus is Inactive, the services are not available.
IntranetOnly FetchedData(64) Output Specifies whether the services specified for the URL are available for clients outside the specified intranet.
ServiceURLDescription FetchedData(64) Output The description/name specified for the URL in the service structure.
ServiceURLMask FetchedData(64) Output The URL mask specified for the URL element.
ServiceURLTemporaryFolder FetchedData(64) Output The temporary folder specified for the URL element. The temporary folder is an extension of the temporary folder specified in the global setting "Temp file location".
SiteKey FetchedData(64) Output The unique identification of the site the URL element belongs to.
Comment FetchedData(64) Output The comment specified for the URL element.

Description

The API has the behavior of a normal Plex BlockFetch function.

This API retrieves a list of the URL elements that has been specified for a site.

You can use this information if you create a callback function for the FindServiceProcessor callback point.

If you need information about the service processor specified for the URL element, you can call the GetURLAndServiceProcessor API.

Events

Universal events