Search / AdvancedSearch

Summary

Search endpoints perform full-text and fielded searches against the Lucene index and return JSON results (camelCased). Use Search for a quick single-term search (convenience) or AdvancedSearch for the full parameterized API.

GET request examples

• https://www.spc.int/digitallibrary/api/advancedSearch?pageNumber=2&pageSize=10&simpleSearchText=samoa%20health
• https://www.spc.int/digitallibrary/api/Search/2012%20samoa%20health

POST request examples Endpoint: https://www.spc.int/digitallibrary/api/advancedSearch

{
  "simpleSearchText": "title:\"Yellowfin tuna\"",
  "advancedSearchText1": "[1990 TO 1995]",
  "advancedSearchField1": "year"
}

{
  "advancedSearchText1": "Turtles",
  "advancedSearchField1": "content",
  "advancedSearchText2": "Dalzell",
  "advancedSearchField2": "authors",
  "pageSize": "10",
  "pageNumber": "2"
}

Search API Fields

The Search API accepts a set of parameters that allow filtering, faceting, and refining queries across the SPC Digital Library.

SearchParameters (request model)

• Paging
  • PageSize (int) — default 10
  • PageNumber (int) — default 1
• Filters and facets
  • Collections (string[])
  • Fields (string[])
  • Countries (string[])
  • ContentTypes (string[])
• Language flags
  • EnglishDocuments (bool), FrenchDocuments (bool), PortugueseDocuments (bool)
• Boolean operator
  • Operator (string) — default "AND"
• Simple and advanced query text
  • SimpleSearchText (string)
  • AdvancedSearchText1, AdvancedSearchField1
  • AdvancedSearchText2, AdvancedSearchField2
  • AdvancedSearchText3, AdvancedSearchField3
• Index / routing identifiers
  • LuceneIndexId (Guid)
  • SearchInterfaceId (Guid)
  • TemplateId (Guid)
  • RepositoryId (Guid)
• Additional filters / UI ids
  • AuthorityId, CountryId, CollectionId, ContentTypeId, PeriodicalId, FieldId (Guid)
• Controls
  • AdvancedSearch (bool)
  • SortBy (string) — e.g. RelevanceYearDesc
  • GenerateCitations (string)
  • CitationsForAllHits (bool)

Each field below includes its purpose and an example value.

Repository and Index Identifiers

Faceted Search Identifiers

Search Text and Operators

Advanced Field‑Specific Search

Language Filters

Paging

Response format

• JSON object JsonSearchResult:

  • success (bool) — search success flag
  • message (string) — optional message
  • numHits (int) — total number of hits
  • hits (array) — list of hits (JsonSearchHit)
  • facetCountries, facetFields, facetPeriodicals, facetContentTypes, facetCollections — arrays of facet items (id/name)

• Each JsonSearchHit includes (important fields)

  • hitNo (int)
  • title (string)
  • authors (string)
  • year (int?)
  • reference (string)
  • htmlFragment (string) — highlighted excerpt
  • thumbnail (string) — thumbnail URL (may be null)
  • documents (array) — each JsonHitDocument:
    • url (string) — absolute document URL (uses baseUri)
    • shortId, formattedSize

Example response (truncated)

    {
    "success": true,
    "message": "Your search returned 1634 documents",
    "numHits": 1634,
    "hits": [       
        {
            "hitNo": 7,
            "title": "Post school education and training statistical bulletin 2018",
            "isbn10": null,
            "authors": null,
            "year": 2018,
            "reference": "Post school education and training statistical bulletin 2018. 24 p. https://www.spc.int/digitallibrary/get/u6zo6",
            "htmlFragment": "of <b>Health National University of Samoa</b>...Leadership <b>Samoa Matuaileoo Environment Trust Incorporated Pacific Society for Reproductive Health Pesega Dental Clinic Plumbers Association of Samoa</b>...",
            "thumbnail": null,
            "documents": [
                {
                    "url": "https://www.spc.int/digitallibrary/Doc/EQAP/Education/WS/Samoa_PSET_Statistical_Bulletin_2018.pdf",
                    "shortId": "u6zo6",
                    "formattedSize": "1 MB"
                }
            ],
            "collections": [
                {
                    "url": "https://www.spc.int/digitallibrary/EQAP/Collection/Education_CR",
                    "name": "Education - Country reports"
                },
                {
                    "url": "https://www.spc.int/digitallibrary/EQAP/Collection/Education",
                    "name": "Education"
                }
            ]
        },
        {
            "hitNo": 8,
            "title": "Education Statistical Digest 2013",
            "isbn10": null,
            "authors": null,
            "year": 2013,
            "reference": "Education Statistical Digest 2013. 40 p. https://www.spc.int/digitallibrary/get/knyzy",
            "htmlFragment": "in <b>Samoa in 2013 is 207, one less than the 2012</b>...in <b>Samoa</b>...",
            "thumbnail": null,
            "documents": [
                {
                    "url": "https://www.spc.int/digitallibrary/Doc/EQAP/Education/WS/Samoa_2013_Education_Stats_Digest.pdf",
                    "shortId": "knyzy",
                    "formattedSize": "1 MB"
                }
            ],
            "collections": [
                {
                    "url": "https://www.spc.int/digitallibrary/EQAP/Collection/Education_CR",
                    "name": "Education - Country reports"
                },
                {
                    "url": "https://www.spc.int/digitallibrary/EQAP/Collection/Education",
                    "name": "Education"
                }
            ]
        }        
    ],
    "facetCountries": [
        {
            "id": "c2e91d11-6b70-45a5-a906-5daff131d90f",
            "name": "Samoa (112)"
        },
        {
            "id": "fe80fceb-62d1-41e6-a618-b7a8ae71c4b8",
            "name": "Japan (1)"
        },
    ],
    "facetFields": [
        {
            "id": "f32409bd-7e29-4f85-a9dd-1470c96b6034",
            "name": "Fisheries and aquaculture (535)"
        },        
        {
            "id": "988ea9c8-f988-4eba-9ddb-bed320521af6",
            "name": "Climate change (55)"
        },
    ],
    "facetPeriodicals": [
        {
            "id": "fad459e6-1620-4304-81d1-58595985ee76",
            "name": "Fisheries Newsletter (84)"
        },
        {
            "id": "a241b306-b97d-47e8-9989-b0addd2c5644",
            "name": "Lettre d'information sur les pêches (31)"
        }        
    ],
    "facetContentTypes": [
        {
            "id": "aa99c6b9-8ebc-45fa-9d35-baa071c05d0b",
            "name": "Report (470)"
        },
        {
            "id": "05573e1d-e779-448b-b254-8935db9a380c",
            "name": "Conference / journal paper (434)"
        }        
    ],
    "facetCollections": [
        {
            "id": "199739e4-709e-4e0a-ae5b-a49782988713",
            "name": "Meetings (220)"
        },        
        {
            "id": "f9c98b0f-5a6a-4010-82a0-20726313db61",
            "name": "GEM Renewable Energy and Energy Efficiency in FSM (1)"
        }
    ]
}