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