GetUBSitesService
General Purpose
Retrieve information about a local or all databases.
Requirements
Voyager 7.x and higher.
Input Parameters
Parameter | Description | Value | Default | Required |
---|---|---|---|---|
localSitesOnlyFlag | Indicates local database | Y or N | None | No |
Parameters are included in the invoking URL.
Input URL Syntax
This web service can be called by GET or POST methods. If it is called by GET method, then include the parameter in the URL.
Substitute XXXX with the localSitesOnlyFlag (‘Y’ or ‘N’).
http://server:port/vxws/GetUBSitesService?localSitesOnlyFlag=XXXX
Input XML Example
This service expects to receive a ServiceParametersDocument containing the following optional parameter:
- localSitesOnlyFlag – the parameter with expected value of “Y” or “N”. If there is no “localSitesOnlyFlag” parameter, the value defaults to “N”.
Example:
<?xml version="1.0" encoding="UTF-8"?> <ser:serviceParameters xmlns:ser="http://www.endinfosys.com/Voyager/serviceParameters"> <ser:parameters/> </ser:serviceParameters>
Output XML Example
This service will return a VoyagerServiceDataDocument containing a searchResultsType element which in turn contains the list of databases.
Example:
<?xml version="1.0" encoding="UTF-8" ?> <voyagerServiceData xmlns="http://www.endinfosys.com/Voyager/serviceParameters" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <serviceData xsi:type="sear:clustersType" xmlns:sear="http://www.endinfosys.com/Voyager/search"> <sear:cluster> <sear:id>1@DMADB20010103091142</sear:id> <sear:description>UBDMA710DB</sear:description> <sear:databaseKey>DMADB20010103091142</sear:databaseKey> </sear:cluster> <sear:cluster> <sear:id>1@WHOIDB200501002112461</sear:id> <sear:description>C1 for dev70 on KC</sear:description> <sear:databaseKey>WHOIDB200501002112461</sear:databaseKey> </sear:cluster> <sear:cluster> <sear:id>2@WHOIDB200501002112461</sear:id> <sear:description>C2 for dev70 on KC</sear:description> <sear:databaseKey>WHOIDB200501002112461</sear:databaseKey> </sear:cluster> <sear:cluster> <sear:id>1@MAST20001DB20020910104124</sear:id> <sear:description>Default Cluster</sear:description> <sear:databaseKey>MAST20001DB20020910104124</sear:databaseKey> </sear:cluster> <sear:cluster> <sear:id>1@GWCCDB20010402131061</sear:id> <sear:description>UBGWCC710DB</sear:description> <sear:databaseKey>GWCCDB20010402131061</sear:databaseKey> </sear:cluster> <sear:cluster> <sear:id>1@RSCCDB20010402160646</sear:id> <sear:description>UBRSCC70DB</sear:description> <sear:databaseKey>RSCCDB20010402160646</sear:databaseKey> </sear:cluster> </serviceData> </voyagerServiceData>