Get Scopes of View
General Purpose
This service receives as input a view and outputs the XML related scopes.
Input Parameters
The input is a URL string that requests a view’s related scopes.
The following table describes the valid parameters in the URL input request:
Element | Description | Value |
---|---|---|
viewId | The ID of the view | string |
Output Parameters
The output for this service is an XML response that includes the requested view’s scopes.
The following table describes the valid parameters:
Element | Description | Value | Default | Structure |
---|---|---|---|---|
Scopes | Root element of the XML tree | no value | xs:element | |
Scope | Element to contain one or several sub-elements. Sub-elements are details of a view’s related scope | no value | Sub-element of Scopes | |
name | Name of the scope | any value | Sub-element of Scope | |
Description | Scope description as it displays in the scopes drop down in FE | any value | Sub-element of Scope | |
searchLocParam | Strings that may be used for loc parameter of search XS. It is made of SearchScopes elements. Note: If this parameter is empty (usually default_scope) then no need to send any loc parameter to the search XS – the search will performed in all the scopes defined in the system (as FE does) | any value | Sub-element of Scope | |
SearchScopes | Element to contain one or several sub-elements. Sub-elements are details of resource elements which are included in a scope | no value | Sub-element of Scope | |
code | Code of the local recourse, name of Metalib quick set or third node adaptor name | any value | Sub-element of SearchScopes | |
resourceLocation | Location of a resource | no value | Sub-element of SearchScopes |
Input Example
http://primo:170X/PrimoWebServices/xservice/getscopesofview?viewId=Auto1
Output Example
<Scopes xmlns="http://com/exlibris/primo/xsd/Scopes/config"> <Scope> <Name>default_scope</Name> <Description>Entire Local Repository</Description> <searchLocParam/> <SearchScopes/> </Scope> <Scope> <Name>empty</Name> <Description>empty</Description> <searchLocParam/> <SearchScopes/> </Scope> <Scope> <Name>remote</Name> <Description>remote</Description> <searchLocParam>loc=remote,HealthandMedicine</searchLocParam> <SearchScopes> <SearchScope> <code>HealthandMedicine</code> <resourceLocation>Remote</resourceLocation> </SearchScope> </SearchScopes> </Scope> <Scope> <Name>test</Name> <Description>test</Description> <searchLocParam>loc=local,scope:("PRIMO"," REEF","VOLCANO","PINTE")&loc=remote,Universidade do Porto&loc=adaptor,MyThirdNode</searchLocParam> <SearchScopes> <SearchScope> <code>PRIMO</code> <resourceLocation>Local</resourceLocation> </SearchScope> <SearchScope> <code>REEF</code> <resourceLocation>Local</resourceLocation> </SearchScope> <SearchScope> <code>VOLCANO</code> <resourceLocation>Local</resourceLocation> </SearchScope> <SearchScope> <code>PINTE</code> <resourceLocation>Local</resourceLocation> </SearchScope> <SearchScope> <code>Universidade do Porto</code> <resourceLocation>Remote</resourceLocation> </SearchScope> <SearchScope> <code>MyThirdNode</code> <resourceLocation>Adaptor</resourceLocation> </SearchScope> </SearchScopes> </Scope> </Scopes>