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

111 lines
2.7 KiB
Plaintext
Raw Normal View History

2018-04-01 15:12:24 +02:00
### List Squads [GET /squads{?q,fractFilter}]
2018-03-30 00:05:13 +02:00
Get single army member information
+ Parameters
+ q: `alpha` (string, optional) - filter string which filters for partial squadname
+ fractFilter: `BLUFOR` (enum[string], optional)
Field to filter by fraction
+ Members
+ `BLUFOR`
+ `OPFOR`
+ `GLOBAL`
2018-04-01 15:12:24 +02:00
+ Response 200 (application/json; charset=utf-8)
2018-03-30 00:05:13 +02:00
+ Attributes (array[Squad], fixed-type)
### Get Squad [GET /squads/{id}]
Get single squad information
+ Parameters
+ id: `5aba54eaeadcce6332c6a774` (string, required) - unique id of the squad
2018-04-01 15:12:24 +02:00
+ Response 200 (application/json; charset=utf-8)
2018-03-30 00:05:13 +02:00
+ Attributes (Squad, fixed-type)
### Create Squad [POST /squads]
Create a new squad
**Permission: 2**
2018-03-30 00:05:13 +02:00
+ Request (multipart/form-data; boundary=---BOUNDARY)
-----BOUNDARY
Content-Disposition: form-data; name="name"
Content-Type: text/plain
2018-03-31 00:14:30 +02:00
Delta
2018-03-30 00:05:13 +02:00
-----BOUNDARY
Content-Disposition: form-data; name="fraction"
Content-Type: text/plain
BLUFOR
-----BOUNDARY
Content-Disposition: form-data; name="image"; filename="image.png"
Content-Type: image/png
2018-03-30 00:05:13 +02:00
Content-Transfer-Encoding: base64
iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX/TQBcNTh/AAAAAXRSTlMA
QObYZgAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=
2018-03-30 00:05:13 +02:00
-----BOUNDARY--
2018-04-01 15:12:24 +02:00
+ Response 201 (application/json; charset=utf-8)
2018-03-30 00:05:13 +02:00
2018-03-31 00:14:30 +02:00
+ Attributes (Squad, fixed-type)
2018-03-30 12:53:49 +02:00
### Update Squad [PATCH /squads/{id}]
Update squad, identified by its id
**Permission: 2**
2018-03-30 12:53:49 +02:00
+ Parameters
+ id: `5abe166f8b7488392a623f12` (string, required) - unique id of the squad
+ Request (multipart/form-data; boundary=---BOUNDARY)
-----BOUNDARY
Content-Disposition: form-data; name="name"
Content-Type: text/plain
test-CSAT
-----BOUNDARY
Content-Disposition: form-data; name="fraction"
Content-Type: text/plain
OPFOR
-----BOUNDARY
2018-03-31 00:14:30 +02:00
Content-Disposition: form-data; name="sortingNumber"
Content-Type: text/plain
3
-----BOUNDARY
Content-Disposition: form-data; name="image"; filename="image.png"
Content-Type: image/png
2018-03-30 12:53:49 +02:00
Content-Transfer-Encoding: base64
iVBORw0KGgoAAAANSUhEUgAAAAEAAAABAQMAAAAl21bKAAAAA1BMVEX/TQBcNTh/AAAAAXRSTlMA
QObYZgAAAApJREFUeJxjYgAAAAYAAzY3fKgAAAAASUVORK5CYII=
2018-03-30 12:53:49 +02:00
-----BOUNDARY--
2018-04-01 15:12:24 +02:00
+ Response 200 (application/json; charset=utf-8)
2018-03-30 12:53:49 +02:00
+ Attributes (Squad, fixed-type)
### Delete Squad [DELETE /squads/{id}]
Delete a squad
**Permission: 2**
2018-03-30 12:53:49 +02:00
+ Parameters
+ id: `5abe16f98b7488392a623f17` (string, required) - unique id of the squad
+ Response 204