GET library/search?q={q}&s={s}&wbodyid={wbodyid}&wshedid={wshedid}&sType={sType}&rType={rType}&start={start}&length={length}&sortCol={sortCol}&sortDir={sortDir}
Library search query (paged) Example GET: /library/search?q=History
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
q |
Query or Keyword |
string |
Default value is |
s |
Site ID |
integer |
None. |
wbodyid |
Water body Id |
integer |
None. |
wshedid |
Water shed Id |
integer |
None. |
sType |
Search Type |
string |
Default value is all |
rType |
Resource Type |
string |
None. |
start |
Start Index |
integer |
Default value is 0 |
length |
Page Size |
integer |
Default value is 50 |
sortCol |
Sort on column : Choose from 0=Title, 1=PubDate, 2=OrgName, 3=DateEntered |
sortCols |
Default value is Title |
sortDir |
Sort Direction : "asc" or "desc" |
string |
Default value is asc |
Body Parameters
None.
Response Information
Resource Description
Digital Library Results
DigitalLibraryResultsName | Description | Type | Additional information |
---|---|---|---|
startIndex |
Results Starting from this start Index in paging |
integer |
None. |
totalResults |
Total Results that matched the search |
integer |
None. |
results |
Result set |
Collection of DLEntity |
None. |
Response Formats
application/json, text/json
Sample:
{ "startIndex": 1, "totalResults": 2, "results": [ { "Title": "sample string 1", "Description": "sample string 2", "DocUrl": "sample string 3", "Type": "sample string 4", "PubDate": "sample string 5", "DateEntered": "2024-12-11T04:49:47.6981132-05:00", "PubOrg": { "OrgName": "sample string 1", "OrgAbbr": "sample string 2" } }, { "Title": "sample string 1", "Description": "sample string 2", "DocUrl": "sample string 3", "Type": "sample string 4", "PubDate": "sample string 5", "DateEntered": "2024-12-11T04:49:47.6981132-05:00", "PubOrg": { "OrgName": "sample string 1", "OrgAbbr": "sample string 2" } } ] }
text/javascript, application/javascript, application/json-p
Sample:
/**/ typeof === 'function' && ({"startIndex":1,"totalResults":2,"results":[{"Title":"sample string 1","Description":"sample string 2","DocUrl":"sample string 3","Type":"sample string 4","PubDate":"sample string 5","DateEntered":"2024-12-11T04:49:47.6981132-05:00","PubOrg":{"OrgName":"sample string 1","OrgAbbr":"sample string 2"}},{"Title":"sample string 1","Description":"sample string 2","DocUrl":"sample string 3","Type":"sample string 4","PubDate":"sample string 5","DateEntered":"2024-12-11T04:49:47.6981132-05:00","PubOrg":{"OrgName":"sample string 1","OrgAbbr":"sample string 2"}}]});