267 lines
4.8 KiB
Markdown
267 lines
4.8 KiB
Markdown
# API Docs
|
|
|
|
<a name="list"></a>
|
|
## List
|
|
|
|
Details for chaturmas list api
|
|
##
|
|
##
|
|
|
|
####Endpoint
|
|
|
|
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
|
|
|
| Method | URI | Headers |
|
|
| : | :- | : |
|
|
| GET | `/chaturmas/{chaturmas}/review` | Bearer {token} |
|
|
|
|
### URL Params
|
|
|
|
```php
|
|
None
|
|
```
|
|
|
|
### Data Params
|
|
|
|
```php
|
|
{
|
|
"page" : "2"
|
|
}
|
|
```
|
|
|
|
> {success} Success Response
|
|
|
|
####Code `200`
|
|
####Content
|
|
```php
|
|
{
|
|
"status": 200,
|
|
"success": true,
|
|
"data": {
|
|
"current_page": 1,
|
|
"data": [
|
|
{
|
|
"id": 15,
|
|
"user_id": 1,
|
|
"sant_id": 1,
|
|
"chaturmas_id": 1,
|
|
"comment": 'Chaturmas comment',
|
|
"updated_by": null,
|
|
"created_at": "2022-01-28T10:56:08.000000Z",
|
|
"updated_at": "2022-01-28T10:56:08.000000Z",
|
|
},
|
|
{
|
|
"id": 15,
|
|
"user_id": 1,
|
|
"sant_id": 1,
|
|
"chaturmas_id": 1,
|
|
"comment": 'Chaturmas comment',
|
|
"updated_by": null,
|
|
"created_at": "2022-01-28T10:56:08.000000Z",
|
|
"updated_at": "2022-01-28T10:56:08.000000Z",
|
|
}
|
|
],
|
|
"first_page_url": "http://global-jain.test/api/v1/chaturmas?page=1",
|
|
"from": 1,
|
|
"last_page": 1,
|
|
"last_page_url": "http://global-jain.test/api/v1/chaturmas?page=1",
|
|
"links": [
|
|
{
|
|
"url": null,
|
|
"label": "« Previous",
|
|
"active": false
|
|
},
|
|
{
|
|
"url": "http://global-jain.test/api/v1/chaturmas?page=1",
|
|
"label": "1",
|
|
"active": true
|
|
},
|
|
{
|
|
"url": null,
|
|
"label": "Next »",
|
|
"active": false
|
|
}
|
|
],
|
|
"next_page_url": null,
|
|
"path": "http://global-jain.test/api/v1/chaturmas",
|
|
"per_page": 10,
|
|
"prev_page_url": null,
|
|
"to": 2,
|
|
"total": 2
|
|
},
|
|
"message": "Get chaturmas successfully!"
|
|
}
|
|
```
|
|
|
|
> {danger} Unauthenticated Response
|
|
|
|
####Code `403`
|
|
####Content
|
|
```php
|
|
{
|
|
"message": "Something went wrong!"
|
|
}
|
|
```
|
|
|
|
|
|
<a name="add"></a>
|
|
## Add
|
|
|
|
Details for add chaturmas api
|
|
##
|
|
##
|
|
|
|
####Endpoint
|
|
|
|
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
|
|
|
| Method | URI | Headers |
|
|
| : | :- | : |
|
|
| POST | `/chaturmas/{chaturma}/review` | Bearer {token} |
|
|
|
|
### URL Params
|
|
|
|
```php
|
|
None
|
|
```
|
|
|
|
### Data Params
|
|
|
|
```php
|
|
comment:'Comment',
|
|
sant_id:'1'
|
|
```
|
|
|
|
> {success} Success Response
|
|
|
|
####Code `200`
|
|
####Content
|
|
```php
|
|
{
|
|
"status": 200,
|
|
"success": true,
|
|
"data": {
|
|
"id": 15,
|
|
"user_id": 1,
|
|
"sant_id": 1,
|
|
"chaturmas_id": 1,
|
|
"comment": 'Chaturmas comment',
|
|
"updated_by": null,
|
|
"created_at": "2022-01-28T10:56:08.000000Z",
|
|
"updated_at": "2022-01-28T10:56:08.000000Z",
|
|
},
|
|
"message": "Chaturmas added successfully!"
|
|
}
|
|
```
|
|
|
|
<a name="update"></a>
|
|
## Update
|
|
|
|
Details for update chaturmas api
|
|
##
|
|
##
|
|
|
|
####Endpoint
|
|
|
|
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
|
|
|
| Method | URI | Headers |
|
|
| : | :- | : |
|
|
| POST | `/chaturmas/{chaturma}/review/{review}` | Bearer {token} |
|
|
|
|
### URL Params
|
|
|
|
```php
|
|
None
|
|
```
|
|
|
|
### Data Params
|
|
|
|
```php
|
|
comment:'aaa'
|
|
sant_id:'1'
|
|
```
|
|
|
|
> {success} Success Response
|
|
|
|
####Code `200`
|
|
####Content
|
|
```php
|
|
{
|
|
"status": 200,
|
|
"success": true,
|
|
"data": {
|
|
"id": 15,
|
|
"user_id": 1,
|
|
"sant_id": 1,
|
|
"chaturmas_id": 1,
|
|
"comment": 'aaa',
|
|
"updated_by": null,
|
|
"created_at": "2022-01-28T10:56:08.000000Z",
|
|
"updated_at": "2022-01-28T10:56:08.000000Z",
|
|
},
|
|
"message": "Chaturmas updated successfully!"
|
|
}
|
|
```
|
|
|
|
<a name="show"></a>
|
|
## Add
|
|
|
|
Details of chaturmas
|
|
##
|
|
##
|
|
|
|
####Endpoint
|
|
|
|
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
|
|
|
| Method | URI | Headers |
|
|
| : | :- | : |
|
|
| Get | `/chaturmas/{chaturma}/review/{review}` | Bearer {token} |
|
|
|
|
### URL Params
|
|
|
|
```php
|
|
None
|
|
```
|
|
|
|
### Data Params
|
|
|
|
```php
|
|
None
|
|
```
|
|
|
|
> {success} Success Response
|
|
|
|
####Code `200`
|
|
####Content
|
|
```php
|
|
{
|
|
"status": 200,
|
|
"success": true,
|
|
"data": {
|
|
"id": 15,
|
|
"user_id": 1,
|
|
"sant_id": 1,
|
|
"chaturmas_id": 1,
|
|
"comment": 'aaa',
|
|
"updated_by": null,
|
|
"created_at": "2022-01-28T10:56:08.000000Z",
|
|
"updated_at": "2022-01-28T10:56:08.000000Z",
|
|
},
|
|
"message": "Get chaturmas successfully!"
|
|
}
|
|
```
|
|
|
|
> {danger} Unauthenticated Response
|
|
|
|
####Code `403`
|
|
####Content
|
|
```php
|
|
{
|
|
"status": 403,
|
|
"success": false
|
|
}
|
|
```
|
|
|