opt-cc/api/apib/army-management/ranks.apib

31 lines
613 B
Plaintext
Raw Normal View History

2018-03-29 17:13:55 +02:00
### GET Ranks [GET /ranks{?q,fractFilter}]
List all ranks
+ Parameters
2018-03-29 17:55:31 +02:00
+ q: `Gefr` (string, optional) - filter string which filters for partial rank name
2018-03-29 17:13:55 +02:00
2018-03-29 22:14:04 +02:00
+ fractFilter: `BLUFOR` (enum[string], optional)
2018-03-29 17:13:55 +02:00
Field to filter by fraction
+ Members
+ `BLUFOR`
+ `OPFOR`
+ `GLOBAL`
+ Response 200
2018-03-29 22:14:04 +02:00
+ Attributes (array[Rank], fixed-type)
### GET Rank [GET /ranks/{id}]
Retrieve single rank data
+ Parameters
+ id: `5aba5504eadcce6332c6a775` (string, required) - unique id of the rank to fetch
+ Response 200
+ Attributes (Rank, fixed-type)