411 lines
10 KiB
Markdown
411 lines
10 KiB
Markdown
|
# 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!"
|
||
|
|
}
|
||
|
|
```
|