55 lines
832 B
Markdown
55 lines
832 B
Markdown
|
# API Docs
|
||
|
|
|
||
|
|
<a name="report"></a>
|
||
|
|
## Report
|
||
|
|
|
||
|
|
Details for report api
|
||
|
|
##
|
||
|
|
##
|
||
|
|
|
||
|
|
####Endpoint
|
||
|
|
|
||
|
|
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||
|
|
|
||
|
|
| Method | URI | Headers |
|
||
|
|
| : | :- | : |
|
||
|
|
| POST | `user/report` | Authorization : Bearer {token} |
|
||
|
|
|
||
|
|
### URL Params
|
||
|
|
|
||
|
|
```php
|
||
|
|
None
|
||
|
|
```
|
||
|
|
|
||
|
|
### Data Params
|
||
|
|
|
||
|
|
```php
|
||
|
|
{
|
||
|
|
"type": 1, //1: User, 2: Post, 3: Comment
|
||
|
|
"reported_for": 8, //Id of User/Post/Comment
|
||
|
|
"subject": "Spam",
|
||
|
|
"description": "Fake profile"
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
> {success} Success Response
|
||
|
|
|
||
|
|
####Code `200`
|
||
|
|
####Content
|
||
|
|
```php
|
||
|
|
{
|
||
|
|
"message": "Report submitted successfully!",
|
||
|
|
"status": 200
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
> {danger} Unauthenticated Response
|
||
|
|
|
||
|
|
####Code `403`
|
||
|
|
####Content
|
||
|
|
```php
|
||
|
|
{
|
||
|
|
"message": "You have already submitted report request for this!"
|
||
|
|
}
|
||
|
|
```
|