opt-cc/server/apib/data_structures/_awarding.apib

24 lines
1.3 KiB
Plaintext
Raw Normal View History

2018-03-19 20:32:59 +01:00
# Awarding (object)
Awarding associating a decoration to a user
## Properties
2018-04-01 15:12:24 +02:00
+ _id: `591ca81c1ee62711cfc19002` (string, required) - unique id of the awarding
2018-03-19 20:32:59 +01:00
+ confirmed: 1 (number, required) - status of the awarding request (0 - in progress, 1 - approved, 2 - rejected)
+ date: `2017-05-17T19:44:24.926Z` (string, required) - date when the awarding was requested
2018-04-01 15:12:24 +02:00
+ decorationId: `591c81981ee62711cfc18f4a` (string, required) - id of decoration that is given with the awarding
2018-03-19 20:32:59 +01:00
+ reason: `war dabei` (string, required) - reason for giving the awarding
2018-04-01 15:12:24 +02:00
+ proposer: 593d5e3f72d35225222bcaba (string, required) - id of app user who requested this awarding
2018-03-19 20:32:59 +01:00
+ timestamp: `2017-05-17T19:44:28.751Z` (string, required) - creation date
+ updatedAt: `"2017-05-17T19:44:28.751Z` (string, required) - version date
+ userId: `5918d2ca574b0b1d820a0b24` (string, required) - the unique id of the user who got this awarding
+ __v: 0 (number, required) - version number
2018-04-01 15:12:24 +02:00
# AwardingPopulated (Awarding)
Awarding with populated decoration, proposer and army-user
2018-04-01 15:12:24 +02:00
## Properties
+ proposer (Proposer, required) - app user who requested this awarding
+ decorationId (Decoration, required) - populated decoration object that is given with the awarding
+ userId (User, required) - populated user who gets this awarding