Get Preferred Label for Concept URI

Description

Retrieves the preferred label for one or more concepts, identified by their URIs.

Syntax

/content/vocabulary/concept/prefLabel/{vocName}?{queryString}

NOTE: vocName is the vocabulary identifier in the describes resource URI for the vocabulary (for example, SciValFunders).

One or more instances of the query pair can be provided at a time, but all instances must map to the same vocabulary specified in the concept URI.

Input Parameters

The input parameters for the query string are described in the following table.

Parameter

Required?

Multiple Instances Allowed?

Description

conceptURI

Yes

Yes

The URI of a specific concept in a vocabulary. The URI includes the vocabulary and the unique ID for the concept.

Results

The preferred label for each concept, along with a reference to the concept URI, is returned in JSON format.

Example Queries

Example 1 Query: Retrieving the Preferred Label for One Concept

The following call retrieves the preferred label for a funding entity in the SciValFunders vocabulary whose unique ID is 100006085:

http://data.elsevier.com/content/vocabulary/concept/prefLabel/SciValFunders?conceptURI=http://data.elsevier.com/vocabulary/SciValFunders/100006085

This query returns the following result:

{"concepts":

[{"id":"http://data.elsevier.com/vocabulary/SciValFunders/100006085",

"prefLabel":{"label":{"literalForm":{"value":"Office of Disease Prevention","lang":"en"}}}

}]

}

Example 2 Query: Retrieving the Preferred Label for Two Concepts

The following call retrieves the preferred labels for a funding entities in the SciValFunders vocabulary whose unique IDs are 100006085 and 100006086:

http://data.elsevier.com/content/vocabulary/concept/prefLabel/SciValFunders?conceptURI=http://data.elsevier.com/vocabulary/SciValFunders/100006085
&conceptURI=http://data.elsevier.com/vocabulary/SciValFunders/100006086

This query returns the following result:

{"concepts":

[{"id":"http://data.elsevier.com/vocabulary/SciValFunders/100006085",

"prefLabel":{"label":{"literalForm":{"value":"Office of Disease Prevention","lang":"en"}}}},

{"id":"http://data.elsevier.com/vocabulary/SciValFunders/100006086",

"prefLabel":{"label":{"literalForm":{"value":"Office of Strategic Coordination","lang":"en"}}}

}]

}

Error Return Codes

If an error occurs, the following standard HTTP error response codes are returned:

  • 500: A server-side error unrelated to the client query (for example, the server is down, or the code contains a null pointer).
  • 4xx: A client-side error; specifically for this API, one of the following:
    • 400: There is a syntax error in the query (for example, the query is missing a required parameter or includes an invalid argument).
    • 404: No content exists (for example, there is no match for the concept URI).
    • 405: The call is using an HTTP method that is not supported for this API.

Along with the error, a text message that briefly explains the problem is returned.

The following error messages can also be returned by this API:

  • Authentication Error Occurred. Authentication Failure. An invalid vocabulary identifier was provided.
  • Invalid request. Missing mandatory param: conceptURI. A concept URI was not provided in the API call.

If a valid query returns 0 results, an empty result set is returned.

Contact Us About Elsevier Terms and Conditions Privacy Policy

Copyright © 2017 Elsevier B.V.  All rights reserved.