Engineering Village Search Request

A Search Request method enables a RESTful API client to perform an expert search across all or any combination of Engineering Village databases.

The input for the search request, a query string and additional search options, is identical to the expert search form of the Engineering Village web application. Help topics on doing an expert search in the web application can be found here . API documentation for the Engineering Village Search API can be found in the links below.


WADL documentation

The API documentation provides details on use of advanced search options and links to the Engineering Village Online Help for options that correspond to options in the Engineering Village Online web application.

Getting access

Please check here here on getting an API Key for your organization. The search examples on this page work for API Key values that do IP address based authentication.

How to do a search with default options

Here is the URL syntax for doing a search without setting any advanced options

/content/ev/results?apiKey={apiKey}&query={query terms}

OR

[Request headers]
X-ELS-APIKey: 5135c5817a6d86b633013ee9e4d120b5
Accept: application/atom+xml

[Request URL]
/content/ev/results?query={query terms}

Where:

--{query terms} are any applicable search field or query terms from the Engineering Village expert search syntax

Processing the response from a search request

If not specified, the response from a search request is a JSON object with the MIME type application/json. Output is also available as XML by specifying an Accept header with the value application/xml.

[Request headers]
X-ELS-APIKey: {apiKey}
Accept: application/xml

[Request URL]
/content/ev/results?query={query terms}

Here is a sample request and response for a search for items with the word "stress" within the past week in the Compendex database and having a page size of 1.

$ curl "https://api.elsevier.com/content/ev/results?apiKey=5135c5817a6d86b633013ee9e4d120b5&query=stress&database=c&updateNumber=1&pageSize=1"
{"PAGE":{"RESULTS-COUNT":1192,"RESULTS-PER-PAGE":1,"PAGE-RESULTS":{"PAGE-ENTRY":[{"EI-DOCUMENT":{"DOCUMENTPROPERTIES":{"PP":"p 134-140","RCT":"25","CPR":"Compilation and indexing terms, © 2016 Elsevier Inc.","DO":"10.1016/j.jngse.2015.12.050","AN":"20160401854983","DT":"Journal article (JA)","CPRT":"Compilation and indexing terms, Copyright 2016 Elsevier Inc.","SD":"February 01, 2016","LOAD-NO":"201607","TI":"Stress corrosion cracking behavior of high strength casing steel in working fluids","VO":"v 29","YR":"2016","SN":"18755100","SO":"Journal of Natural Gas Science and Engineering","PN":"Elsevier"},"DOC":{"DOC-ID":"cpx_M7d7e2f65152c6c56b46M7aab10178163171","HITINDEX":1,"DB":{"DBNAME":"Compendex","ID":"cpx"}},"FT":{"FTLINK":"Y"},"AFS":{"AF":[{"ID":"1","NAME":"State Key Laboratory of Oil and Gas Reservoir Geology and Exploitation, Southwest Petroleum University, Chengdu, China"}]},"AUS":{"AU":[{"ID":"1","EMAIL":"guoxishui777@126.com","AFS":{"AFID":"1"},"NAME":"Guo, Xishui"},{"ID":"1","EMAIL":"taiheshi@126.com","AFS":{"AFID":"1"},"NAME":"Shi, Taihe"},{"ID":"1","EMAIL":"wisezh@126.com","AFS":{"AFID":"1"},"NAME":"Zhang, Zhi"},{"ID":"1","EMAIL":"pymabiao@163.com","AFS":{"AFID":"1"},"NAME":"Ma, Biao"}]}}}]}}}

Here is the output formatted for readability.

{
  "PAGE": {
    "RESULTS-COUNT": 1192,
    "RESULTS-PER-PAGE": 1,
    "PAGE-RESULTS": {
      "PAGE-ENTRY": [
        {
          "EI-DOCUMENT": {
            "DOCUMENTPROPERTIES": {
              "PP": "p 134-140",
              "RCT": "25",
              "CPR": "Compilation and indexing terms, © 2016 Elsevier Inc.",
              "DO": "10.1016/j.jngse.2015.12.050",
              "AN": "20160401854983",
              "DT": "Journal article (JA)",
              "CPRT": "Compilation and indexing terms, Copyright 2016 Elsevier Inc.",
              "SD": "February 01, 2016",
              "LOAD-NO": "201607",
              "TI": "Stress corrosion cracking behavior of high strength casing steel in working fluids",
              "VO": "v 29",
              "YR": "2016",
              "SN": "18755100",
              "SO": "Journal of Natural Gas Science and Engineering",
              "PN": "Elsevier"
            },
            "DOC": {
              "DOC-ID": "cpx_M7d7e2f65152c6c56b46M7aab10178163171",
              "HITINDEX": 1,
              "DB": {
                "DBNAME": "Compendex",
                "ID": "cpx"
              }
            },
            "FT": {
              "FTLINK": "Y"
            },
            "AFS": {
              "AF": [
                {
                  "ID": "1",
                  "NAME": "State Key Laboratory of Oil and Gas Reservoir Geology and Exploitation, Southwest Petroleum University, Chengdu, China"
                }
              ]
            },
            "AUS": {
              "AU": [
                {
                  "ID": "1",
                  "EMAIL": "guoxishui777@126.com",
                  "AFS": {
                    "AFID": "1"
                  },
                  "NAME": "Guo, Xishui"
                },
                {
                  "ID": "1",
                  "EMAIL": "taiheshi@126.com",
                  "AFS": {
                    "AFID": "1"
                  },
                  "NAME": "Shi, Taihe"
                },
                {
                  "ID": "1",
                  "EMAIL": "wisezh@126.com",
                  "AFS": {
                    "AFID": "1"
                  },
                  "NAME": "Zhang, Zhi"
                },
                {
                  "ID": "1",
                  "EMAIL": "pymabiao@163.com",
                  "AFS": {
                    "AFID": "1"
                  },
                  "NAME": "Ma, Biao"
                }
              ]
            }
          }
        }
      ]
    }
  }
}

If your client application is only interested in the count, it can be retrieved with the JSON expression $["PAGE"]["RESULTS-COUNT"] in a JMeter.

For more general processing, the recommended approach is to use tools such as Swagger Codegen (see here ) to generate client code for your application to ingest the response into a usable object from https://api.engineeringvillage.com/EvDataWebServices/v2/api-docs?group=00-ev-search-api . Please note that the contents of the DOCUMENTPROPERTIES object will vary based on the source of the database for EI-DOCUMENT object.