Understanding the API

/api/v1/usnvc/units

The api endpoint /api/v1/usnvc/units allows for specific queries to be submitted.

Parameters

pagesize

Sets the maximum number of results returned by the query.

offset

Used to implement paging within the result set.

q

Specifies the query in ElasticSearch DSL format.
More information about the query syntax can be found at Elastic Search Query Language
Use ES documentation for version 6.8

/api/v1/usnvc/units/{identifier}

The api endpoint /api/v1/usnvc/units/{identifier} retrieves an individual item.

Parameters

identifier required

The identifier is used to drill down to a specific item. Generally this would be an item retrieved as part of more general query. The item number represents that specific unit in the data store, and has no meaning other than being a unique identifier.

Programming against the API

When processing an existing result set via a program or script run against the API keep these in mind:

• Near the bottom of each result item returned is a uri field that can be used to access the individual item.
• There is an array of ancestors and if applicable an array of children that can be traversed. The numbers in the array each refer to a specific item. No example provided because to do this manually you would use the identifier endpoint (see above) for each item