Unit API

GET /unit/search

List of available units

Example request:

GET /unit/search?unit_id[]=127&unit_id[]=9&api_key=key-XXXXXXXXXXXXX HTTP/1.1
Host: api.dvidshub.net
Accept-encoding: gzip, deflate
User-Agent: Zend_Http_Client
Accept: application/json, text/javascript
Referer: https://api.dvidshub.net

Example response:

HTTP/1.1 200 OK
Content-type: application/json; charset=utf-8
Content-length: 347
Connection: keep-alive
Date: Mon, 27 May 2024 09:12:03 GMT
Server: Apache
Access-control-allow-origin: *
X-cache: Miss from cloudfront
Via: 1.1 a85e1510327226089dfd77f1b1c39ad8.cloudfront.net (CloudFront)
X-amz-cf-pop: IAD12-P4
Alt-svc: h3=":443"; ma=86400
X-amz-cf-id: yx4X1yhGeNjupiJFRJ_ceK9ojcwA9pHVG4cibXmrdCOgaFRAuE_GJw==

        "max_results was not supplied.  A maximum of 50 results per page will be returned."
            "unit_name":"139th Mobile Public Affairs Detachment",
            "unit_name":"DVIDS Hub",

Query Parameters:

  • api_key: Public API access key issued by DVIDS (key-xxxxxxxxxxxxx)
  • sortdir: One of asc, desc.
  • unit_id: [int] Unit id to retrieve contents for. | unit_id=127 | &unit_id[]=127&unit_id[]=43
  • branch: Branch name to retrieve contents for.
  • max_results: Maximum number of results to return.
  • unit_abbrev: | DVIDS abbreviation of unit credited with media asset.| unit_abbrev=DVIDSHUB | &unit_abbrev[]=DVIDSHUB&unit_abbrev[]=AFNA
  • unit_name | Full or partial name of unit.| unit_name=DVIDS hub | unit_name=DVIDS |
  • page: [int] What page to load. Defaults to 1.

Status Codes:

  • 200: no error
  • 400: invalid parameter(s) specified. See errors element in response for details.
  • 403: api_key not provided, invalid, or accessed from origin (protocol+domain) other than the one associated with the key provided.

Response Fields:

  • unit_id: Id for the unit
  • unit_name: name of the unit
  • unit_abbrev: Abbrevation for the unit
  • branch: Name of branch for the unit