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

43 lines
872 B
Plaintext
Raw Normal View History

2018-03-25 21:18:13 +02:00
### GET Users [GET /users{?q,fractFilter,limit,offset}]
Get single army member information
+ Parameters
+ q: `hardi` (string, optional) - filter string which filters for partial username
+ fractFilter (enum[string], optional)
Field to filter by fraction
+ Members
+ `BLUFOR`
+ `OPFOR`
+ `GLOBAL`
+ limit: 20 (number, optional)
Maximum number of users to return
+ offset (number, optional)
Offset into result-set (useful for pagination)
+ Default: 0
+ Response 200
+ Headers
X-Total-Count: 1
+ Attributes (array[User], fixed-type)
2018-03-25 21:18:13 +02:00
### GET User [GET /users/{id}]
2018-03-19 20:32:59 +01:00
Get single army member information
+ Parameters
+ id: `5ab68d42f547ed304064e5f7` (string, required) - unique id of army-member
2018-03-19 20:32:59 +01:00
+ Response 200
+ Attributes (User, fixed-type)