From 053c9730ef8b81119bcfed53eb5dd3bb4dc23953 Mon Sep 17 00:00:00 2001 From: Florian Hartwich Date: Sat, 31 Mar 2018 00:25:23 +0200 Subject: [PATCH] add api docs create awarding --- api/apib/army-management/awardings.apib | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/api/apib/army-management/awardings.apib b/api/apib/army-management/awardings.apib index b162722..e996061 100644 --- a/api/apib/army-management/awardings.apib +++ b/api/apib/army-management/awardings.apib @@ -23,3 +23,19 @@ List all awardings + Response 200 + Attributes (array[Awarding], fixed-type) + +### Create Awarding [POST /awardings] + +Create a new awarding which is immediatly assigned to the user (only for HL and above permission) + ++ Request (application/json) + + + Attributes + + userId: `5ab68d42f547ed304064e5f7` (string, required) - display name of the user + + 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 + ++ Response 201 + + + Attributes (Awarding, fixed-type)