api code global jain
This commit is contained in:
106
resources/docs/1.0/blood-group.md
Normal file
106
resources/docs/1.0/blood-group.md
Normal file
@@ -0,0 +1,106 @@
|
||||
# API Docs
|
||||
|
||||
<a name="list"></a>
|
||||
## List
|
||||
|
||||
Details for blood group list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `user/blood-group` | Authorization : Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 1,
|
||||
"name": "A+",
|
||||
"status": 1,
|
||||
"created_at": "2022-03-03T06:59:44.000000Z",
|
||||
"updated_at": "2022-03-03T06:59:44.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "A-",
|
||||
"status": 1,
|
||||
"created_at": "2022-03-03T06:59:44.000000Z",
|
||||
"updated_at": "2022-03-03T06:59:44.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"name": "B+",
|
||||
"status": 1,
|
||||
"created_at": "2022-03-03T06:59:44.000000Z",
|
||||
"updated_at": "2022-03-03T06:59:44.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"name": "B-",
|
||||
"status": 1,
|
||||
"created_at": "2022-03-03T06:59:44.000000Z",
|
||||
"updated_at": "2022-03-03T06:59:44.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 5,
|
||||
"name": "AB+",
|
||||
"status": 1,
|
||||
"created_at": "2022-03-03T06:59:45.000000Z",
|
||||
"updated_at": "2022-03-03T06:59:45.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 6,
|
||||
"name": "AB-",
|
||||
"status": 1,
|
||||
"created_at": "2022-03-03T06:59:45.000000Z",
|
||||
"updated_at": "2022-03-03T06:59:45.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 7,
|
||||
"name": "O+",
|
||||
"status": 1,
|
||||
"created_at": "2022-03-03T06:59:45.000000Z",
|
||||
"updated_at": "2022-03-03T06:59:45.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 8,
|
||||
"name": "O-",
|
||||
"status": 1,
|
||||
"created_at": "2022-03-03T06:59:45.000000Z",
|
||||
"updated_at": "2022-03-03T06:59:45.000000Z"
|
||||
}
|
||||
],
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
266
resources/docs/1.0/chaturmas-review.md
Normal file
266
resources/docs/1.0/chaturmas-review.md
Normal file
@@ -0,0 +1,266 @@
|
||||
# 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
|
||||
}
|
||||
```
|
||||
|
||||
498
resources/docs/1.0/chaturmas.md
Normal file
498
resources/docs/1.0/chaturmas.md
Normal file
@@ -0,0 +1,498 @@
|
||||
# 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` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"sant_id":"1",
|
||||
"page" : "2"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"current_page": 1,
|
||||
"data": [
|
||||
{
|
||||
"id": 15,
|
||||
"sant_id": 1,
|
||||
"sangh_id": 1,
|
||||
"chaturmas_date_id": 1,
|
||||
"place": "Derasar 2",
|
||||
"start_date": null,
|
||||
"end_date": null,
|
||||
"year": null,
|
||||
"created_by": {
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"mobile": "12"
|
||||
},
|
||||
"updated_by": {
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"mobile": "12"
|
||||
},
|
||||
"created_at": "2022-01-28T07:35:07.000000Z",
|
||||
"updated_at": "2021-12-28T10:53:03.000000Z",
|
||||
"created_ago": "5 hours ago",
|
||||
"updated_ago": "1 month ago",
|
||||
"sangh": {
|
||||
"id": 1,
|
||||
"user_id": 1,
|
||||
"name": "Sangh Test 1",
|
||||
"dharma_id": 2,
|
||||
"sampraday_id": 1,
|
||||
"reg_number": "1E50SA4A4D",
|
||||
"reg_date": "2022-02-15",
|
||||
"address": "asdawfwaf, afaafsfef,afaasfgdfa",
|
||||
"city": "Ahmedabad",
|
||||
"pincode": 380056,
|
||||
"longitude": "12.00441",
|
||||
"latitude": "10.00441",
|
||||
"about": "About Sangh",
|
||||
"avatar": "http://global-jain.test/storage/images/sanghs/medium/3911647430921.png",
|
||||
"created_by": 1,
|
||||
"updated_by": 1,
|
||||
"created_at": "2022-03-16T06:35:16.000000Z",
|
||||
"updated_at": "2022-03-16T11:42:01.000000Z",
|
||||
"is_user_following": true,
|
||||
"is_member": 0,
|
||||
"is_requested": false
|
||||
},
|
||||
"chaturmas_info": {
|
||||
"id": 1,
|
||||
"year": 2020,
|
||||
"from": "2022-01-17",
|
||||
"to": "2022-01-26",
|
||||
"created_by": 1,
|
||||
"updated_by": 1,
|
||||
"created_at": "2022-01-21T06:51:43.000000Z",
|
||||
"updated_at": "2022-01-22T10:46:51.000000Z"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 16,
|
||||
"sant_id": 1,
|
||||
"chaturmas_date_id": 2,
|
||||
"place": "Derasar",
|
||||
"start_date": null,
|
||||
"end_date": null,
|
||||
"year": null,
|
||||
"created_by": {
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"mobile": "12"
|
||||
},
|
||||
"updated_by": null,
|
||||
"created_at": "2022-01-28T10:56:08.000000Z",
|
||||
"updated_at": "2022-01-28T10:56:08.000000Z",
|
||||
"created_ago": "2 hours ago",
|
||||
"updated_ago": "2 hours ago",
|
||||
"chaturmas_info": {
|
||||
"id": 2,
|
||||
"year": 2022,
|
||||
"from": "2022-01-06",
|
||||
"to": "2022-01-21",
|
||||
"created_by": 1,
|
||||
"updated_by": null,
|
||||
"created_at": "2022-01-27T09:10:34.000000Z",
|
||||
"updated_at": "2022-01-27T09:10:34.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="chaturmas-year"></a>
|
||||
## Add
|
||||
|
||||
List for chaturmas year api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/chaturmas-year` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": [
|
||||
{
|
||||
"year": 2020,
|
||||
"id": 1
|
||||
},
|
||||
{
|
||||
"year": 2022,
|
||||
"id": 2
|
||||
}
|
||||
],
|
||||
"message": "Get chaturmas successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="hundred-chaturmas-year"></a>
|
||||
## Hundred Chaturmas Years
|
||||
|
||||
List for hundred chaturmas year api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/hundred-chaturmas-years` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": [
|
||||
{
|
||||
"id": "1922",
|
||||
"value": "1922"
|
||||
},
|
||||
{
|
||||
"id": "1923",
|
||||
"value": "1923"
|
||||
},
|
||||
{
|
||||
"id": "1924",
|
||||
"value": "1924"
|
||||
},
|
||||
{
|
||||
"id": "1925",
|
||||
"value": "1925"
|
||||
},
|
||||
],
|
||||
"message": "Get chaturmas successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
<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` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
place:Derasar
|
||||
year:1
|
||||
sant_id:1
|
||||
sangh_id:1
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"place": "Derasar",
|
||||
"chaturmas_date_id": "2",
|
||||
"sant_id": "2",
|
||||
"sangh_id": "1",
|
||||
"created_by": {
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"mobile": "12"
|
||||
},
|
||||
"updated_at": "2022-01-28T11:51:06.000000Z",
|
||||
"created_at": "2022-01-28T11:51:06.000000Z",
|
||||
"created_ago": "1 second ago",
|
||||
"updated_ago": "1 second ago",
|
||||
"id": 22,
|
||||
"chaturmas_info": {
|
||||
"id": 2,
|
||||
"year": 2022,
|
||||
"from": "2022-01-06",
|
||||
"to": "2022-01-21",
|
||||
"created_by": 1,
|
||||
"updated_by": null,
|
||||
"created_at": "2022-01-27T09:10:34.000000Z",
|
||||
"updated_at": "2022-01-27T09:10:34.000000Z"
|
||||
},
|
||||
"updated_by": null
|
||||
},
|
||||
"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/{id}` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
place:Derasar 22
|
||||
year:1
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"id": 15,
|
||||
"sant_id": 1,
|
||||
"sangh_id": "1",
|
||||
"chaturmas_date_id": 1,
|
||||
"place": "Derasar 2",
|
||||
"start_date": null,
|
||||
"end_date": null,
|
||||
"year": null,
|
||||
"created_by": {
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"mobile": "12"
|
||||
},
|
||||
"updated_by": {
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"mobile": "12"
|
||||
},
|
||||
"created_at": "2022-01-28T07:35:07.000000Z",
|
||||
"updated_at": "2021-12-28T10:53:03.000000Z",
|
||||
"created_ago": "6 hours ago",
|
||||
"updated_ago": "1 month ago",
|
||||
"chaturmas_info": {
|
||||
"id": 1,
|
||||
"year": 2020,
|
||||
"from": "2022-01-17",
|
||||
"to": "2022-01-26",
|
||||
"created_by": 1,
|
||||
"updated_by": 1,
|
||||
"created_at": "2022-01-21T06:51:43.000000Z",
|
||||
"updated_at": "2022-01-22T10:46:51.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/1` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"id": 15,
|
||||
"sant_id": 1,
|
||||
"chaturmas_date_id": 1,
|
||||
"place": "Derasar 2",
|
||||
"start_date": null,
|
||||
"end_date": null,
|
||||
"year": null,
|
||||
"created_by": 1,
|
||||
"updated_by": 1,
|
||||
"created_at": "2022-01-28T07:35:07.000000Z",
|
||||
"updated_at": "2021-12-28T10:53:03.000000Z",
|
||||
"created_ago": "6 hours ago",
|
||||
"updated_ago": "1 month ago",
|
||||
"chaturmas_info": {
|
||||
"id": 1,
|
||||
"year": 2020,
|
||||
"from": "2022-01-17",
|
||||
"to": "2022-01-26",
|
||||
"created_by": 1,
|
||||
"updated_by": 1,
|
||||
"created_at": "2022-01-21T06:51:43.000000Z",
|
||||
"updated_at": "2022-01-22T10:46:51.000000Z"
|
||||
}
|
||||
},
|
||||
"message": "Get chaturmas successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 403,
|
||||
"error": "Chaturmas already exist for this year",
|
||||
"success": false
|
||||
}
|
||||
```
|
||||
|
||||
233
resources/docs/1.0/common.md
Normal file
233
resources/docs/1.0/common.md
Normal file
@@ -0,0 +1,233 @@
|
||||
# API Docs
|
||||
|
||||
<a name="list"></a>
|
||||
## List
|
||||
|
||||
Dropdown list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/common/dropdown` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": {
|
||||
"sangh_types": [
|
||||
{
|
||||
"id": 1,
|
||||
"value": "Sthanak"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"value": "Derasar"
|
||||
}
|
||||
],
|
||||
"derasar_type": [
|
||||
{
|
||||
"id": 1,
|
||||
"value": "Shikhar Mandir"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"value": "Without Shikhar"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"value": "Ghar Derasar"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"value": "Derasar only"
|
||||
}
|
||||
],
|
||||
"mulnayak_bhagwan": [
|
||||
{
|
||||
"id": 1,
|
||||
"value": "Shree Rishabhnath Swami"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"value": "Shree Ajitnath Swami"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"value": "Shree Sambhavnath Swami"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"value": "Shree Abhinandan Swami"
|
||||
},
|
||||
{
|
||||
"id": 5,
|
||||
"value": "Shree Sumatinath Swami"
|
||||
},
|
||||
{
|
||||
"id": 6,
|
||||
"value": "Shree Padmaprabhu Swami"
|
||||
},
|
||||
{
|
||||
"id": 7,
|
||||
"value": "Shree Suparshvanath Swami"
|
||||
},
|
||||
{
|
||||
"id": 8,
|
||||
"value": "Shree Chandraprabhu Swami"
|
||||
},
|
||||
{
|
||||
"id": 9,
|
||||
"value": "Shree Pushpadant Swami"
|
||||
},
|
||||
{
|
||||
"id": 10,
|
||||
"value": "Shree Sheetalnath Swami"
|
||||
},
|
||||
{
|
||||
"id": 11,
|
||||
"value": "Shree Shreyanshnath Swami"
|
||||
},
|
||||
{
|
||||
"id": 12,
|
||||
"value": "Shree Vasupujanath Swami"
|
||||
},
|
||||
{
|
||||
"id": 13,
|
||||
"value": "Shree Vimalnath Swami"
|
||||
},
|
||||
{
|
||||
"id": 14,
|
||||
"value": "Shree Anantnath Swami"
|
||||
},
|
||||
{
|
||||
"id": 15,
|
||||
"value": "Shree Dharmanath Swami"
|
||||
},
|
||||
{
|
||||
"id": 16,
|
||||
"value": "Shree Shantinath Swami"
|
||||
},
|
||||
{
|
||||
"id": 17,
|
||||
"value": "Shree Kunthunath Swami"
|
||||
},
|
||||
{
|
||||
"id": 18,
|
||||
"value": "Shree Arahnath Swami"
|
||||
},
|
||||
{
|
||||
"id": 19,
|
||||
"value": "Shree Mallinath Swami"
|
||||
},
|
||||
{
|
||||
"id": 20,
|
||||
"value": "Shree Munisuvratnath Swami"
|
||||
},
|
||||
{
|
||||
"id": 21,
|
||||
"value": "Shree Naminath Swami"
|
||||
},
|
||||
{
|
||||
"id": 22,
|
||||
"value": "Shree Neminath Swami"
|
||||
},
|
||||
{
|
||||
"id": 23,
|
||||
"value": "Shree Parshwanath Swami"
|
||||
},
|
||||
{
|
||||
"id": 24,
|
||||
"value": "Shree Vardhaman Mahavir Swami"
|
||||
},
|
||||
{
|
||||
"id": 25,
|
||||
"value": "Shree Simandhar Swami"
|
||||
}
|
||||
],
|
||||
"number_of_members": [
|
||||
{
|
||||
"id": 1,
|
||||
"value": "0 - 100"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"value": "100 - 500"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"value": "500 - 1000"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"value": "1000+"
|
||||
}
|
||||
],
|
||||
"number_of_students": [
|
||||
{
|
||||
"id": 1,
|
||||
"value": "0 - 100"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"value": "100 - 200"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"value": "200 - 500"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"value": "500+"
|
||||
}
|
||||
],
|
||||
"number_of_books": [
|
||||
{
|
||||
"id": 1,
|
||||
"value": "0 - 100"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"value": "100 - 500"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"value": "500 - 1000"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"value": "1000+"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
99
resources/docs/1.0/country.md
Normal file
99
resources/docs/1.0/country.md
Normal file
@@ -0,0 +1,99 @@
|
||||
# API Docs
|
||||
|
||||
<a name="list"></a>
|
||||
## List
|
||||
|
||||
Details for country list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/countries` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"countries": [
|
||||
{
|
||||
"id": 1,
|
||||
"iso": "AF",
|
||||
"name": "Afghanistan",
|
||||
"iso3": "AFG",
|
||||
"num_code": "4",
|
||||
"phone_code": "+93",
|
||||
"created_at": "2022-01-05T06:31:56.000000Z",
|
||||
"updated_at": "2022-01-05T06:31:56.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"iso": "AL",
|
||||
"name": "Albania",
|
||||
"iso3": "ALB",
|
||||
"num_code": "8",
|
||||
"phone_code": "+355",
|
||||
"created_at": "2022-01-05T06:31:56.000000Z",
|
||||
"updated_at": "2022-01-05T06:31:56.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"iso": "DZ",
|
||||
"name": "Algeria",
|
||||
"iso3": "DZA",
|
||||
"num_code": "12",
|
||||
"phone_code": "+213",
|
||||
"created_at": "2022-01-05T06:31:56.000000Z",
|
||||
"updated_at": "2022-01-05T06:31:56.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"iso": "AS",
|
||||
"name": "American Samoa",
|
||||
"iso3": "ASM",
|
||||
"num_code": "16",
|
||||
"phone_code": "+1684",
|
||||
"created_at": "2022-01-05T06:31:56.000000Z",
|
||||
"updated_at": "2022-01-05T06:31:56.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 5,
|
||||
"iso": "AD",
|
||||
"name": "Andorra",
|
||||
"iso3": "AND",
|
||||
"num_code": "20",
|
||||
"phone_code": "+376",
|
||||
"created_at": "2022-01-05T06:31:56.000000Z",
|
||||
"updated_at": "2022-01-05T06:31:56.000000Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
77
resources/docs/1.0/dharma.md
Normal file
77
resources/docs/1.0/dharma.md
Normal file
@@ -0,0 +1,77 @@
|
||||
# API Docs
|
||||
|
||||
<a name="list"></a>
|
||||
## List
|
||||
|
||||
Details for dharma list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/dharma-detail` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Deravasi",
|
||||
"created_at": "2022-01-05T06:31:55.000000Z",
|
||||
"updated_at": "2022-01-05T06:31:55.000000Z",
|
||||
"deleted_at": null
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "Sthanakvasi",
|
||||
"created_at": "2022-01-05T06:31:55.000000Z",
|
||||
"updated_at": "2022-01-05T06:31:55.000000Z",
|
||||
"deleted_at": null
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"name": "Terapanthi",
|
||||
"created_at": "2022-01-05T06:31:55.000000Z",
|
||||
"updated_at": "2022-01-05T06:31:55.000000Z",
|
||||
"deleted_at": null
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"name": "Digambar",
|
||||
"created_at": "2022-01-05T06:31:56.000000Z",
|
||||
"updated_at": "2022-01-05T06:31:56.000000Z",
|
||||
"deleted_at": null
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
488
resources/docs/1.0/global.md
Normal file
488
resources/docs/1.0/global.md
Normal file
@@ -0,0 +1,488 @@
|
||||
# API Docs
|
||||
|
||||
<a name="sharavak"></a>
|
||||
## List
|
||||
|
||||
Details for global search for sharavak
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/user/global/user-list` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
page:1
|
||||
name:Jain
|
||||
dharma_id[]:2
|
||||
jati_id[]:2
|
||||
latitude:23.0133
|
||||
longitude:72.5308
|
||||
native_latitude:23.0133
|
||||
native_longitude:72.5308
|
||||
range=5
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": {
|
||||
"current_page": 1,
|
||||
"data": [
|
||||
{
|
||||
"id": 46,
|
||||
"uuid": "f37892ab-915a-4a6b-ba20-6b0cd82693e3",
|
||||
"name": "Test Jain",
|
||||
"email": null,
|
||||
"email_hash": null,
|
||||
"username": "teja415u",
|
||||
"country_code": "91",
|
||||
"mobile": "9632587418",
|
||||
"dharma_id": 2,
|
||||
"birth_date": "1999-01-11",
|
||||
"gender": null,
|
||||
"email_verified_at": null,
|
||||
"mobile_verified_at": null,
|
||||
"avatar": "http://global-jain.test/images/misc/placeholder.png",
|
||||
"school_name": null,
|
||||
"about": null,
|
||||
"relationship": 0,
|
||||
"is_passive": 0,
|
||||
"parent_id": 0,
|
||||
"verification_confirmed": 2,
|
||||
"status": 1,
|
||||
"mobile_privacy": 1,
|
||||
"email_privacy": 1,
|
||||
"avatar_privacy": 1,
|
||||
"birth_date_privacy": 1,
|
||||
"gender_privacy": 1,
|
||||
"dharma_privacy": 1,
|
||||
"karma_dhan": 0,
|
||||
"timezone": null,
|
||||
"last_login_at": null,
|
||||
"last_login_ip": null,
|
||||
"profile_statistics": null,
|
||||
"created_at": "2022-04-04T05:22:01.000000Z",
|
||||
"updated_at": "2022-04-04T05:22:01.000000Z",
|
||||
"deleted_at": null,
|
||||
"unread_message_count": 0,
|
||||
"unread_notification_count": 0,
|
||||
"is_friends": 0,
|
||||
"hide_mobile": "963****418",
|
||||
"is_user_friends": 0,
|
||||
"dharma": {
|
||||
"id": 2,
|
||||
"name": "Sthanakvasi",
|
||||
"created_at": "2022-01-20T11:12:23.000000Z",
|
||||
"updated_at": "2022-01-20T11:12:23.000000Z",
|
||||
"deleted_at": null
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 48,
|
||||
"uuid": "0188b7a9-5ef1-4640-b00f-99e1bfeb75a6",
|
||||
"name": "Test Jain",
|
||||
"email": null,
|
||||
"email_hash": null,
|
||||
"username": "teja4f7b",
|
||||
"country_code": "91",
|
||||
"mobile": "9632587416",
|
||||
"dharma_id": 2,
|
||||
"birth_date": "0000-00-00",
|
||||
"gender": null,
|
||||
"email_verified_at": null,
|
||||
"mobile_verified_at": null,
|
||||
"avatar": "http://global-jain.test/images/misc/placeholder.png",
|
||||
"school_name": null,
|
||||
"about": null,
|
||||
"relationship": 0,
|
||||
"is_passive": 0,
|
||||
"parent_id": 0,
|
||||
"verification_confirmed": 2,
|
||||
"status": 1,
|
||||
"mobile_privacy": 1,
|
||||
"email_privacy": 1,
|
||||
"avatar_privacy": 1,
|
||||
"birth_date_privacy": 1,
|
||||
"gender_privacy": 1,
|
||||
"dharma_privacy": 1,
|
||||
"karma_dhan": 0,
|
||||
"timezone": null,
|
||||
"last_login_at": null,
|
||||
"last_login_ip": null,
|
||||
"profile_statistics": null,
|
||||
"created_at": "2022-04-05T06:14:47.000000Z",
|
||||
"updated_at": "2022-04-05T06:14:47.000000Z",
|
||||
"deleted_at": null,
|
||||
"unread_message_count": 0,
|
||||
"unread_notification_count": 0,
|
||||
"is_friends": 0,
|
||||
"hide_mobile": "963****416",
|
||||
"is_user_friends": 0,
|
||||
"dharma": {
|
||||
"id": 2,
|
||||
"name": "Sthanakvasi",
|
||||
"created_at": "2022-01-20T11:12:23.000000Z",
|
||||
"updated_at": "2022-01-20T11:12:23.000000Z",
|
||||
"deleted_at": null
|
||||
}
|
||||
}
|
||||
],
|
||||
"first_page_url": "http://global-jain.test/api/v1/user/global/user-list?page=1",
|
||||
"from": 1,
|
||||
"last_page": 2,
|
||||
"last_page_url": "http://global-jain.test/api/v1/user/global/user-list?page=2",
|
||||
"links": [
|
||||
{
|
||||
"url": null,
|
||||
"label": "« Previous",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/user/global/user-list?page=1",
|
||||
"label": "1",
|
||||
"active": true
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/user/global/user-list?page=2",
|
||||
"label": "2",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/user/global/user-list?page=2",
|
||||
"label": "Next »",
|
||||
"active": false
|
||||
}
|
||||
],
|
||||
"next_page_url": "http://global-jain.test/api/v1/user/global/user-list?page=2",
|
||||
"path": "http://global-jain.test/api/v1/user/global/user-list",
|
||||
"per_page": 10,
|
||||
"prev_page_url": null,
|
||||
"to": 10,
|
||||
"total": 13
|
||||
},
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
<a name="sant"></a>
|
||||
## List
|
||||
|
||||
Details for global search for sant
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/user/global/sant-list` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
page:1
|
||||
name:Jain
|
||||
dharma_id[]:2
|
||||
sampraday_id[]:2
|
||||
range=5
|
||||
```
|
||||
|
||||
```php
|
||||
{
|
||||
"data": {
|
||||
"current_page": 1,
|
||||
"data": [
|
||||
{
|
||||
"id": 1,
|
||||
"user_id": 1,
|
||||
"name": "Emi Brock",
|
||||
"father_name": "Dominic Gilmore",
|
||||
"mother_name": "Connor Mcguire",
|
||||
"guru_name": null,
|
||||
"gender": 1,
|
||||
"avatar": "http://global-jain.test/images/misc/placeholder.png",
|
||||
"honor": [
|
||||
"aa"
|
||||
],
|
||||
"qualification": "Consequuntur dicta n",
|
||||
"dharma_id": 2,
|
||||
"sampraday_id": 1,
|
||||
"guru_id": null,
|
||||
"birth_date": "2000-01-21",
|
||||
"diksha_date": "2000-01-21",
|
||||
"diksha_place": "Iusto temporibus ex",
|
||||
"about": "Iusto debitis quis v",
|
||||
"status": 1,
|
||||
"verification_status": null,
|
||||
"reviewed_fields": null,
|
||||
"description": null,
|
||||
"profile_verified_at": null,
|
||||
"created_by": 1,
|
||||
"updated_by": 1,
|
||||
"created_at": "2022-01-20T11:14:47.000000Z",
|
||||
"updated_at": "2022-01-20T11:30:36.000000Z",
|
||||
"deleted_at": null,
|
||||
"current_thana_id": null,
|
||||
"age": 22,
|
||||
"diksha_year": 22,
|
||||
"is_user_following": false,
|
||||
"dharm": {
|
||||
"id": 2,
|
||||
"name": "Sthanakvasi",
|
||||
"created_at": "2022-01-20T11:12:23.000000Z",
|
||||
"updated_at": "2022-01-20T11:12:23.000000Z",
|
||||
"deleted_at": null
|
||||
},
|
||||
"sampraday": {
|
||||
"id": 1,
|
||||
"dharma_id": 3,
|
||||
"name": "Harriet Powers",
|
||||
"status": 0,
|
||||
"sant_id": 1,
|
||||
"created_by": 1,
|
||||
"updated_by": 1,
|
||||
"created_at": "2022-01-20T11:14:32.000000Z",
|
||||
"updated_at": "2022-03-01T06:58:05.000000Z"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 10,
|
||||
"user_id": 1,
|
||||
"name": "shreedhar",
|
||||
"father_name": "father_nameq",
|
||||
"mother_name": "mother_nameqw",
|
||||
"guru_name": null,
|
||||
"gender": 1,
|
||||
"avatar": "http://global-jain.test/images/misc/placeholder.png",
|
||||
"honor": [
|
||||
"honorqw"
|
||||
],
|
||||
"qualification": "qualification",
|
||||
"dharma_id": 2,
|
||||
"sampraday_id": 1,
|
||||
"guru_id": 1,
|
||||
"birth_date": "2000-01-21",
|
||||
"diksha_date": "2000-01-23",
|
||||
"diksha_place": "diksha_place",
|
||||
"about": "about",
|
||||
"status": 2,
|
||||
"verification_status": null,
|
||||
"reviewed_fields": null,
|
||||
"description": null,
|
||||
"profile_verified_at": null,
|
||||
"created_by": 1,
|
||||
"updated_by": null,
|
||||
"created_at": "2022-01-20T12:51:54.000000Z",
|
||||
"updated_at": "2022-01-20T12:51:54.000000Z",
|
||||
"deleted_at": null,
|
||||
"current_thana_id": null,
|
||||
"age": 22,
|
||||
"diksha_year": 22,
|
||||
"is_user_following": false,
|
||||
"dharm": {
|
||||
"id": 2,
|
||||
"name": "Sthanakvasi",
|
||||
"created_at": "2022-01-20T11:12:23.000000Z",
|
||||
"updated_at": "2022-01-20T11:12:23.000000Z",
|
||||
"deleted_at": null
|
||||
},
|
||||
"sampraday": {
|
||||
"id": 1,
|
||||
"dharma_id": 3,
|
||||
"name": "Harriet Powers",
|
||||
"status": 0,
|
||||
"sant_id": 1,
|
||||
"created_by": 1,
|
||||
"updated_by": 1,
|
||||
"created_at": "2022-01-20T11:14:32.000000Z",
|
||||
"updated_at": "2022-03-01T06:58:05.000000Z"
|
||||
}
|
||||
}
|
||||
],
|
||||
"first_page_url": "http://global-jain.test/api/v1/user/global/sant-list?page=1",
|
||||
"from": 1,
|
||||
"last_page": 3,
|
||||
"last_page_url": "http://global-jain.test/api/v1/user/global/sant-list?page=3",
|
||||
"links": [
|
||||
{
|
||||
"url": null,
|
||||
"label": "« Previous",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/user/global/sant-list?page=1",
|
||||
"label": "1",
|
||||
"active": true
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/user/global/sant-list?page=2",
|
||||
"label": "2",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/user/global/sant-list?page=3",
|
||||
"label": "3",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/user/global/sant-list?page=2",
|
||||
"label": "Next »",
|
||||
"active": false
|
||||
}
|
||||
],
|
||||
"next_page_url": "http://global-jain.test/api/v1/user/global/sant-list?page=2",
|
||||
"path": "http://global-jain.test/api/v1/user/global/sant-list",
|
||||
"per_page": 10,
|
||||
"prev_page_url": null,
|
||||
"to": 10,
|
||||
"total": 30
|
||||
},
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
<a name="sangh"></a>
|
||||
## List
|
||||
|
||||
Details for global search for sangh
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/user/global/sangh-list` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
page:1
|
||||
name:Jain
|
||||
dharma_id[]:2
|
||||
sampraday_id[]:2
|
||||
range=5
|
||||
latitude:23.0133
|
||||
longitude:72.5308
|
||||
```
|
||||
|
||||
```php
|
||||
{
|
||||
"data": {
|
||||
"current_page": 1,
|
||||
"data": [
|
||||
{
|
||||
"id": 1,
|
||||
"user_id": 1,
|
||||
"name": "Sangh Test 1",
|
||||
"dharma_id": 2,
|
||||
"sampraday_id": 1,
|
||||
"reg_number": "1E50SA4A4D",
|
||||
"reg_date": "2022-02-15",
|
||||
"address": "asdawfwaf, afaafsfef,afaasfgdfa",
|
||||
"city": "Ahmedabad",
|
||||
"pincode": 380056,
|
||||
"longitude": "12.00441",
|
||||
"latitude": "10.00441",
|
||||
"about": "About Sangh",
|
||||
"avatar": "http://global-jain.test/storage/images/sanghs/medium/3911647430921.png",
|
||||
"created_by": 1,
|
||||
"updated_by": 1,
|
||||
"created_at": "2022-03-16T06:35:16.000000Z",
|
||||
"updated_at": "2022-03-16T11:42:01.000000Z",
|
||||
"is_user_following": true,
|
||||
"is_member": 0,
|
||||
"is_requested": false,
|
||||
"dharma": {
|
||||
"id": 2,
|
||||
"name": "Sthanakvasi",
|
||||
"created_at": "2022-01-20T11:12:23.000000Z",
|
||||
"updated_at": "2022-01-20T11:12:23.000000Z",
|
||||
"deleted_at": null
|
||||
},
|
||||
"sampraday": {
|
||||
"id": 1,
|
||||
"dharma_id": 3,
|
||||
"name": "Harriet Powers",
|
||||
"status": 0,
|
||||
"sant_id": 1,
|
||||
"created_by": 1,
|
||||
"updated_by": 1,
|
||||
"created_at": "2022-01-20T11:14:32.000000Z",
|
||||
"updated_at": "2022-03-01T06:58:05.000000Z"
|
||||
}
|
||||
}
|
||||
],
|
||||
"first_page_url": "http://global-jain.test/api/v1/user/global/sangh-list?page=1",
|
||||
"from": 1,
|
||||
"last_page": 1,
|
||||
"last_page_url": "http://global-jain.test/api/v1/user/global/sangh-list?page=1",
|
||||
"links": [
|
||||
{
|
||||
"url": null,
|
||||
"label": "« Previous",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/user/global/sangh-list?page=1",
|
||||
"label": "1",
|
||||
"active": true
|
||||
},
|
||||
{
|
||||
"url": null,
|
||||
"label": "Next »",
|
||||
"active": false
|
||||
}
|
||||
],
|
||||
"next_page_url": null,
|
||||
"path": "http://global-jain.test/api/v1/user/global/sangh-list",
|
||||
"per_page": 10,
|
||||
"prev_page_url": null,
|
||||
"to": 3,
|
||||
"total": 3
|
||||
},
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
84
resources/docs/1.0/hospital-certificate-details.md
Normal file
84
resources/docs/1.0/hospital-certificate-details.md
Normal file
@@ -0,0 +1,84 @@
|
||||
# API Docs
|
||||
|
||||
<a name="list"></a>
|
||||
## List
|
||||
|
||||
Details for Hospital Generated Certificate
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/hospital/certificate/details` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": {
|
||||
"id": 21,
|
||||
"user_id": 7,
|
||||
"hospital_id": 1,
|
||||
"full_name": "dhaval joshi",
|
||||
"address": "Ahmedabad",
|
||||
"email": "dahval@gmail.com",
|
||||
"medical_problem": "Health issue",
|
||||
"aadhar_card_number": 124578979972,
|
||||
"profile_photo": "2221719389350.jpeg",
|
||||
"aadhar_card_front_photo": "4791719389350.jpeg",
|
||||
"aadhar_card_back_photo": "7151719389350.jpeg",
|
||||
"status": 0,
|
||||
"rejection_reason": null,
|
||||
"generated_date": null,
|
||||
"created_at": "2024-06-26T08:09:10.000000Z",
|
||||
"updated_at": "2024-06-26T08:09:10.000000Z",
|
||||
"expire_date": "",
|
||||
"is_expired": false,
|
||||
"hospital": {
|
||||
"id": 1,
|
||||
"name": "Shree Evershine Paradise Shwetamber Murtipujak Tapagach Sangh",
|
||||
"contact_name": "Tejas Jain",
|
||||
"email": "arhamvasupujya@gmail.com",
|
||||
"alternative_email": "arhamvasupujya@gmail.com",
|
||||
"address": "120, Feet Road, Thakur Village, Opp. Viceroy Court, kandivali(East), Mumbai - 400 101",
|
||||
"city": "Mumbai",
|
||||
"state": "maharashtra",
|
||||
"photo": null,
|
||||
"benefits": "10% discount",
|
||||
"status": 1,
|
||||
"created_at": "2024-06-26T06:00:20.000000Z",
|
||||
"updated_at": "2024-06-26T06:00:20.000000Z"
|
||||
}
|
||||
},
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `500`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
|
||||
76
resources/docs/1.0/hospital-certificate-generate.md
Normal file
76
resources/docs/1.0/hospital-certificate-generate.md
Normal file
@@ -0,0 +1,76 @@
|
||||
# API Docs
|
||||
|
||||
<a name="list"></a>
|
||||
## List
|
||||
|
||||
Details for Hospital Certificate Generate
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/hospital/certificate/generate` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"hospital_id" : 1,
|
||||
"full_name" : "dhaval joshi",
|
||||
"address" : "Ahmedabad",
|
||||
"email" : "dahval@gmail.com",
|
||||
"medical_problem" : "Health issue",
|
||||
"aadhar_card_number" : 124578979977,
|
||||
"profile_photo" : "profile.jpg",
|
||||
"aadhar_card_front_photo" : "front.jpg",
|
||||
"aadhar_card_back_photo" : "back.jpg"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Certificate generate request sent successfully.",
|
||||
"data": {
|
||||
"user_id": 7,
|
||||
"hospital_id": "1",
|
||||
"full_name": "dhaval joshi",
|
||||
"address": "Ahmedabad",
|
||||
"email": "dahval@gmail.com",
|
||||
"medical_problem": "Health issue",
|
||||
"aadhar_card_number": "124578979972",
|
||||
"profile_photo": "3311719384669.jpeg",
|
||||
"aadhar_card_front_photo": "9091719384670.jpeg",
|
||||
"aadhar_card_back_photo": "5541719384670.jpeg",
|
||||
"updated_at": "2024-06-26T06:51:10.000000Z",
|
||||
"created_at": "2024-06-26T06:51:10.000000Z",
|
||||
"id": 20
|
||||
},
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `500`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!",
|
||||
"status": 500
|
||||
}
|
||||
```
|
||||
|
||||
56
resources/docs/1.0/hospital-listing.md
Normal file
56
resources/docs/1.0/hospital-listing.md
Normal file
@@ -0,0 +1,56 @@
|
||||
# API Docs
|
||||
|
||||
<a name="list"></a>
|
||||
## List
|
||||
|
||||
Details for Hospitals list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/hospitals` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Shree Evershine Paradise Shwetamber Murtipujak Tapagach Sangh",
|
||||
"area" : "ahmedabad"
|
||||
}
|
||||
],
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
|
||||
183
resources/docs/1.0/index.md
Normal file
183
resources/docs/1.0/index.md
Normal file
@@ -0,0 +1,183 @@
|
||||
- ## Get Started
|
||||
- [Overview](/{{route}}/{{version}}/overview)
|
||||
- [Common](/{{route}}/{{version}}/common)
|
||||
|
||||
- ## Authentication API
|
||||
- [Login](#login)
|
||||
- [Social Login](#social-login)
|
||||
- [Register](#register)
|
||||
- [Email verification](#email-verification)
|
||||
- [Reset Password](#reset-password)
|
||||
- [Set Password](#set-password)
|
||||
- [Logout](#logout)
|
||||
- [User Exist](#user-exist)
|
||||
- [Delete Account](#delete-account)
|
||||
|
||||
- ## Shravak (User) API
|
||||
- [Global Search](/{{route}}/{{version}}/user#global-search)
|
||||
- [List](/{{route}}/{{version}}/user#list)
|
||||
- [Profession](/{{route}}/{{version}}/user#designation)
|
||||
- [Public Profile](/{{route}}/{{version}}/user#public-profile)
|
||||
- [View Profile](/{{route}}/{{version}}/user#detail)
|
||||
- [Update Profile](/{{route}}/{{version}}/user#update)
|
||||
- [User Following](/{{route}}/{{version}}/user#user-following)
|
||||
- [Add Child User](/{{route}}/{{version}}/user#add-child)
|
||||
- [Update Child User](/{{route}}/{{version}}/user#update-child)
|
||||
- [Remove Child User](/{{route}}/{{version}}/user#remove-child)
|
||||
- [Show Child User](/{{route}}/{{version}}/user#show-child)
|
||||
- [Delete Work Details](/{{route}}/{{version}}/user#delete-work)
|
||||
- [Delete Qualification Details](/{{route}}/{{version}}/user#delete-qualification)
|
||||
- [Block Profile List](/{{route}}/{{version}}/user#blocked-list)
|
||||
- [Block Profile](/{{route}}/{{version}}/user#block-profile)
|
||||
|
||||
- ## Sant API
|
||||
- [List](/{{route}}/{{version}}/sant#list)
|
||||
- [Father List](/{{route}}/{{version}}/sant#father-list)
|
||||
- [Mother List](/{{route}}/{{version}}/sant#mother-list)
|
||||
- [Add](/{{route}}/{{version}}/sant#add)
|
||||
- [Update](/{{route}}/{{version}}/sant#update)
|
||||
- [Show Info](/{{route}}/{{version}}/sant#show)
|
||||
- [Get In Review Sant](/{{route}}/{{version}}/sant#in-review)
|
||||
- [In Review Sant Detail](/{{route}}/{{version}}/sant#in-review-sant-detail)
|
||||
- [Get User Sant](/{{route}}/{{version}}/sant#user-sant)
|
||||
- [Sant Follow](/{{route}}/{{version}}/sant#sant-follow)
|
||||
- [Sant Suggestion](/{{route}}/{{version}}/sant#sant-suggestion)
|
||||
- [Update Location](/{{route}}/{{version}}/sant#sant-location)
|
||||
|
||||
- ## Sangh API
|
||||
- [List](/{{route}}/{{version}}/sangh#list)
|
||||
- [Add](/{{route}}/{{version}}/sangh#add)
|
||||
- [Update](/{{route}}/{{version}}/sangh#update)
|
||||
- [Show Info](/{{route}}/{{version}}/sangh#show)
|
||||
- [User List](/{{route}}/{{version}}/sangh#user-list)
|
||||
- [Add Sangh Members](/{{route}}/{{version}}/sangh#add-member)
|
||||
- [Update Sangh Member](/{{route}}/{{version}}/sangh#update-member)
|
||||
- [Delete Sangh Member](/{{route}}/{{version}}/sangh#delete-member)
|
||||
- [Sangh Suggestion](/{{route}}/{{version}}/sangh#sangh-suggestion)
|
||||
- [Sangh List (User Member)](/{{route}}/{{version}}/sangh#user-sangh)
|
||||
- [Sangh Follow](/{{route}}/{{version}}/sangh#sangh-follow)
|
||||
- [Sangh Following List](/{{route}}/{{version}}/sangh#sangh-following)
|
||||
- [List Followers Of Sangh](/{{route}}/{{version}}/sangh#sangh-followers)
|
||||
- [List Invited Members](/{{route}}/{{version}}/sangh#invited-member)
|
||||
- [Accept/Reject Member Request](/{{route}}/{{version}}/sangh#accept-member-request)
|
||||
- [Associated Sangh List](/{{route}}/{{version}}/sangh#associated-sangh-list)
|
||||
|
||||
- ## Dharma API
|
||||
- [List](/{{route}}/{{version}}/dharma#dharma-list)
|
||||
|
||||
- ## Mother Tongue API
|
||||
- [List](/{{route}}/{{version}}/mother-tongue#list)
|
||||
|
||||
- ## Blood Group API
|
||||
- [List](/{{route}}/{{version}}/blood-group#list)
|
||||
|
||||
- ## Country API
|
||||
- [List](/{{route}}/{{version}}/country#country-list)
|
||||
|
||||
- ## Jati API
|
||||
- [List](/{{route}}/{{version}}/jati#list)
|
||||
- [Add](/{{route}}/{{version}}/jati#add)
|
||||
|
||||
- ## Vihar API
|
||||
- [List](/{{route}}/{{version}}/vihar#list)
|
||||
- [Add](/{{route}}/{{version}}/vihar#add)
|
||||
- [Update](/{{route}}/{{version}}/vihar#update)
|
||||
- [Show Info](/{{route}}/{{version}}/vihar#show)
|
||||
- [Delete](/{{route}}/{{version}}/vihar#delete)
|
||||
|
||||
- ## Chaturmas API
|
||||
- [Chaturmas Year](/{{route}}/{{version}}/chaturmas#chaturmas-year)
|
||||
- [List](/{{route}}/{{version}}/chaturmas#list)
|
||||
- [Add](/{{route}}/{{version}}/chaturmas#add)
|
||||
- [Update](/{{route}}/{{version}}/chaturmas#update)
|
||||
- [Show Info](/{{route}}/{{version}}/chaturmas#show)
|
||||
- [Hundred Chaturmas Year](/{{route}}/{{version}}/chaturmas#hundred-chaturmas-year)
|
||||
|
||||
- ## Chaturmas Review API
|
||||
- [List](/{{route}}/{{version}}/chaturmas-review#list)
|
||||
- [Add](/{{route}}/{{version}}/chaturmas-review#add)
|
||||
- [Update](/{{route}}/{{version}}/chaturmas-review#update)
|
||||
- [Show Info](/{{route}}/{{version}}/chaturmas-review#show)
|
||||
|
||||
- ## Sampraday API
|
||||
- [List](/{{route}}/{{version}}/sampraday#sampraday-list)
|
||||
|
||||
- ## Friend Request API
|
||||
- [List](/{{route}}/{{version}}/request#list)
|
||||
- [Sent Request List](/{{route}}/{{version}}/request#sent-list)
|
||||
- [Send](/{{route}}/{{version}}/request#send-request)
|
||||
- [Accept/Decline](/{{route}}/{{version}}/request#accept-request)
|
||||
- [My Friend List](/{{route}}/{{version}}/request#friend-list)
|
||||
|
||||
- ## Relationshihp Request API
|
||||
- [Relationship List](/{{route}}/{{version}}/relationship#relationship-list)
|
||||
- [List](/{{route}}/{{version}}/relationship#list)
|
||||
- [Sent Request List](/{{route}}/{{version}}/relationship#sent-list)
|
||||
- [Send](/{{route}}/{{version}}/relationship#send-request)
|
||||
- [Accept/Decline](/{{route}}/{{version}}/relationship#accept-request)
|
||||
- [Update Relation Ship](/{{route}}/{{version}}/relationship#update-request)
|
||||
|
||||
- ## Message API
|
||||
- [Send Message](/{{route}}/{{version}}/message#send-message)
|
||||
- [Message Thread List](/{{route}}/{{version}}/message#message-thread-list)
|
||||
- [Message List](/{{route}}/{{version}}/message#message-list)
|
||||
- [Search Message](/{{route}}/{{version}}/message#search-message)
|
||||
- [Clear Message](/{{route}}/{{version}}/message#clear-message)
|
||||
- [Delete Message Thread](/{{route}}/{{version}}/message#delete-thread)
|
||||
|
||||
- ## Post API
|
||||
- [List Post Category](/{{route}}/{{version}}/post#category-list)
|
||||
- [List](/{{route}}/{{version}}/post#list)
|
||||
- [User Post List](/{{route}}/{{version}}/post#user-post-list)
|
||||
- [User Draft Post](/{{route}}/{{version}}/post#user-draft-list)
|
||||
- [Add Post](/{{route}}/{{version}}/post#add-post)
|
||||
- [Update Post](/{{route}}/{{version}}/post#update-post)
|
||||
- [Delete Post](/{{route}}/{{version}}/post#delete-post)
|
||||
- [Info Post](/{{route}}/{{version}}/post#info-post)
|
||||
- [Like Post](/{{route}}/{{version}}/post#post-like)
|
||||
- [Add Comment](/{{route}}/{{version}}/post#add-comment)
|
||||
- [Update Comment](/{{route}}/{{version}}/post#update-comment)
|
||||
- [Delete Comment](/{{route}}/{{version}}/post#delete-comment)
|
||||
- [Get Post Comment](/{{route}}/{{version}}/post#post-comment-list)
|
||||
- [Hide Post](/{{route}}/{{version}}/post#post-hide)
|
||||
|
||||
- ## Hospitals
|
||||
- [Listing](/{{route}}/{{version}}/hospital-listing)
|
||||
- [Certificate Generate](/{{route}}/{{version}}/hospital-certificate-generate)
|
||||
- [Certificate Details](/{{route}}/{{version}}/hospital-certificate-details)
|
||||
- ## Sant Post API
|
||||
- [List](/{{route}}/{{version}}/sant-post#list)
|
||||
- [Sant Post List](/{{route}}/{{version}}/sant-post#sant-post-list)
|
||||
- [Add Sant Post](/{{route}}/{{version}}/sant-post#add-post)
|
||||
- [Update Sant Post](/{{route}}/{{version}}/sant-post#update-post)
|
||||
- [Delete Sant Post](/{{route}}/{{version}}/sant-post#delete-post)
|
||||
- [Info Sant Post](/{{route}}/{{version}}/sant-post#info-post)
|
||||
- [Sant Feed](/{{route}}/{{version}}/sant-post#sant-feed)
|
||||
|
||||
- ## Sangh Post API
|
||||
- [Sangh Post List](/{{route}}/{{version}}/sangh-post#sangh-post-list)
|
||||
|
||||
- ## Notification API
|
||||
- [Add Device Token](/{{route}}/{{version}}/notifications#store-device-token)
|
||||
- [Delete Device Token](/{{route}}/{{version}}/notifications#delete-device-token)
|
||||
- [Delete Existing Device Token](/{{route}}/{{version}}/notifications#delete-existing-token)
|
||||
- [List](/{{route}}/{{version}}/notifications#list)
|
||||
- [Unread Count](/{{route}}/{{version}}/notifications#unread-counts)
|
||||
- [Delete](/{{route}}/{{version}}/notifications#delete-notification)
|
||||
|
||||
- ## Thana API
|
||||
- [List Of Sant Thana](/{{route}}/{{version}}/thana#list)
|
||||
- [Add Member](/{{route}}/{{version}}/thana#add)
|
||||
- [Delete Member](/{{route}}/{{version}}/thana#delete)
|
||||
- [Thana Member](/{{route}}/{{version}}/thana#thana-member)
|
||||
|
||||
- ## Global Search
|
||||
- [Sharavak](/{{route}}/{{version}}/global#sharavak)
|
||||
- [Sant](/{{route}}/{{version}}/global#sant)
|
||||
- [Sangh](/{{route}}/{{version}}/global#sangh)
|
||||
|
||||
- ## Report API
|
||||
- [Report](/{{route}}/{{version}}/report#report)
|
||||
|
||||
- ## Privacy API
|
||||
- [Privacy](/{{route}}/{{version}}/privacy#informative-page)
|
||||
112
resources/docs/1.0/jati.md
Normal file
112
resources/docs/1.0/jati.md
Normal file
@@ -0,0 +1,112 @@
|
||||
# API Docs
|
||||
|
||||
<a name="list"></a>
|
||||
## List
|
||||
|
||||
Details for jati list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/jati-detail` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
{
|
||||
"dharma_id" : "1"
|
||||
}
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Jalawadi Dasha Shrimali",
|
||||
"status": 1,
|
||||
"created_by": 1,
|
||||
"updated_by": null,
|
||||
"created_at": "2022-01-12T06:05:29.000000Z",
|
||||
"updated_at": "2022-01-12T06:05:29.000000Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="add"></a>
|
||||
## Add
|
||||
|
||||
Details for add jati api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `user/add-jati` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"name": "XYZ"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Jati added successfully!",
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Jati already exist!",
|
||||
"status": 403
|
||||
}
|
||||
```
|
||||
|
||||
346
resources/docs/1.0/message.md
Normal file
346
resources/docs/1.0/message.md
Normal file
@@ -0,0 +1,346 @@
|
||||
<a name="send-message"></a>
|
||||
## Send message information
|
||||
|
||||
Details for the sending message information
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint only should not include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/user/send-message` | Authorization : Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"receiver_id" : 1,
|
||||
"message" : "Hello",
|
||||
"type": 0,
|
||||
"status": 0
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"notification": {
|
||||
"userToken": "1|jdbQbjnknDdvfNkcasqdscdvAxvsv",
|
||||
"title": "Anurag", // or "New Message" (if the user is not registered)
|
||||
"body": "Hello",
|
||||
"avatar": "http://fssevefesgvsv.jpg",
|
||||
"extraData": {
|
||||
"id": 1,
|
||||
"avatar": "http://fssevefesgvsv.jpg",
|
||||
"user_id": 104,
|
||||
"name": "Anurag",
|
||||
"unread_count": 2,
|
||||
"message": "Hello",
|
||||
"created_at": "2020-08-12 04:38:40",
|
||||
"os": "Android",
|
||||
"type": "New Message"
|
||||
}
|
||||
},
|
||||
"message": "Message sent successfully!"
|
||||
}
|
||||
```
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403` or `404`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
<a name="message-thread-list"></a>
|
||||
## Message thread list information
|
||||
|
||||
Details for the message thread list information
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint only should not include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/user/message-thread-list` | Authorization : Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"name": "Man"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 1,
|
||||
"user_id": 1,
|
||||
"avatar": null,
|
||||
"avatar_url": null,
|
||||
"name": "Superadmin",
|
||||
"created_at": "2020/08/12 04:38:40",
|
||||
"message": "Hello",
|
||||
"unread_count": 0
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403` or `404`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="message-list"></a>
|
||||
## Message list information
|
||||
|
||||
Details for the message list information
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint only should not include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/user/message-list/{receiver_id}` | Authorization : Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
1 //Receiver's Id
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": {
|
||||
"current_page": 1,
|
||||
"data": [
|
||||
{
|
||||
"user_id": 104,
|
||||
"message": "Hello",
|
||||
"created_at": "2020-08-12T04:38:40.000000Z"
|
||||
},
|
||||
{
|
||||
"user_id": 104,
|
||||
"message": "Hey",
|
||||
"created_at": "2020-08-10T11:27:52.000000Z"
|
||||
}
|
||||
],
|
||||
"first_page_url": "http://127.0.0.1:8000/api/v1/user/message-list/1?page=1",
|
||||
"from": 1,
|
||||
"last_page": 1,
|
||||
"last_page_url": "http://127.0.0.1:8000/api/v1/user/message-list/1?page=1",
|
||||
"next_page_url": null,
|
||||
"path": "http://127.0.0.1:8000/api/v1/user/message-list/1",
|
||||
"per_page": 20,
|
||||
"prev_page_url": null,
|
||||
"to": 2,
|
||||
"total": 2
|
||||
}
|
||||
}
|
||||
```
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403` or `404`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="search-message"></a>
|
||||
## Search message information
|
||||
|
||||
Details for the search message information
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint only should not include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/user/search-message/{receiver_id}` | Authorization : Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
1 //Receiver's Id
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"message":"he"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": [
|
||||
{
|
||||
"user_id": 104,
|
||||
"message": "Hey",
|
||||
"created_at": "2020-08-10T11:27:52.000000Z"
|
||||
},
|
||||
{
|
||||
"user_id": 104,
|
||||
"message": "Hello",
|
||||
"created_at": "2020-08-12T04:38:40.000000Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403` or `404`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="clear-message"></a>
|
||||
## Clear message information
|
||||
|
||||
Details for the clear message information
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint only should not include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| DELETE | `/user/clear-message/{receiver_id}` | Authorization : Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
1 //Receiver's Id
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Messages cleared successfully!"
|
||||
}
|
||||
```
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403` or `404`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="delete-thread"></a>
|
||||
## Delete message thread information
|
||||
|
||||
Details for the delete message thread information
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint only should not include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| DELETE | `/user/delete-thread/{receiver_id}` | Authorization : Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
1 //Receiver's Id
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Message thread deleted successfully!"
|
||||
}
|
||||
```
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403` or `404`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
141
resources/docs/1.0/mother-tongue.md
Normal file
141
resources/docs/1.0/mother-tongue.md
Normal file
@@ -0,0 +1,141 @@
|
||||
# API Docs
|
||||
|
||||
<a name="list"></a>
|
||||
## List
|
||||
|
||||
Details for mother tongue list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `user/mother-tongue` | Authorization : Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Hindi",
|
||||
"status": 1, //0: Inactive, 1// Active
|
||||
"created_at": "2022-02-24T08:52:53.000000Z",
|
||||
"updated_at": "2022-02-24T08:52:53.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "Gujarati",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-24T08:52:53.000000Z",
|
||||
"updated_at": "2022-02-24T08:52:53.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"name": "Rajasthani",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-24T08:52:53.000000Z",
|
||||
"updated_at": "2022-02-24T08:52:53.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"name": "Malayalam",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-24T08:52:53.000000Z",
|
||||
"updated_at": "2022-02-24T08:52:53.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 5,
|
||||
"name": "Panjabi",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-24T08:52:53.000000Z",
|
||||
"updated_at": "2022-02-24T08:52:53.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 6,
|
||||
"name": "Tamil",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-24T08:52:53.000000Z",
|
||||
"updated_at": "2022-02-24T08:52:53.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 7,
|
||||
"name": "Bangla",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-24T08:52:53.000000Z",
|
||||
"updated_at": "2022-02-24T08:52:53.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 8,
|
||||
"name": "Oriya",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-24T08:52:53.000000Z",
|
||||
"updated_at": "2022-02-24T08:52:53.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 9,
|
||||
"name": "Marathi",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-24T08:52:53.000000Z",
|
||||
"updated_at": "2022-02-24T08:52:53.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 10,
|
||||
"name": "Konkani",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-24T08:52:53.000000Z",
|
||||
"updated_at": "2022-02-24T08:52:53.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 11,
|
||||
"name": "Kannada",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-24T08:52:53.000000Z",
|
||||
"updated_at": "2022-02-24T08:52:53.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 12,
|
||||
"name": "Telugu",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-24T08:52:53.000000Z",
|
||||
"updated_at": "2022-02-24T08:52:53.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 13,
|
||||
"name": "Other",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-24T08:52:53.000000Z",
|
||||
"updated_at": "2022-02-24T08:52:53.000000Z"
|
||||
}
|
||||
],
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
320
resources/docs/1.0/notifications.md
Normal file
320
resources/docs/1.0/notifications.md
Normal file
@@ -0,0 +1,320 @@
|
||||
<a name="store-device-token"></a>
|
||||
## Push Notification Register information
|
||||
|
||||
Details for the push notification register information
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/user/store-device-token` | Authorization : Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"os":"android",
|
||||
"device_id":"5449785443479876464346464",
|
||||
"fcm_token":"rda456487sdsaddasda457a8da78ad9a4aew4e6w87eqw9e9qw446qw5e78e9"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
|
||||
```php
|
||||
{
|
||||
"message": "Device Token Saved Successfully!"
|
||||
"status": 200,
|
||||
}
|
||||
```
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403` or `404`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
"status": 403,
|
||||
}
|
||||
```
|
||||
|
||||
<a name="delete-device-token"></a>
|
||||
## Delete device token
|
||||
|
||||
Details for delete device token api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/user/delete-device-token` | Authorization : Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"os":1, //1: Andriod, 2: ios
|
||||
"device_id":"5449785443479876464346464"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
|
||||
```php
|
||||
{
|
||||
"message": "Device Token Deleted Successfully!"
|
||||
"status": 200,
|
||||
}
|
||||
```
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403` or `404`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Token not found!"
|
||||
"status": 403,
|
||||
}
|
||||
```
|
||||
|
||||
<a name="delete-existing-token"></a>
|
||||
## Delete existing device token
|
||||
|
||||
Details for delete existing device token api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/user/delete-existing-token` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"os": 1, //1: Andriod, 2: ios
|
||||
"device_id": "5449785443479876464346464"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
|
||||
```php
|
||||
{
|
||||
"message": "Device Token Deleted Successfully!"
|
||||
"status": 200,
|
||||
}
|
||||
```
|
||||
|
||||
<a name="list"></a>
|
||||
## Notification list
|
||||
|
||||
Details for the notification list information
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/user/notification-list` | Authorization : Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
|
||||
```php
|
||||
{
|
||||
"current_page": 1,
|
||||
"last_page": 1,
|
||||
"per_page": 10,
|
||||
"next_page_url": null,
|
||||
"last_page_url": "http://127.0.0.1:8000/api/v1/user/notification-list?page=1",
|
||||
"total": 5,
|
||||
"count": 5,
|
||||
"prev_page_url": null,
|
||||
"hasMorePages": false,
|
||||
"data": {
|
||||
"current_page": 1,
|
||||
"data": [
|
||||
{
|
||||
"id": 9,
|
||||
"user_id": 2,
|
||||
"title": "Your friend request has been accepted by Admin!",
|
||||
"type": "FriendRequestAccepted",
|
||||
"message": "Admin accepted your friend request!",
|
||||
"extra_fields": {
|
||||
"name": "Test",
|
||||
"avatar": "http://127.0.0.1:8000/images/misc/placeholder.png",
|
||||
"from_id": 1,
|
||||
"created_at": "2022/02/17 16:15:39"
|
||||
},
|
||||
"status": "0",
|
||||
"created_at": "2022/02/17 16:15:39",
|
||||
"updated_at": "2022-02-17T10:45:39.000000Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403` or `404`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="unread-counts"></a>
|
||||
## Unread notification & messages count
|
||||
|
||||
Details for the unread notification & messages count information
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/user/unread-counts` | Authorization : Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": {
|
||||
"unread_message_count": 1,
|
||||
"unread_notification_count": 0
|
||||
},
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403` or `404`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
"status": 403
|
||||
}
|
||||
```
|
||||
|
||||
<a name="delete-notification"></a>
|
||||
## Delete notification information
|
||||
|
||||
Details for the delete notification information
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/user/delete-notification/{id}` | Authorization : Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
1 //Notification Id
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Notification deleted successfully!"
|
||||
}
|
||||
```
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403` or `404`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
499
resources/docs/1.0/overview.md
Normal file
499
resources/docs/1.0/overview.md
Normal file
@@ -0,0 +1,499 @@
|
||||
# API Docs
|
||||
|
||||
<a name="login"></a>
|
||||
## Login
|
||||
|
||||
Details for login api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/login` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"email" : "4513098763",
|
||||
"via" : "PASSWORD", // PASSWORD / OTP
|
||||
"password" :"abcdefgh",
|
||||
"verified" : "1",
|
||||
"app_version" : "1",
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"type": 1, //1: E-mail 2: Contact number
|
||||
"email": "test.user@global.jain",
|
||||
"country_code": "-",
|
||||
"mobile": "-",
|
||||
"email_preview": "t********@g*****.jain",
|
||||
"message": "Please check your phone for OTP."
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `401`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "This contact does not exist!"
|
||||
}
|
||||
```
|
||||
<a name="social-login"></a>
|
||||
## Login via Facebook
|
||||
|
||||
Details for Login via Facebook api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint only should not include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/social-login` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"email":"test@globaljain.com",
|
||||
"id":"12345",
|
||||
"provider":"facebook",
|
||||
"name":"GJ Test"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"token": "3|kUpw8msHyXbND275RNIv2KlyBnQE7ltECWRO3Flc",
|
||||
"user": {
|
||||
"id": 3,
|
||||
"name": "GJ Test",
|
||||
"email": "test@globaljain.com",
|
||||
"country_code": null,
|
||||
"mobile": null,
|
||||
"email_preview": "t***@g*********.com",
|
||||
"avatar_url": null,
|
||||
"is_profile_verified": null,
|
||||
"login_type": 1,
|
||||
"unread_message_count": null,
|
||||
"unread_notification_count": null
|
||||
},
|
||||
"message": "Logged in succesfully.",
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!",
|
||||
"status": 403
|
||||
}
|
||||
```
|
||||
|
||||
<a name="register"></a>
|
||||
## Register
|
||||
|
||||
Details for Registration api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/register` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"name" : "Test User",
|
||||
"email" : "4513098763",
|
||||
"country_code" : "91",
|
||||
"dharma" : 2, //Dharma ID
|
||||
"birth_date" : "1999/01/11",
|
||||
"password" : "abcdefgh",
|
||||
"password_confirmation" : "abcdefgh"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"user": {
|
||||
"id": 2,
|
||||
"name": "Test User",
|
||||
"email": "test.user@global.jain",
|
||||
"country_code": null,
|
||||
"mobile": null,
|
||||
"email_preview": "t********@g*****.jain",
|
||||
"avatar_url": null,
|
||||
"is_profile_verified": null,
|
||||
"login_type": 0, //0: Normal, 1: Social Media
|
||||
"unread_message_count": null,
|
||||
"unread_notification_count": null
|
||||
},
|
||||
"message": "Check your mobile number for otp and verify."
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `400`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "This contact already exists!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="reset-password"></a>
|
||||
## Reset Password
|
||||
|
||||
Details for Reset Password api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/user/reset/password` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"current_password" : "abcdefgh",
|
||||
"new_password" : "12345678",
|
||||
"confirm_password" : "12345678"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"message": "Password has been updated"
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `400`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "The given data was invalid.",
|
||||
"errors": {
|
||||
"new_password": [
|
||||
"The new password and confirm password must match."
|
||||
]
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
<a name="set-password"></a>
|
||||
## Set Password
|
||||
|
||||
Details for Reset Password api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/set/password` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"country_code" : "+91",
|
||||
"mobile" : "9632587410",
|
||||
"new_password" : "abcdefgh",
|
||||
"confirm_password" : "abcdefgha"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"message": "Password has been updated"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="email-verification"></a>
|
||||
## Email verification
|
||||
|
||||
Details for Email verification through OTP api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/email-verification` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"otp": "151545",
|
||||
"email": "test.user@global.jain"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"token": "1|ZqTjAV0RipnxnFiVEdgrGjSxzublx8SEQ12WeRUj",
|
||||
"user": {
|
||||
"id": 2,
|
||||
"name": "Test User",
|
||||
"email": "test.user@global.jain",
|
||||
"country_code": null,
|
||||
"mobile": null,
|
||||
"email_preview": "t********@g*****.jain",
|
||||
"avatar_url": null,
|
||||
"is_profile_verified": null,
|
||||
"login_type": 0, //0: Normal, 1: Social Media
|
||||
"unread_message_count": null,
|
||||
"unread_notification_count": null
|
||||
},
|
||||
"message": "OTP code has been verified.",
|
||||
"success": true
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Please provide a valid OTP code.",
|
||||
"success": false
|
||||
}
|
||||
```
|
||||
|
||||
<a name="logout"></a>
|
||||
## Logout
|
||||
|
||||
Details for logout api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/user/logout` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Logged out."
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `404`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "User not found."
|
||||
}
|
||||
```
|
||||
|
||||
<a name="user-exist"></a>
|
||||
## User Exist
|
||||
|
||||
Details for user-exist api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/user/exist` | |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"country_code" : "+91"
|
||||
"mobile" : "9426596321"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true
|
||||
}
|
||||
```
|
||||
|
||||
<a name="delete-account"></a>
|
||||
## Delete Shravak Account Details
|
||||
|
||||
Details of delete shravak profile details
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `user/delete-account` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Account deleted successfully.",
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "You can\'t delete this account, Please add or update the sangh admin in which you are associated!",
|
||||
"status": 403
|
||||
}
|
||||
```
|
||||
1028
resources/docs/1.0/post.md
Normal file
1028
resources/docs/1.0/post.md
Normal file
File diff suppressed because it is too large
Load Diff
50
resources/docs/1.0/privacy.md
Normal file
50
resources/docs/1.0/privacy.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# API Docs
|
||||
|
||||
<a name="informative-page"></a>
|
||||
## Privacy
|
||||
|
||||
Details for privacy page api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `user/informative-page` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
{
|
||||
"page" : "privacy_policy"
|
||||
}
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
RENDERED HTML PAGE
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
416
resources/docs/1.0/relationship.md
Normal file
416
resources/docs/1.0/relationship.md
Normal file
@@ -0,0 +1,416 @@
|
||||
# API Docs
|
||||
|
||||
<a name="relationship-list"></a>
|
||||
## Relationship List
|
||||
|
||||
Details for relationship list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `user/relationship-list` | Bearer {Token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Father",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-10T08:43:05.000000Z",
|
||||
"updated_at": "2022-02-10T08:43:05.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "Mother",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-10T08:43:05.000000Z",
|
||||
"updated_at": "2022-02-10T08:43:05.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"name": "Brother",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-10T08:43:05.000000Z",
|
||||
"updated_at": "2022-02-10T08:43:05.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"name": "Sister",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-10T08:43:05.000000Z",
|
||||
"updated_at": "2022-02-10T08:43:05.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 5,
|
||||
"name": "Grandfather",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-10T08:43:05.000000Z",
|
||||
"updated_at": "2022-02-10T08:43:05.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 6,
|
||||
"name": "Grandmother",
|
||||
"status": 1,
|
||||
"created_at": "2022-02-10T08:43:05.000000Z",
|
||||
"updated_at": "2022-02-10T08:43:05.000000Z"
|
||||
}
|
||||
],
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
"status": 403
|
||||
}
|
||||
```
|
||||
|
||||
<a name="list"></a>
|
||||
## Relationship Request List
|
||||
|
||||
Details for relationship request list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `user/relation-request-list` | Bearer {Token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 43,
|
||||
"from_id": 2,
|
||||
"to_id": 1,
|
||||
"relation_id": 3,
|
||||
"status": 0,
|
||||
"created_at": "2022-02-15T09:09:16.000000Z",
|
||||
"updated_at": "2022-02-15T09:09:47.000000Z",
|
||||
"sent_users": {
|
||||
"id": 1,
|
||||
"uuid": "d5ad39bc-44e8-4661-a4b7-ee6f9913c14d",
|
||||
"name": "Admin",
|
||||
"email": "admin@globaljain.com",
|
||||
"email_hash": "be382c3392bfb101cf67ebfe39eb398c",
|
||||
"username": "Admin",
|
||||
"country_code": null,
|
||||
"mobile": null,
|
||||
"dharma_id": null,
|
||||
"birth_date": null,
|
||||
"gender": 2,
|
||||
"email_verified_at": "2022-02-10T08:41:54.000000Z",
|
||||
"mobile_verified_at": "2022-02-10T08:41:54.000000Z",
|
||||
"avatar": "http://127.0.0.1:8000/images/misc/placeholder.png",
|
||||
"verification_confirmed": 2,
|
||||
"status": 2,
|
||||
"mobile_privacy": 1,
|
||||
"email_privacy": 1,
|
||||
"avatar_privacy": 1,
|
||||
"birth_date_privacy": 1,
|
||||
"gender_privacy": 1,
|
||||
"dharma_privacy": 1,
|
||||
"timezone": "",
|
||||
"last_login_at": null,
|
||||
"last_login_ip": "",
|
||||
"created_at": "2022-02-10T08:41:54.000000Z",
|
||||
"updated_at": "2022-02-10T08:41:54.000000Z",
|
||||
"deleted_at": null
|
||||
}
|
||||
}
|
||||
],
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
"status": 403
|
||||
}
|
||||
```
|
||||
|
||||
<a name="sent-list"></a>
|
||||
## Sent Realtionship Request List
|
||||
|
||||
Details for sent relationship request list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `user/sent-relation-request-list` | Bearer {Token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 44,
|
||||
"from_id": 2,
|
||||
"to_id": 2,
|
||||
"relation_id": 4,
|
||||
"status": 0,
|
||||
"created_at": "2022-02-15T09:09:47.000000Z",
|
||||
"updated_at": "2022-02-15T09:09:47.000000Z",
|
||||
"sent_users": {
|
||||
"id": 2,
|
||||
"uuid": "1e2f763e-0d67-4cff-9aa1-242c81f4dd34",
|
||||
"name": "Test",
|
||||
"email": "test.jain@example.com",
|
||||
"email_hash": "0e61a0eb2db1efa1f3ed12ef717faaea",
|
||||
"username": "15",
|
||||
"country_code": null,
|
||||
"mobile": null,
|
||||
"dharma_id": 1,
|
||||
"birth_date": "1997-05-10",
|
||||
"gender": 1,
|
||||
"email_verified_at": null,
|
||||
"mobile_verified_at": null,
|
||||
"avatar": "http://127.0.0.1:8000/images/misc/placeholder.png",
|
||||
"verification_confirmed": 2,
|
||||
"status": 2,
|
||||
"mobile_privacy": 1,
|
||||
"email_privacy": 1,
|
||||
"avatar_privacy": 1,
|
||||
"birth_date_privacy": 1,
|
||||
"gender_privacy": 1,
|
||||
"dharma_privacy": 1,
|
||||
"timezone": null,
|
||||
"last_login_at": null,
|
||||
"last_login_ip": null,
|
||||
"created_at": "2022-02-10T09:43:06.000000Z",
|
||||
"updated_at": "2022-02-10T09:43:37.000000Z",
|
||||
"deleted_at": null
|
||||
}
|
||||
}
|
||||
],
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
"status": 403
|
||||
}
|
||||
```
|
||||
|
||||
<a name="send-request"></a>
|
||||
## Relationship Request Send
|
||||
|
||||
Details for send relation request api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `user/send-relation-request` | Bearer {Token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"to_id" : 1,
|
||||
"relation_id": 3
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Relation request sent successfully.",
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
"status": 403
|
||||
}
|
||||
```
|
||||
|
||||
<a name="accept-request"></a>
|
||||
## Relationship Request Accept/Decline
|
||||
|
||||
Details for relation request accept/decline api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `user/accept-relation-request` | Bearer {Token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"from_id" : 2,
|
||||
"status": 1 // 1: Accept, 2: Decline
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Relation request accepted successfully.",
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
<a name="update-request"></a>
|
||||
## Relationship Request update
|
||||
|
||||
Details for relation request update api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `user/update-relation-request/{id}` | Bearer {Token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"relation" : "Name",
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Relationship update successfully..",
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
"status": 403
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
54
resources/docs/1.0/report.md
Normal file
54
resources/docs/1.0/report.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# 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!"
|
||||
}
|
||||
```
|
||||
369
resources/docs/1.0/request.md
Normal file
369
resources/docs/1.0/request.md
Normal file
@@ -0,0 +1,369 @@
|
||||
# API Docs
|
||||
|
||||
<a name="list"></a>
|
||||
## Request List
|
||||
|
||||
Details for friend request list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `user/request-list` | Bearer {Token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 11,
|
||||
"sender_id": 4,
|
||||
"receiver_id": 2,
|
||||
"status": 0,
|
||||
"created_at": "2022-01-20T10:31:33.000000Z",
|
||||
"updated_at": "2022-01-20T10:40:16.000000Z",
|
||||
"deleted_at": null,
|
||||
"users": {
|
||||
"id": 4,
|
||||
"uuid": "58330871-16c3-4843-97d7-d3ee371446da",
|
||||
"name": "Test",
|
||||
"email": "test@gj.com",
|
||||
"email_hash": "9e77c62b589b3ae5ea0d9ea58b907bfa",
|
||||
"username": "42",
|
||||
"country_code": null,
|
||||
"mobile": null,
|
||||
"dharma_id": 3,
|
||||
"birth_date": "1997-05-10",
|
||||
"gender": null,
|
||||
"email_verified_at": null,
|
||||
"mobile_verified_at": null,
|
||||
"avatar": null,
|
||||
"verification_confirmed": 1,
|
||||
"status": 1,
|
||||
"timezone": null,
|
||||
"last_login_at": null,
|
||||
"last_login_ip": null,
|
||||
"created_at": "2022-01-20T10:44:41.000000Z",
|
||||
"updated_at": "2022-01-20T10:44:41.000000Z",
|
||||
"deleted_at": null
|
||||
}
|
||||
}
|
||||
],
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
"status": 403
|
||||
}
|
||||
```
|
||||
|
||||
<a name="sent-list"></a>
|
||||
## Sent Request List
|
||||
|
||||
Details for sent friend request list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `user/sent-request-list` | Bearer {Token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 11,
|
||||
"sender_id": 2,
|
||||
"receiver_id": 4,
|
||||
"status": 0,
|
||||
"created_at": "2022-01-20T10:31:33.000000Z",
|
||||
"updated_at": "2022-01-20T10:40:16.000000Z",
|
||||
"deleted_at": null,
|
||||
"users": {
|
||||
"id": 4,
|
||||
"uuid": "58330871-16c3-4843-97d7-d3ee371446da",
|
||||
"name": "Test",
|
||||
"email": "test@gj.com",
|
||||
"email_hash": "9e77c62b589b3ae5ea0d9ea58b907bfa",
|
||||
"username": "42",
|
||||
"country_code": null,
|
||||
"mobile": null,
|
||||
"dharma_id": 3,
|
||||
"birth_date": "1997-05-10",
|
||||
"gender": null,
|
||||
"email_verified_at": null,
|
||||
"mobile_verified_at": null,
|
||||
"avatar": null,
|
||||
"verification_confirmed": 1,
|
||||
"status": 1,
|
||||
"timezone": null,
|
||||
"last_login_at": null,
|
||||
"last_login_ip": null,
|
||||
"created_at": "2022-01-20T10:44:41.000000Z",
|
||||
"updated_at": "2022-01-20T10:44:41.000000Z",
|
||||
"deleted_at": null
|
||||
}
|
||||
}
|
||||
],
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
"status": 403
|
||||
}
|
||||
```
|
||||
|
||||
<a name="accept-request"></a>
|
||||
## Friend Request Accept/Decline
|
||||
|
||||
Details for request accept/decline api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `user/accept-request` | Bearer {Token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"receiver_id" : "2",
|
||||
"status" : 1
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Friend request accepted successfully.",
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
"status": 403
|
||||
}
|
||||
```
|
||||
|
||||
<a name="send-request"></a>
|
||||
## Friend Request Send
|
||||
|
||||
Details for send request api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `user/send-request` | Bearer {Token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"receiver_id" : "3"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Friend request sent successfully.",
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
"status": 403
|
||||
}
|
||||
```
|
||||
|
||||
<a name="friend-list"></a>
|
||||
## My Friend List
|
||||
|
||||
Details for my friend list
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `user/friend-list` | Bearer {Token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 3,
|
||||
"name": "Name",
|
||||
"avatar": "http://global-jain.test/storage/images/users/1643351730.png",
|
||||
"is_friend_request_sent": true,
|
||||
"pivot": {
|
||||
"sender_id": 1,
|
||||
"receiver_id": 3,
|
||||
"created_at": "2022-02-18T06:23:14.000000Z",
|
||||
"updated_at": "2022-02-18T06:23:34.000000Z",
|
||||
"status": 1
|
||||
},
|
||||
"user_detail": [
|
||||
{
|
||||
"id": 1,
|
||||
"user_id": 3,
|
||||
"jati_id": 1,
|
||||
"profession": "0",
|
||||
"profession_speciality": "aaaaa",
|
||||
"location": null,
|
||||
"longitude": null,
|
||||
"latitude": null,
|
||||
"native_place": null,
|
||||
"native_longitude": null,
|
||||
"native_latitude": null,
|
||||
"mother_tongue": null,
|
||||
"marital_status": null,
|
||||
"marriage_anniversary": null,
|
||||
"qualification": null,
|
||||
"company_name": null,
|
||||
"mother_tongue_privacy": 1,
|
||||
"jati_privacy": 1,
|
||||
"marital_status_privacy": 1,
|
||||
"marriage_anniversary_privacy": 1,
|
||||
"location_privacy": 1,
|
||||
"native_place_privacy": 1,
|
||||
"qualification_privacy": 1,
|
||||
"profession_privacy": 1,
|
||||
"company_name_privacy": 1,
|
||||
"profession_speciality_privacy": 1,
|
||||
"created_at": "2022-01-28T06:35:31.000000Z",
|
||||
"updated_at": "2022-01-28T06:35:31.000000Z",
|
||||
"deleted_at": null
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "Admina",
|
||||
"avatar": "http://global-jain.test/images/misc/placeholder.png",
|
||||
"is_friend_request_sent": true,
|
||||
"pivot": {
|
||||
"sender_id": 1,
|
||||
"receiver_id": 2,
|
||||
"created_at": "2022-02-18T06:23:14.000000Z",
|
||||
"updated_at": "2022-02-18T06:23:34.000000Z",
|
||||
"status": 1
|
||||
},
|
||||
"user_detail": []
|
||||
}
|
||||
],
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
70
resources/docs/1.0/sampraday.md
Normal file
70
resources/docs/1.0/sampraday.md
Normal file
@@ -0,0 +1,70 @@
|
||||
# API Docs
|
||||
|
||||
<a name="list"></a>
|
||||
## List
|
||||
|
||||
Details for sampraday list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `user/sampraday-list` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"dharma_id" : "3"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": [
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Test",
|
||||
"status": 0,
|
||||
"created_by": 1,
|
||||
"updated_by": null,
|
||||
"created_at": "2022-01-13T09:10:58.000000Z",
|
||||
"updated_at": "2022-01-13T09:10:58.000000Z"
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"name": "Test2",
|
||||
"status": 0,
|
||||
"created_by": 1,
|
||||
"updated_by": null,
|
||||
"created_at": "2022-01-13T09:11:10.000000Z",
|
||||
"updated_at": "2022-01-13T09:11:10.000000Z"
|
||||
}
|
||||
],
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
134
resources/docs/1.0/sangh-post.md
Normal file
134
resources/docs/1.0/sangh-post.md
Normal file
@@ -0,0 +1,134 @@
|
||||
# API Docs
|
||||
|
||||
<a name="sangh-post-list"></a>
|
||||
## List
|
||||
|
||||
Details for sant post list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/sangh/user/post` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"page" : "2",
|
||||
"limit" : "2",
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": {
|
||||
"current_page": 1,
|
||||
"data": [
|
||||
{
|
||||
"id": 34,
|
||||
"user_id": 1,
|
||||
"category_id": 1,
|
||||
"privacy": 1,
|
||||
"status": 1,
|
||||
"description": "a",
|
||||
"created_by": {
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"avatar": "http://global-jain.test/storage/images/users/medium/6451644991774.png",
|
||||
"created_at": "2022-01-20T11:12:23.000000Z",
|
||||
"updated_at": "2022-03-02T13:34:34.000000Z",
|
||||
"is_friends": 0
|
||||
},
|
||||
"updated_by": null,
|
||||
"location": "Ah",
|
||||
"type": 3,
|
||||
"type_id": 1,
|
||||
"created_at": "2022-03-16T06:37:48.000000Z",
|
||||
"updated_at": "2022-03-16T06:37:48.000000Z",
|
||||
"likes_count": 0,
|
||||
"comments_count": 0,
|
||||
"created_ago": "25 minutes ago",
|
||||
"is_friends": false,
|
||||
"is_liked": false,
|
||||
"tag_users": [
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"avatar": "http://global-jain.test/storage/images/users/medium/6451644991774.png",
|
||||
"is_friends": 0,
|
||||
"pivot": {
|
||||
"post_id": 34,
|
||||
"user_id": 1,
|
||||
"created_at": "2022-03-16T06:37:48.000000Z",
|
||||
"updated_at": "2022-03-16T06:37:48.000000Z"
|
||||
}
|
||||
}
|
||||
],
|
||||
"post_images": [],
|
||||
"category": {
|
||||
"id": 1,
|
||||
"parent_id": 0,
|
||||
"name": "Dharmik",
|
||||
"description": null,
|
||||
"created_at": "2022-01-31T12:28:34.000000Z",
|
||||
"updated_at": "2022-01-31T12:28:34.000000Z"
|
||||
},
|
||||
"likes": []
|
||||
}
|
||||
],
|
||||
"first_page_url": "http://global-jain.test/api/v1/sangh/user/post?page=1",
|
||||
"from": 1,
|
||||
"last_page": 1,
|
||||
"last_page_url": "http://global-jain.test/api/v1/sangh/user/post?page=1",
|
||||
"links": [
|
||||
{
|
||||
"url": null,
|
||||
"label": "« Previous",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/sangh/user/post?page=1",
|
||||
"label": "1",
|
||||
"active": true
|
||||
},
|
||||
{
|
||||
"url": null,
|
||||
"label": "Next »",
|
||||
"active": false
|
||||
}
|
||||
],
|
||||
"next_page_url": null,
|
||||
"path": "http://global-jain.test/api/v1/sangh/user/post",
|
||||
"per_page": "1",
|
||||
"prev_page_url": null,
|
||||
"to": 1,
|
||||
"total": 1
|
||||
},
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
1644
resources/docs/1.0/sangh.md
Normal file
1644
resources/docs/1.0/sangh.md
Normal file
File diff suppressed because it is too large
Load Diff
704
resources/docs/1.0/sant-post.md
Normal file
704
resources/docs/1.0/sant-post.md
Normal file
@@ -0,0 +1,704 @@
|
||||
# API Docs
|
||||
|
||||
<a name="list"></a>
|
||||
## List
|
||||
|
||||
Details for post list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/sant/post` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"page" : "2"
|
||||
"type_id" : "2" // id of Sant
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": {
|
||||
"current_page": 1,
|
||||
"data": [
|
||||
{
|
||||
"id": 27,
|
||||
"user_id": 1,
|
||||
"category_id": 1,
|
||||
"privacy": 1,
|
||||
"status": 2,
|
||||
"description": "a",
|
||||
"created_by": {
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"avatar": "http://global-jain.test/images/misc/placeholder.png",
|
||||
"created_at": "2022-01-20T11:12:23.000000Z",
|
||||
"updated_at": "2022-02-17T13:11:44.000000Z",
|
||||
"is_friend_request_sent": false
|
||||
},
|
||||
"updated_by": null,
|
||||
"location": "Ah",
|
||||
"type": 2,
|
||||
"type_id": 2,
|
||||
"created_at": "2022-02-18T08:36:00.000000Z",
|
||||
"updated_at": "2022-02-18T08:36:00.000000Z",
|
||||
"likes_count": 0,
|
||||
"created_ago": "57 minutes ago",
|
||||
"tag_users": [
|
||||
{
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"avatar": "http://global-jain.test/images/misc/placeholder.png",
|
||||
"is_friend_request_sent": false,
|
||||
"pivot": {
|
||||
"post_id": 27,
|
||||
"user_id": 1,
|
||||
"created_at": "2022-02-18T08:36:00.000000Z",
|
||||
"updated_at": "2022-02-18T08:36:00.000000Z"
|
||||
}
|
||||
}
|
||||
],
|
||||
"post_images": [],
|
||||
"category": {
|
||||
"id": 1,
|
||||
"parent_id": 0,
|
||||
"name": "Dharmik",
|
||||
"created_at": "2022-01-31T12:28:34.000000Z",
|
||||
"updated_at": "2022-01-31T12:28:34.000000Z"
|
||||
}
|
||||
}
|
||||
],
|
||||
"first_page_url": "http://global-jain.test/api/v1/sant/post?page=1",
|
||||
"from": 1,
|
||||
"last_page": 1,
|
||||
"last_page_url": "http://global-jain.test/api/v1/sant/post?page=1",
|
||||
"links": [
|
||||
{
|
||||
"url": null,
|
||||
"label": "« Previous",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/sant/post?page=1",
|
||||
"label": "1",
|
||||
"active": true
|
||||
},
|
||||
{
|
||||
"url": null,
|
||||
"label": "Next »",
|
||||
"active": false
|
||||
}
|
||||
],
|
||||
"next_page_url": null,
|
||||
"path": "http://global-jain.test/api/v1/sant/post",
|
||||
"per_page": 10,
|
||||
"prev_page_url": null,
|
||||
"to": 1,
|
||||
"total": 1
|
||||
},
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
<a name="sant-post-list"></a>
|
||||
## List
|
||||
|
||||
Details for sant post list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/sant/user/post` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"page" : "2",
|
||||
"type_id" : "2" // id of Sant
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": {
|
||||
"current_page": 1,
|
||||
"data": [
|
||||
{
|
||||
"id": 2,
|
||||
"user_id": 1,
|
||||
"category_id": 2,
|
||||
"privacy": 2,
|
||||
"status": 2,
|
||||
"description": "sadasdasda update",
|
||||
"created_by": {
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"avatar": "",
|
||||
"created_at": "2022-01-20T11:12:23.000000Z",
|
||||
"updated_at": "2022-01-20T11:12:23.000000Z"
|
||||
},
|
||||
"updated_by": {
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"avatar": "",
|
||||
"created_at": "2022-01-20T11:12:23.000000Z",
|
||||
"updated_at": "2022-01-20T11:12:23.000000Z"
|
||||
},
|
||||
"location": "GA",
|
||||
"created_at": "2022-02-01T08:59:57.000000Z",
|
||||
"updated_at": "2022-02-01T09:00:05.000000Z",
|
||||
"likes_count": 0,
|
||||
"tag_users": [],
|
||||
"post_images": [
|
||||
{
|
||||
"id": 5,
|
||||
"post_id": 2,
|
||||
"image_name": "http://global-jain.test/storage/images/posts/3991643708006.png",
|
||||
"created_at": "2022-02-01T09:33:26.000000Z",
|
||||
"updated_at": "2022-02-01T09:33:26.000000Z"
|
||||
}
|
||||
]
|
||||
}
|
||||
],
|
||||
"first_page_url": "http://global-jain.test/api/v1/post?page=1",
|
||||
"from": 1,
|
||||
"last_page": 2,
|
||||
"last_page_url": "http://global-jain.test/api/v1/post?page=2",
|
||||
"links": [
|
||||
{
|
||||
"url": null,
|
||||
"label": "« Previous",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/post?page=1",
|
||||
"label": "1",
|
||||
"active": true
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/post?page=2",
|
||||
"label": "2",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/post?page=2",
|
||||
"label": "Next »",
|
||||
"active": false
|
||||
}
|
||||
],
|
||||
"next_page_url": "http://global-jain.test/api/v1/post?page=2",
|
||||
"path": "http://global-jain.test/api/v1/post",
|
||||
"per_page": 10,
|
||||
"prev_page_url": null,
|
||||
"to": 10,
|
||||
"total": 17
|
||||
},
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
<a name="add-post"></a>
|
||||
## List
|
||||
|
||||
Details for add post api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `sant/post` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
description:sadasdasda
|
||||
privacy:1
|
||||
category_id:5
|
||||
images[0]:binary
|
||||
images[1]:binary
|
||||
location: Ahem
|
||||
user_id[]:1
|
||||
user_id[]:2
|
||||
status:1
|
||||
type_id:2 (id of type)
|
||||
type:2 (1: User, 2: Sant, 3: Sangh )
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"user_id": 1,
|
||||
"created_by": {
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"mobile": "12",
|
||||
"created_at": "2022-01-20T11:12:23.000000Z",
|
||||
"updated_at": "2022-01-20T11:12:23.000000Z"
|
||||
},
|
||||
"privacy": "1",
|
||||
"location": "Ah",
|
||||
"category_id": "1",
|
||||
"description": "sadasdasda",
|
||||
"updated_at": "2022-02-01T08:59:57.000000Z",
|
||||
"created_at": "2022-02-01T08:59:57.000000Z",
|
||||
"likes_count": 0,
|
||||
"id": 2,
|
||||
"updated_by": null
|
||||
},
|
||||
"message": "Post added successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
<a name="update-post"></a>
|
||||
## List
|
||||
|
||||
Details for update post api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `sant/post/{id}` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
description:sadasdasda update
|
||||
privacy:2
|
||||
category_id:2
|
||||
removed_image_id[0]:3
|
||||
removed_image_id[1]:4
|
||||
removed_image_id[2]:2
|
||||
removed_image_id[3]:1
|
||||
images[0]:binary
|
||||
images[1]:binary
|
||||
location:GA
|
||||
user_id[]:1
|
||||
user_id[]:2
|
||||
status:2
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"id": 2,
|
||||
"user_id": 1,
|
||||
"category_id": 2,
|
||||
"privacy": 2,
|
||||
"description": "sadasdasda update",
|
||||
"created_by": {
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"avatar": "",
|
||||
"created_at": "2022-01-20T11:12:23.000000Z",
|
||||
"updated_at": "2022-01-20T11:12:23.000000Z"
|
||||
},
|
||||
"updated_by": {
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"avatar": "",
|
||||
"created_at": "2022-01-20T11:12:23.000000Z",
|
||||
"updated_at": "2022-01-20T11:12:23.000000Z"
|
||||
},
|
||||
"location": "GA",
|
||||
"created_at": "2022-02-01T08:59:57.000000Z",
|
||||
"updated_at": "2022-02-01T09:00:05.000000Z",
|
||||
"likes_count": 0,
|
||||
"post_images": [
|
||||
{
|
||||
"id": 5,
|
||||
"post_id": 2,
|
||||
"image_name": "3991643708006.png",
|
||||
"created_at": "2022-02-01T09:33:26.000000Z",
|
||||
"updated_at": "2022-02-01T09:33:26.000000Z"
|
||||
}
|
||||
]
|
||||
},
|
||||
"message": "Post updated successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="delete-post"></a>
|
||||
## List
|
||||
|
||||
Details for delete post api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| DELETE | `sant/post/{id}` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"message": "Post deleted successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="info-post"></a>
|
||||
## List
|
||||
|
||||
Details for sant post list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `sant/post/{id}` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"id": 2,
|
||||
"user_id": 1,
|
||||
"category_id": 2,
|
||||
"privacy": 2,
|
||||
"status": 2,
|
||||
"description": "sadasdasda update",
|
||||
"created_by": 1,
|
||||
"updated_by": 1,
|
||||
"location": "GA",
|
||||
"created_at": "2022-02-01T08:59:57.000000Z",
|
||||
"updated_at": "2022-02-01T09:00:05.000000Z",
|
||||
"comments": {
|
||||
"current_page": 1,
|
||||
"data": [
|
||||
{
|
||||
"id": 7,
|
||||
"post_id": 2,
|
||||
"user_id": 1,
|
||||
"reply_id": null,
|
||||
"comment": "my comment for post 3",
|
||||
"created_at": "2022-02-07T09:43:44.000000Z",
|
||||
"updated_at": "2022-02-07T09:43:44.000000Z",
|
||||
"replies": [
|
||||
{
|
||||
"id": 8,
|
||||
"post_id": 2,
|
||||
"user_id": 1,
|
||||
"reply_id": 7,
|
||||
"comment": "my comment for post reply 2 update for id 2",
|
||||
"created_at": "2022-02-07T09:44:00.000000Z",
|
||||
"updated_at": "2022-02-07T10:02:53.000000Z"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"id": 5,
|
||||
"post_id": 2,
|
||||
"user_id": 1,
|
||||
"reply_id": null,
|
||||
"comment": "my comment for post reply 2 update",
|
||||
"created_at": "2022-02-03T12:04:12.000000Z",
|
||||
"updated_at": "2022-02-04T06:11:00.000000Z",
|
||||
"replies": []
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"post_id": 2,
|
||||
"user_id": 1,
|
||||
"reply_id": null,
|
||||
"comment": "my comment for post reply 2 update",
|
||||
"created_at": "2022-02-03T12:04:00.000000Z",
|
||||
"updated_at": "2022-02-04T06:11:00.000000Z",
|
||||
"replies": []
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"post_id": 2,
|
||||
"user_id": 1,
|
||||
"reply_id": null,
|
||||
"comment": "my comment for post reply 2 update",
|
||||
"created_at": "2022-02-03T12:03:27.000000Z",
|
||||
"updated_at": "2022-02-04T06:11:00.000000Z",
|
||||
"replies": []
|
||||
},
|
||||
{
|
||||
"id": 2,
|
||||
"post_id": 2,
|
||||
"user_id": 1,
|
||||
"reply_id": null,
|
||||
"comment": "my comment for post reply 2 update for id 2",
|
||||
"created_at": "2022-02-03T12:03:22.000000Z",
|
||||
"updated_at": "2022-02-04T06:14:04.000000Z",
|
||||
"replies": []
|
||||
}
|
||||
],
|
||||
"first_page_url": "http://global-jain.test/api/v1/post/2?page=1",
|
||||
"from": 1,
|
||||
"last_page": 2,
|
||||
"last_page_url": "http://global-jain.test/api/v1/post/2?page=2",
|
||||
"links": [
|
||||
{
|
||||
"url": null,
|
||||
"label": "« Previous",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/post/2?page=1",
|
||||
"label": "1",
|
||||
"active": true
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/post/2?page=2",
|
||||
"label": "2",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/post/2?page=2",
|
||||
"label": "Next »",
|
||||
"active": false
|
||||
}
|
||||
],
|
||||
"next_page_url": "http://global-jain.test/api/v1/post/2?page=2",
|
||||
"path": "http://global-jain.test/api/v1/post/2",
|
||||
"per_page": 5,
|
||||
"prev_page_url": null,
|
||||
"to": 5,
|
||||
"total": 6
|
||||
}
|
||||
},
|
||||
"message": "Get post info successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="sant-feed"></a>
|
||||
## List
|
||||
|
||||
Details for sant feed list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `user/sant/feeds` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"current_page": 1,
|
||||
"data": [
|
||||
{
|
||||
"id": 9,
|
||||
"log_name": "default",
|
||||
"description": "chaturmas_updated",
|
||||
"subject_type": "App\\Models\\Sant",
|
||||
"subject_id": 7,
|
||||
"causer_type": "App\\Models\\User",
|
||||
"causer_id": 1,
|
||||
"properties": {
|
||||
"attributes": {
|
||||
"message": "Chaturmas is updated",
|
||||
"sant_id": 7,
|
||||
"chaturmas_information": {
|
||||
"id": 33,
|
||||
"year": null,
|
||||
"place": "Derasar 2",
|
||||
"sant_id": 7,
|
||||
"end_date": null,
|
||||
"sangh_id": null,
|
||||
"created_at": "2022-03-25T10:41:58.000000Z",
|
||||
"created_by": 1,
|
||||
"start_date": null,
|
||||
"updated_at": "2022-03-25T10:42:11.000000Z",
|
||||
"updated_by": 1,
|
||||
"created_ago": "17 minutes ago",
|
||||
"is_approved": 0,
|
||||
"updated_ago": "16 minutes ago",
|
||||
"thana_sant_id": null,
|
||||
"chaturmas_date_id": 1
|
||||
}
|
||||
}
|
||||
},
|
||||
"created_at": "2022-03-25T10:59:02.000000Z",
|
||||
"updated_at": "2022-03-25T10:59:02.000000Z",
|
||||
"causer": {
|
||||
"id": 1,
|
||||
"name": "Admin",
|
||||
"avatar": "http://global-jain.test/storage/images/users/medium/6451644991774.png",
|
||||
"is_friends": 0
|
||||
},
|
||||
"subject": {
|
||||
"id": 7,
|
||||
"name": "shreedhar",
|
||||
"avatar": "http://global-jain.test/images/misc/placeholder.png",
|
||||
"age": 0,
|
||||
"diksha_year": 0,
|
||||
"is_user_following": false
|
||||
}
|
||||
}
|
||||
],
|
||||
"first_page_url": "http://global-jain.test/api/v1/user/sant/feeds?page=1",
|
||||
"from": 1,
|
||||
"last_page": 1,
|
||||
"last_page_url": "http://global-jain.test/api/v1/user/sant/feeds?page=1",
|
||||
"links": [
|
||||
{
|
||||
"url": null,
|
||||
"label": "« Previous",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/user/sant/feeds?page=1",
|
||||
"label": "1",
|
||||
"active": true
|
||||
},
|
||||
{
|
||||
"url": null,
|
||||
"label": "Next »",
|
||||
"active": false
|
||||
}
|
||||
],
|
||||
"next_page_url": null,
|
||||
"path": "http://global-jain.test/api/v1/user/sant/feeds",
|
||||
"per_page": 10,
|
||||
"prev_page_url": null,
|
||||
"to": 5,
|
||||
"total": 5
|
||||
},
|
||||
"message": "Get sant follow list successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
1227
resources/docs/1.0/sant.md
Normal file
1227
resources/docs/1.0/sant.md
Normal file
File diff suppressed because it is too large
Load Diff
410
resources/docs/1.0/thana.md
Normal file
410
resources/docs/1.0/thana.md
Normal file
@@ -0,0 +1,410 @@
|
||||
# API Docs
|
||||
|
||||
<a name="list"></a>
|
||||
## List
|
||||
|
||||
Details for dharma list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/thana/sant/list` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"data": {
|
||||
"current_page": 1,
|
||||
"data": [
|
||||
{
|
||||
"id": 18,
|
||||
"user_id": 1,
|
||||
"name": "shreedhar",
|
||||
"father_name": "father_nameq",
|
||||
"mother_name": "mother_nameqw",
|
||||
"guru_name": null,
|
||||
"gender": 1,
|
||||
"avatar": "http://global-jain.test/storage/images/sants/medium/1643374279.png",
|
||||
"honor": [
|
||||
"honorq"
|
||||
],
|
||||
"qualification": "qualification",
|
||||
"dharma_id": 2,
|
||||
"sampraday_id": 1,
|
||||
"guru_id": 1,
|
||||
"birth_date": "2000-01-21",
|
||||
"diksha_date": "2000-01-23",
|
||||
"diksha_place": "diksha_place",
|
||||
"about": "about a",
|
||||
"status": 2,
|
||||
"verification_status": null,
|
||||
"reviewed_fields": null,
|
||||
"description": null,
|
||||
"profile_verified_at": null,
|
||||
"created_by": 1,
|
||||
"updated_by": 1,
|
||||
"created_at": "2022-01-21T10:26:12.000000Z",
|
||||
"updated_at": "2022-01-22T10:58:08.000000Z",
|
||||
"deleted_at": null,
|
||||
"current_thana_id": null,
|
||||
"age": 22,
|
||||
"diksha_year": 22,
|
||||
"is_user_following": false
|
||||
},
|
||||
{
|
||||
"id": 30,
|
||||
"user_id": 1,
|
||||
"name": "shreedhar",
|
||||
"father_name": "father_nameq",
|
||||
"mother_name": "mother_nameqw",
|
||||
"guru_name": null,
|
||||
"gender": 1,
|
||||
"avatar": "http://global-jain.test/images/misc/placeholder.png",
|
||||
"honor": [
|
||||
"a",
|
||||
"b",
|
||||
"c"
|
||||
],
|
||||
"qualification": "qualification",
|
||||
"dharma_id": 2,
|
||||
"sampraday_id": 1,
|
||||
"guru_id": 1,
|
||||
"birth_date": "2000-01-21",
|
||||
"diksha_date": "2000-01-23",
|
||||
"diksha_place": "diksha_place",
|
||||
"about": "about",
|
||||
"status": 2,
|
||||
"verification_status": 1,
|
||||
"reviewed_fields": [],
|
||||
"description": null,
|
||||
"profile_verified_at": "2022-03-22 10:49:05",
|
||||
"created_by": 1,
|
||||
"updated_by": 1,
|
||||
"created_at": "2022-03-09T09:41:20.000000Z",
|
||||
"updated_at": "2022-03-22T05:19:05.000000Z",
|
||||
"deleted_at": null,
|
||||
"current_thana_id": null,
|
||||
"age": 22,
|
||||
"diksha_year": 22,
|
||||
"is_user_following": false
|
||||
}
|
||||
],
|
||||
"first_page_url": "http://global-jain.test/api/v1/thana/sant/list?page=1",
|
||||
"from": 1,
|
||||
"last_page": 1,
|
||||
"last_page_url": "http://global-jain.test/api/v1/thana/sant/list?page=1",
|
||||
"links": [
|
||||
{
|
||||
"url": null,
|
||||
"label": "« Previous",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/thana/sant/list?page=1",
|
||||
"label": "1",
|
||||
"active": true
|
||||
},
|
||||
{
|
||||
"url": null,
|
||||
"label": "Next »",
|
||||
"active": false
|
||||
}
|
||||
],
|
||||
"next_page_url": null,
|
||||
"path": "http://global-jain.test/api/v1/thana/sant/list",
|
||||
"per_page": 10,
|
||||
"prev_page_url": null,
|
||||
"to": 2,
|
||||
"total": 2
|
||||
},
|
||||
"message": "Sant List getting successfully!",
|
||||
"status": 200
|
||||
}
|
||||
```
|
||||
|
||||
<a name="add"></a>
|
||||
## Add Member
|
||||
|
||||
Details add member in thana
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/thana` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
"sant_id": "1",
|
||||
"thana_sant_id[]": "2"
|
||||
"thana_sant_id[]": "3"
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"id": 12,
|
||||
"sant_id": 1,
|
||||
"name": "LQK4yRv7F",
|
||||
"created_by": null,
|
||||
"updated_by": null,
|
||||
"created_at": "2022-03-23T07:25:57.000000Z",
|
||||
"updated_at": "2022-03-23T07:25:57.000000Z"
|
||||
},
|
||||
"message": "Thana added successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="delete"></a>
|
||||
## Add Member
|
||||
|
||||
Details delete member in thana
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/thana/delete-member` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"sant_id": "1",
|
||||
"thana_sant_id": "2"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"id": 12,
|
||||
"sant_id": 1,
|
||||
"name": "LQK4yRv7F",
|
||||
"created_by": null,
|
||||
"updated_by": null,
|
||||
"created_at": "2022-03-23T07:25:57.000000Z",
|
||||
"updated_at": "2022-03-23T07:25:57.000000Z"
|
||||
},
|
||||
"message": "Thana added successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="thana-member"></a>
|
||||
## Add Member
|
||||
|
||||
Details thana-member member in thana
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/thana/thana-member` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"sant_id": "1",
|
||||
"thana_sant_id": "2"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"current_page": 1,
|
||||
"data": [
|
||||
{
|
||||
"id": 3,
|
||||
"user_id": 1,
|
||||
"name": "shreedhar",
|
||||
"father_name": "father_nameq",
|
||||
"mother_name": "mother_nameqw",
|
||||
"guru_name": null,
|
||||
"gender": 1,
|
||||
"avatar": "http://global-jain.test/images/misc/placeholder.png",
|
||||
"honor": [
|
||||
"honorqw"
|
||||
],
|
||||
"qualification": "qualification",
|
||||
"dharma_id": 2,
|
||||
"sampraday_id": 1,
|
||||
"guru_id": 1,
|
||||
"birth_date": "2000-01-21",
|
||||
"diksha_date": "2000-01-23",
|
||||
"diksha_place": "diksha_place",
|
||||
"about": "about",
|
||||
"status": 1,
|
||||
"verification_status": null,
|
||||
"reviewed_fields": null,
|
||||
"description": null,
|
||||
"profile_verified_at": null,
|
||||
"created_by": 1,
|
||||
"updated_by": null,
|
||||
"created_at": "2022-01-20T11:27:31.000000Z",
|
||||
"updated_at": "2022-01-20T11:27:31.000000Z",
|
||||
"deleted_at": null,
|
||||
"current_thana_id": null,
|
||||
"age": 22,
|
||||
"diksha_year": 22,
|
||||
"is_user_following": true,
|
||||
"pivot": {
|
||||
"thana_id": 12,
|
||||
"sant_id": 3,
|
||||
"created_at": "2022-03-23T07:25:57.000000Z",
|
||||
"updated_at": "2022-03-23T07:25:57.000000Z"
|
||||
}
|
||||
},
|
||||
{
|
||||
"id": 4,
|
||||
"user_id": 1,
|
||||
"name": "shreedhar",
|
||||
"father_name": "father_nameq",
|
||||
"mother_name": "mother_nameqw",
|
||||
"guru_name": null,
|
||||
"gender": 1,
|
||||
"avatar": "http://global-jain.test/images/misc/placeholder.png",
|
||||
"honor": [
|
||||
"honorqw"
|
||||
],
|
||||
"qualification": "qualification",
|
||||
"dharma_id": 2,
|
||||
"sampraday_id": 1,
|
||||
"guru_id": 1,
|
||||
"birth_date": "2000-01-21",
|
||||
"diksha_date": "2000-01-23",
|
||||
"diksha_place": "diksha_place",
|
||||
"about": "about",
|
||||
"status": 1,
|
||||
"verification_status": null,
|
||||
"reviewed_fields": null,
|
||||
"description": null,
|
||||
"profile_verified_at": null,
|
||||
"created_by": 1,
|
||||
"updated_by": null,
|
||||
"created_at": "2022-01-20T11:28:23.000000Z",
|
||||
"updated_at": "2022-01-20T11:28:23.000000Z",
|
||||
"deleted_at": null,
|
||||
"current_thana_id": null,
|
||||
"age": 22,
|
||||
"diksha_year": 22,
|
||||
"is_user_following": false,
|
||||
"pivot": {
|
||||
"thana_id": 12,
|
||||
"sant_id": 4,
|
||||
"created_at": "2022-03-23T09:52:07.000000Z",
|
||||
"updated_at": "2022-03-23T09:52:07.000000Z"
|
||||
}
|
||||
}
|
||||
],
|
||||
"first_page_url": "http://global-jain.test/api/v1/thana/thana-member?page=1",
|
||||
"from": 1,
|
||||
"last_page": 1,
|
||||
"last_page_url": "http://global-jain.test/api/v1/thana/thana-member?page=1",
|
||||
"links": [
|
||||
{
|
||||
"url": null,
|
||||
"label": "« Previous",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/thana/thana-member?page=1",
|
||||
"label": "1",
|
||||
"active": true
|
||||
},
|
||||
{
|
||||
"url": null,
|
||||
"label": "Next »",
|
||||
"active": false
|
||||
}
|
||||
],
|
||||
"next_page_url": null,
|
||||
"path": "http://global-jain.test/api/v1/thana/thana-member",
|
||||
"per_page": 10,
|
||||
"prev_page_url": null,
|
||||
"to": 2,
|
||||
"total": 2
|
||||
},
|
||||
"message": "Thana added successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
1341
resources/docs/1.0/user.md
Normal file
1341
resources/docs/1.0/user.md
Normal file
File diff suppressed because it is too large
Load Diff
323
resources/docs/1.0/vihar.md
Normal file
323
resources/docs/1.0/vihar.md
Normal file
@@ -0,0 +1,323 @@
|
||||
# API Docs
|
||||
|
||||
<a name="list"></a>
|
||||
## List
|
||||
|
||||
Details for vihar list api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/vihar` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
{
|
||||
"sant_id":"1",
|
||||
"page" : "2"
|
||||
}
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"current_page": 1,
|
||||
"data": [
|
||||
{
|
||||
"id": 2,
|
||||
"user_id": 2,
|
||||
"sant_id": 1,
|
||||
"from": null,
|
||||
"to": "Surat",
|
||||
"start_date": "2022-01-10",
|
||||
"end_date": null,
|
||||
"start_time": "16:40:00",
|
||||
"end_time": null,
|
||||
"created_at": "2022-01-11T12:13:53.000000Z",
|
||||
"updated_at": "2022-01-11T12:13:53.000000Z",
|
||||
"deleted_at": null
|
||||
},
|
||||
{
|
||||
"id": 3,
|
||||
"user_id": 2,
|
||||
"sant_id": 1,
|
||||
"from": null,
|
||||
"to": "Surat",
|
||||
"start_date": "2022-01-10",
|
||||
"end_date": null,
|
||||
"start_time": "16:40:00",
|
||||
"end_time": null,
|
||||
"created_at": "2022-01-11T12:14:25.000000Z",
|
||||
"updated_at": "2022-01-11T12:14:25.000000Z",
|
||||
"deleted_at": null
|
||||
},
|
||||
],
|
||||
"first_page_url": "http://global-jain.test/api/v1/vihar?page=1",
|
||||
"from": 1,
|
||||
"last_page": 2,
|
||||
"last_page_url": "http://global-jain.test/api/v1/vihar?page=2",
|
||||
"links": [
|
||||
{
|
||||
"url": null,
|
||||
"label": "« Previous",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/vihar?page=1",
|
||||
"label": "1",
|
||||
"active": true
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/vihar?page=2",
|
||||
"label": "2",
|
||||
"active": false
|
||||
},
|
||||
{
|
||||
"url": "http://global-jain.test/api/v1/vihar?page=2",
|
||||
"label": "Next »",
|
||||
"active": false
|
||||
}
|
||||
],
|
||||
"next_page_url": "http://global-jain.test/api/v1/vihar?page=2",
|
||||
"path": "http://global-jain.test/api/v1/vihar",
|
||||
"per_page": 10,
|
||||
"prev_page_url": null,
|
||||
"to": 10,
|
||||
"total": 13
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
> {danger} Unauthenticated Response
|
||||
|
||||
####Code `403`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"message": "Something went wrong!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="add"></a>
|
||||
## Add
|
||||
|
||||
Details for add vihar api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/vihar` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
from:Ahemdabad
|
||||
to:Surat
|
||||
start_date:2022-01-10
|
||||
start_time:16:40
|
||||
end_date:2022-01-09
|
||||
sant_id:1
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"from": "Ahemdabad",
|
||||
"to": "Surat",
|
||||
"start_date": "2022-01-10",
|
||||
"start_time": "16:40",
|
||||
"sant_id": "1",
|
||||
"user_id": 2,
|
||||
"updated_at": "2022-01-12T18:07:36.000000Z",
|
||||
"created_at": "2022-01-12T18:07:36.000000Z",
|
||||
"id": 21
|
||||
},
|
||||
"message": "Vihar added successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="update"></a>
|
||||
## Update
|
||||
|
||||
Details for update vihar api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| POST | `/vihar/{id}` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
from:Ahemdabad
|
||||
to:Surat
|
||||
start_date:2022-01-10
|
||||
start_time:16:40
|
||||
sant_id:1
|
||||
end_date:2022-01-09
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"id": 14,
|
||||
"user_id": 2,
|
||||
"sant_id": 1,
|
||||
"from": "Ahemdabad",
|
||||
"to": "Surat",
|
||||
"start_date": "2022-01-10",
|
||||
"end_date": "2022-01-10",
|
||||
"start_time": "16:40:00",
|
||||
"end_time": "23:59:00",
|
||||
"created_at": "2022-01-11T12:34:32.000000Z",
|
||||
"updated_at": "2022-01-12T18:12:18.000000Z",
|
||||
"deleted_at": null
|
||||
},
|
||||
"message": "Vihar updated successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="show"></a>
|
||||
## Add
|
||||
|
||||
Details for vihar
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| GET | `/vihar/1` | Bearer {token} |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"data": {
|
||||
"id": 1,
|
||||
"user_id": 1,
|
||||
"sant_id": 1,
|
||||
"from": "Ahemdabad",
|
||||
"to": "Surat",
|
||||
"start_date": "2022-01-10",
|
||||
"end_date": null,
|
||||
"start_time": "16:40:00",
|
||||
"end_time": null,
|
||||
"created_at": "2022-01-18T11:54:52.000000Z",
|
||||
"updated_at": "2022-01-18T11:54:52.000000Z",
|
||||
"deleted_at": null
|
||||
},
|
||||
"message": "Get vihar successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
<a name="delete"></a>
|
||||
## List
|
||||
|
||||
Details for delete vihar api
|
||||
##
|
||||
##
|
||||
|
||||
####Endpoint
|
||||
|
||||
> {warning} Please note that the URI for this endpoint should include api/{$version} before
|
||||
|
||||
| Method | URI | Headers |
|
||||
| : | :- | : |
|
||||
| DELETE | `/vihar/{id}` | Default |
|
||||
|
||||
### URL Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
### Data Params
|
||||
|
||||
```php
|
||||
None
|
||||
```
|
||||
|
||||
> {success} Success Response
|
||||
|
||||
####Code `200`
|
||||
####Content
|
||||
```php
|
||||
{
|
||||
"status": 200,
|
||||
"success": true,
|
||||
"message": "Vihar deleted successfully!"
|
||||
}
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user