opt-cc/api/apib/data_structures/_user.apib

23 lines
891 B
Plaintext
Raw Normal View History

2018-03-31 19:23:49 +02:00
# User (object)
2018-03-19 20:32:59 +01:00
A participant managed in the system
## Properties
+ _id: `5ab68d42f547ed304064e5f7` (string, required) - unique id of the army member
+ username: `Jagernaut` (string, required) - the displayed username of the army member
2018-03-19 20:32:59 +01:00
+ rankLvl: 22 (number, required) - rank level representing the rank
2018-04-01 15:12:24 +02:00
+ squadId: `591470249e9fae286e008e31` (string, required, nullable) - id of squad which the army member is part of
2018-03-19 20:32:59 +01:00
+ updatedAt: `2018-02-24T01:01:25.825Z` - the version timestamp
+ __v: 35 (number, required) - the version number of the object
2018-04-01 15:12:24 +02:00
# UserPopulated (User)
User object with populated squad
## Properties
+ squadId (Squad, required) - populated squad which the army member is part of
# UserInclTimestamp (User)
A participant managed in the system, incl. creation timestamp
## Properties
+ timestamp: 2018-01-20T12:11:23.125Z (string, required) - instance creation timestamp