service-unit

Get a list of service units with paging and filtering

By default, this operation returns the units in which the consumer has an active membership. To control this behavior, use the only_mine query parameter.

get/service-unit

Request

Base URL
https://submitapi.dvidshub.net
Auth
OAuth 2
Authorization codehttps://api.dvidshub.net/auth/authorize
Token URLhttps://api.dvidshub.net/auth/access_token
Scopesbasic, email, upload
TypeScript
https://skmtc.dev/dvidshub/apis/dvids-content-submission-api/docs/service-unit/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

namestring

Example:4th Infantry

Search by unit name. A trailing wildcard is used in search to "complete" the entered value.

branchstring

Example:air-force

Filter by branch slug.

only_mineboolean

If false, return all units instead of only the ones in which the consumer has an active membership.

pageinteger

Page number of results

limitinteger

Limit of results per page

Response

An array of ServiceUnit objects

Example response

{
  "data": [
    {
      "attributes": {
        "name": "5th Ranger Training Battalion",
        "abbreviation": "5RTB",
        "branch": "army",
        "dvian": "A0051"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.