Search¶

Request¶

This request searches for series with the term “social”.

Request Type	POST
URL	/api/v1/_query

Request Body¶

 {
     "Cultures": [
         "en-US"
     ],
     "ItemTypes": [
         "4bd6eef6-99df-40e6-9b11-5b8f64e5cb23"
     ],
     "LanguageSortOrder": [
         "en-US"
     ],
     "MaxResults": 0,
     "RankResults": true,
     "ResultOffset": 0,
     "ResultOrdering": "None",
     "SearchDepricatedItems": false,
     "SearchTerms": [
         "social"
     ],
     "SearchLatestVersion": true
 }

The identifier 4bd6eef6-99df-40e6-9b11-5b8f64e5cb23 is the item type identifier for the Series item type.
See Item Type Identifiers for a list of identifiers for all item types.

Response¶

{
    "Results": [
        {
            "Summary": {},
            "ItemName": {
                "en-US": "Sample Social Survey"
            },
            "Label": {},
            "Description": {},
            "VersionRationale": {},
            "MetadataRank": 0,
            "RepositoryName": null,
            "IsAuthoritative": false,
            "Tags": [],
            "ItemType": "4bd6eef6-99df-40e6-9b11-5b8f64e5cb23",
            "AgencyId": "example.org",
            "Version": 1,
            "Identifier": "e9d35174-dea3-4629-afef-770220b4cbc4",
            "Item": null,
            "Notes": null,
            "VersionDate": "0001-01-01T00:00:00",
            "VersionResponsibility": null,
            "IsPublished": false,
            "IsDeprecated": false,
            "IsProvisional": false,
            "ItemFormat": "00000000-0000-0000-0000-000000000000"
        }
    ],
    "TotalResults": 1,
    "ReturnedResults": 1,
    "DatabaseTime": "00:00:00.2659887",
    "RepositoryTime": "00:00:00.0010016"
}