Page tree

GET /catalogues/search/{search-id}/navigation

Description: This method allows you to navigate between records when viewing a record in your interface.  There are different way of identifying the first, next, previous and last record in a result set.

  1. If using the All fields Tab its possible to cycle records in the context of the ALL Tab.
  2. Where a specific content type is being read from the results using read-content-type parameter 
    1. Get Navigation for that CT only.
    2. Get navigation for all records cycling through CT one by one.
ParameterExampleNotes

search-id

REQUIRED

719SearchID of your search request

catalogueid

REQUIRED

349540CID of the record currently open

navig-scope

REQUIRED

0/1If set false (0) navigation will move between Content types, if set to true(1) navigation is restricted to only that one content type.

all-content-type

REQUIRED

0/1If the user is opening a record from the All content type tab this should be set as true (1). This setting will override navig-scope if set to 1.

Request: /SoutronAPI/catalogues/search/719/navigation?catalogueId=349540&navig-scope=1&all-content-type=0

Response
<CatalogueSearchNavigationResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Soutron.API.ServiceModel.Catalogues">
	<CurrentPosition>97</CurrentPosition>
	<FirstCID>386138</FirstCID>
	<LastCID>387004</LastCID>
	<NextCID>350656</NextCID>
	<PreviousCID>347687</PreviousCID>
	<TotalRecords>191</TotalRecords>
</CatalogueSearchNavigationResult>


Example 1

If using the All tab you can get navigation information for all records in the All Content type.

i.e. you open a record from the All tab, navigation will include all records from your search result because you opened the all tab. 

/SoutronAPI/catalogues/search/719/navigation?catalogueId=349540&navig-scope=0&all-content-type=1

Example 2

 This is the same as Example 1. The all-content-type overrides the value of navig-scope.

i.e. you open a record from the All tab, navigation will include all records from your search result because you opened the all tab. 

/SoutronAPI/catalogues/search/719/navigation?catalogueId=349540&navig-scope=1&all-content-type=1

Example 3

 If you have specified read-content-type value in your search this will return navigation for the selected content type, but also include the first and last CID of the entire search i.e. allowing navigation to other content types once you reach the last record of the selected content type.

i.e. you specify read-content-type=Books in your search request, navigation will start with the CID of the book record you view and will cycle through the Books content type, once it reaches the end of the Books records it will move onto the next content type returned by your search, allowing you to navigate through all records not just Books.

/SoutronAPI/catalogues/search/719/navigation?catalogueId=349540&navig-scope=0&all-content-type=0

Example 4

 If you have specified read-content-type value in your search this will return navigation for the selected content type only and will not include CID's of other content types to navigate to.

i.e. you specify read-content-type=Books in your search request, navigation will only include records from Book content type.

/SoutronAPI/catalogues/search/719/navigation?catalogueId=349540&navig-scope=1&all-content-type=0


  • No labels