|
|
APIServer.WebServices.GetCriteriaForURL
| Field | Variable | ...as | Description |
|---|---|---|---|
| ServiceURLSurrogate | Position | Input | The unique identification of the URL specified in the service structure. This restricts the retrieval of data. |
| SelectCriteriaSurrogate | Position | Input | The unique identification of the selection criterion that is specified for the URL. This can be used to position the retrieval of data. |
| CriteriaSequence | Position | Input | The sequence of the criterion under the URL. This sequence specifies the order the criteria will be evaluated in. This can be used to position the retrieval of data. |
| Position | Control | Input | Specifies whether the data in the Position variable will be used for positioning. |
| RowsFetched | Control | Dual | The number of rows retrieved by the API. |
| ServiceURLSurrogate | FetchedData(64) | Output | The unique identification of the URL specified in the service structure. |
| SelectCriteriaSurrogate | FetchedData(64) | Output | The unique identification of the selection criterion that is specified for the URL. |
| CriteriaSequence | FetchedData(64) | Output | The sequence of the criterion under the URL. This sequence specifies the order the criteria will be evaluated in. |
| CriteriaName | FetchedData(64) | Output | When you add a specific criterion (for example Http-header,
RequestParameter, Program) to a URL in the service structure, you
will be prompted for a name (for example Http-header name,
RequestParameter name, Program name). This is the name that has
been specified when the selection criterion was added.
This field will be present for all criteria with the SelectCriteriaType NameValue. For the rest of the criteria types, the field will be blank. |
| SelectCriteriaIdentifier | FetchedData(64) | Output | System field specifying whether it is one of the pre-defined selection criteria. |
| SelectCriteriaName | FetchedData(64) | Output | The name of the criterion (e.g. Http-Header, SOAPAction). |
| SelectCriteriaDescription | FetchedData(64) | Output | The description of the criterion. |
| SelectCriteriaType | FetchedData(64) | Output | A field specifying whether you need to specify a name when the
criterion is added to the URL in the service structure.
The possible values are: NameValue (N) and Value (V). For criteria where NameValue is specified, the name will be found in the CriteriaName output field. |
| SelectionCriteriaComment | FetchedData(64) | Output | This is the comment specified for the criterion itself. |
| URLUsesCriteriaComment | FetchedData(64) | Output | This is the comment specified when the criterion was added to the URL. |
You can use this API to retrieve all the criteria that are specified for a URL in the service structure. The functionality is that of a standard Plex BlockFetch function.
You can use this to create your own service processor.
After retrieving one of the criteria that is specified for the URL - and finding the value of the criterion based on the request - you can use the FindOfferedService API to retrieve the service handler that corresponds to the criteria value.
Online documentation - WebsydianExpress v3.5