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

64 lines
2.0 KiB
Plaintext
Raw Normal View History

### Get Awardings [GET /awardings{?userId,inProgress,fractFilter,squadId}]
2018-03-19 20:32:59 +01:00
List all awardings
+ Parameters
2018-03-29 22:14:04 +02:00
+ userId: `5ab68d42f547ed304064e5f7` (string, optional)
2018-03-25 21:06:57 +02:00
specific army member Id to show the awardings for
2018-03-19 20:32:59 +01:00
2018-03-29 22:14:04 +02:00
+ inProgress: false (boolean, optional)
2018-03-25 21:06:57 +02:00
true to filter by awarding state 'in progress'
+ Default: false
2018-03-29 22:14:04 +02:00
+ fractFilter: `BLUFOR` (enum[string], optional)
2018-03-25 21:06:57 +02:00
Field to filter by fraction
2018-03-19 20:32:59 +01:00
+ Members
2018-03-25 21:06:57 +02:00
+ `BLUFOR`
+ `OPFOR`
+ `GLOBAL`
+ squadId: `5aba54eaeadcce6332c6a774` (string, optional)
unique id of the squad
2018-03-19 20:32:59 +01:00
2018-04-01 15:12:24 +02:00
+ Response 200 (application/json; charset=utf-8)
2018-03-19 20:32:59 +01:00
2018-04-01 15:12:24 +02:00
+ Attributes (array[AwardingPopulated], fixed-type)
2018-03-31 00:25:23 +02:00
### Create Awarding [POST /awardings]
2018-03-31 12:05:37 +02:00
Create a new awarding which is immediatly assigned to the user
**Permission: 2**
2018-03-31 00:25:23 +02:00
+ Request (application/json)
+ Attributes
2018-03-31 12:05:37 +02:00
+ userId: `5ab68d42f547ed304064e5f7` (string, required) - unique id of the army member to give award
2018-03-31 00:25:23 +02:00
+ decorationId: `5abd3dff6e6a0334d95b8ba0` (string, required) - unique id of the decoration
+ reason: `Good boy` (string, required) - reason for giving the awarding
+ proposer: `5ab68ceef547ed304064e5f6` (string, required) - app user id, who requested this awarding
2018-04-01 15:12:24 +02:00
+ Response 201 (application/json; charset=utf-8)
2018-03-31 00:25:23 +02:00
+ Attributes (Awarding, fixed-type)
2018-03-31 12:05:37 +02:00
### Create Awarding Proposal [POST /request/award]
Create a new awarding proposal, that needs to be approved by higher permission level user to take effect
**Permission: 1**
2018-03-31 12:05:37 +02:00
+ Request (application/json)
+ Attributes
+ userId: `5ab68d42f547ed304064e5f7` (string, required) - unique id of the army member to give award
+ decorationId: `5abd3dff6e6a0334d95b8ba0` (string, required) - unique id of the decoration
+ reason: `Good boy` (string, required) - reason for giving the awarding
2018-04-01 15:12:24 +02:00
+ Response 201 (application/json; charset=utf-8)
2018-03-31 12:05:37 +02:00
+ Attributes (Awarding, fixed-type)