Table 3 defines the parameters for the Service.
Table 3 – FindServers Service Parameters
Name |
Type |
Description |
Request |
|
|
requestHeader |
RequestHeader |
Common request parameters. The authenticationToken is always null. The authenticationToken shall be ignored if it is provided. The type RequestHeader is defined in 7.33. |
endpointUrl |
String |
The network address that the Client used to access the DiscoveryEndpoint. The Server uses this information for diagnostics and to determine what URLs to return in the response. The Server should return a suitable default URL if it does not recognize the HostName in the URL. |
localeIds [] |
LocaleId |
List of locales to use. The Server should return the applicationName in the ApplicationDescription defined in 7.2 using one of the locales specified. If the Server supports more than one of the requested locales then the Server shall use the locale that appears first in this list. If the Server does not support any of the requested locales it chooses an appropriate default locale. The Server chooses an appropriate default locale if this list is empty. |
serverUris [] |
String |
List of Servers to return. All known Servers are returned if the list is empty. A serverUri matches the applicationUri from the ApplicationDescription defined in 7.2. |
|
|
|
Response |
|
|
responseHeader |
ResponseHeader |
Common response parameters. The ResponseHeader type is defined in 7.34. |
servers [] |
ApplicationDescription |
List of Servers that meet criteria specified in the request. This list is empty if no Servers meet the criteria. The ApplicationDescription type is defined in 7.2. |