|
|
APIServer.WebServices.FindOfferedService
| Field | Variable | ...as | Description |
|---|---|---|---|
| ServiceURLSurrogate | FetchKey | Input | The unique identification of the URL element specified in the service structure. |
| CriteriaSequence | FetchKey | Input | The sequence of the criteron under the URL. This sequence specifies the order the criteria will be evaluated in. |
| CriteriaValue | FetchKey | Input | The value of the specified criterion. |
| ServiceHandlerSurrogate | FetchedData | Output | The unique identification of the service handler to call when a request with the specified criterion is received for the URL specified by the ServiceURLSurrogate input field. |
| OfferedServiceComment | FetchedData | Output | This is the comment you have the option of specifying when a service is added to a criterion in the service structure. |
| ServiceHandlerProgram | FetchedData | Output | The implementation name of the service handler that is specified for the combination of URL element, criterion, and criterion value. |
| ServiceHandlerName | FetchedData | Output | The descriptive name of the service handler. |
| SaveFiles | FetchedData | Output | Specifies whether temporary files will be saved for the handler. This is used in combination with the global parameter request log. If the request log is enabled, the temporary files are always saved. If the request log is disabled, the temporary files are deleted unless this field is set to yes. |
| WSDLOperationName | FetchedData | Output | The name used for the operation that corresponds to the service handler in any WSDL's generated by the system. |
| ServiceHandlerComment | FetchedData | Output | The comment specified for the service handler itself. |
This API gives you the ability to find a suitable handler to call based on the service structure provided you know which URL (specified by the ServiceURLSurrogate) the request was aimed at and you know which criterion you are currently evaluating.
This API can be used if you want to build your own service processor. The service processor will have received the ServiceURLSurrogate as an input, while the criteria specified for the processor can be retrieved by the GetCriteriaForURL API.
How the criteria value is retrieved from the request is of course dependent on the type of the criterion. The retrieval of the standard criteria delivered with WebsydianExpress is handled by the abstract ServiceProcessor function, so if you inherit from this function, you will only have to retrieve any custom criteria you might have created yourself.
The API returns information about the service handler that corresponds to the criterion.
Online documentation - WebsydianExpress v3.0