Rim/IW4M-Admin
Rim/IW4M-Admin
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 30 Wiki Activity

Created API (markdown)

RaidMax 2020-05-24 11:03:03 -05:00
parent b86e78f85d
commit 5e7e0e8a31
1 changed files with 75 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
API.md Normal file

@ -0,0 +1,75 @@
## Client
### Find Client Request
GET `api/client/find`
| Parameter | Method | Description | Type | Validation | Default |
|-----------|--------|------------------------------------------------|---------|--------------------------------|------------|
| name | Query | Name of client to search for | String | Name or xuid required | -- |
| xuid | Query | Xuid of client to search for | String | Name or xuid required | -- |
| count | Query | Number of items to retrieve | Integer | Min — 1, Max — 100 | 100 |
| offset | Query | Number of items to skip | Integer | Min — 0 | 0 |
| direction | Query | Sort direction of results (by last connection) | String | ascending\|descending | descending |
### Find Client Response
| Name | Description | Type |
|-------------------|----------------------------------|---------|
| totalFoundClients | Number of clients matching query | Integer |
| clients | Collection of **client info** | Array |
**Client Info**
| Name | Description | Type |
|----------|-----------------------------|---------|
| clientId | IW4MAdmin client identifier | Integer |
| xuid | Network identifier | String |
| name | Client name | String |
**Sample**
```json
{
"totalFoundClients":1,
"clients":[
{
"clientId":1,
"xuid":"FFFFFFFFFFFFFFFF",
"name":"/dev/../^7"
}
]
}
```
## Stats
### Get Client Stats
GET `api/stats/{clientId}`
| Parameter | Method | Description | Type | Validation | Default |
|-----------|--------|------------------------------------------------|---------|--------------------------------|------------|
| clientid | Query | client identifier | Integer | Required, >0 | -- |
### Get Client Stats Response (Array)
| Name | Description | Type |
|--------------------|----------------------------------------------|----------|
| ranking | Client ranking on the server | Integer |
| kills | Number of kills | Integer |
| deaths | Number of kills | Integer |
| performance | Performance Level (elo rating + skill) / 2.0 | Double |
| scorePerMinute | Score per minute | Double |
| lastPlayed | When the client last connected | DateTime |
| totalSecondsPlayed | The number of seconds the client has played | Integer |
| serverName | Name of the server | String |
| serverGame | Game the server is running | String |
**Sample**
```json
[
{
"ranking":0,
"kills":8,
"deaths":21,
"performance":92.85,
"scorePerMinute":12.753,
"lastPlayed":"2018-10-04T08:15:11",
"totalSecondsPlayed":541,
"serverName":"IW4Host",
"serverGame":"IW4"
}
]
```