29 KiB
API Docs
Global search
Details for global search api
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| POST | user/global-search | Bearer {token} |
URL Params
None
Data Params
{
"name":"As"
}
{success} Success Response
####Code 200
####Content
{
"data": [
{
"id": 2,
"name": "Acharya Samrat Dr. Shree Shivmuni Ji M.S",
"avatar": "http://127.0.0.1:8000/images/misc/placeholder.png",
"type": "sant",
"age": 0,
"diksha_year": 0,
"is_user_following": false
},
{
"id": 5,
"name": "Abc",
"avatar": "",
"type": "user",
"age": 0,
"diksha_year": 0,
"is_user_following": false
}
],
"status": 200
}
{danger} Unauthenticated Response
####Code 403
####Content
{
"message": "Something went wrong!"
"status": 403
}
Shravak list (With Search)
Details for shravak list api
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| POST | user/user-list | Bearer {token} |
URL Params
None
Data Params
{
"name":"",
"already_tagged": ["2","3"]
}
{success} Success Response
####Code 200
####Content
{
"data": [
{
"id": 3,
"uuid": "47814c29-47ce-49ff-a216-24293925fefd",
"name": "ABC",
"email": "",
"email_hash": null,
"username": "2",
"country_code": "(+91)",
"mobile": "9824735457",
"dharma_id": 3,
"birth_date": "1997-05-10",
"gender": 1,
"email_verified_at": null,
"mobile_verified_at": null,
"avatar": null,
"verification_confirmed": 2,
"status": 1,
"timezone": null,
"last_login_at": null,
"last_login_ip": null,
"created_at": "2022-01-20T09:19:16.000000Z",
"updated_at": "2022-01-25T10:53:36.000000Z",
"deleted_at": null,
"is_friends": true
}
],
"status": 200
}
{danger} Unauthenticated Response
####Code 403
####Content
{
"message": "Something went wrong!"
"status": 403
}
List Of professions (With Search)
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| GET | /profession | Bearer {token} |
URL Params
None
Data Params
{
"name":"Doc"
}
{success} Success Response
####Code 200
####Content
{
"data": [
{
"id": 1,
"name": "Doctor",
"created_by": null,
"updated_by": null,
"created_at": "2022-03-07T05:35:12.000000Z",
"updated_at": "2022-03-07T05:35:12.000000Z"
},
{
"id": 2,
"name": "Business",
"created_by": null,
"updated_by": null,
"created_at": "2022-03-07T05:35:12.000000Z",
"updated_at": "2022-03-07T05:35:12.000000Z"
},
{
"id": 3,
"name": "IT",
"created_by": null,
"updated_by": null,
"created_at": "2022-03-07T05:35:12.000000Z",
"updated_at": "2022-03-07T05:35:12.000000Z"
},
{
"id": 4,
"name": "Student",
"created_by": null,
"updated_by": null,
"created_at": "2022-03-07T05:35:12.000000Z",
"updated_at": "2022-03-07T05:35:12.000000Z"
},
{
"id": 5,
"name": "Architect",
"created_by": null,
"updated_by": null,
"created_at": "2022-03-07T05:35:12.000000Z",
"updated_at": "2022-03-07T05:35:12.000000Z"
},
{
"id": 6,
"name": "Teacher",
"created_by": null,
"updated_by": null,
"created_at": "2022-03-07T05:35:12.000000Z",
"updated_at": "2022-03-07T05:35:12.000000Z"
},
{
"id": 7,
"name": "Lawyer",
"created_by": null,
"updated_by": null,
"created_at": "2022-03-07T05:35:12.000000Z",
"updated_at": "2022-03-07T05:35:12.000000Z"
},
{
"id": 8,
"name": "CA",
"created_by": null,
"updated_by": null,
"created_at": "2022-03-07T05:35:13.000000Z",
"updated_at": "2022-03-07T05:35:13.000000Z"
},
{
"id": 9,
"name": "Scientist",
"created_by": null,
"updated_by": null,
"created_at": "2022-03-07T05:35:13.000000Z",
"updated_at": "2022-03-07T05:35:13.000000Z"
},
{
"id": 10,
"name": "Other",
"created_by": null,
"updated_by": null,
"created_at": "2022-03-07T05:35:13.000000Z",
"updated_at": "2022-03-07T05:35:13.000000Z"
}
],
"status": 200
}
Shravak public Profile
Details for shravak public profile api
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| GET | user/user-public-profile/{id} | Bearer {token} |
URL Params
2 //User Id
Data Params
None
{success} Success Response
####Code 200
####Content
{
"data": {
"id": 2,
"uuid": "4660e9f5-30a8-4e1c-a2cd-022ea361b2dc",
"name": "Test",
"email": "test.jain@example.com",
"email_privacy": 1,
"username": "3",
"country_code": "",
"mobile": "",
"mobile_privacy": 1,
"dharma_id": 3,
"dharma_name": "Terapanthi",
"dharma_privacy": 2,
"birth_date": "1995-02-15",
"birth_date_privacy": 1,
"gender_id": 2,
"gender": "Female",
"gender_privacy": 2,
"email_verified_at": "",
"mobile_verified_at": "",
"avatar": "http://127.0.0.1:8000/images/misc/placeholder.png",
"avatar_privacy": 1,
"verification_confirmed": 2,
"status": 2,
"timezone": "",
"last_login_at": "",
"last_login_ip": "",
"created_at": "2022-02-01T05:27:40.000000Z",
"updated_at": "2022-02-08T07:18:50.000000Z",
"deleted_at": "",
"jati_id": 1,
"jati_name": "Jalawadi Dasha Shrimali",
"jati_privacy": 1,
"location": "Delhi",
"location_privacy": 1,
"longitude": "42.65412",
"latitude": "22.85402",
"native_place": "Ahmedabad",
"native_place_privacy": 1,
"native_longitude": "42.65412",
"native_latitude": "22.85402",
"mother_tongue": "Gujarati",
"mother_tongue_privacy": 1,
"marital_status": "Unmarried",
"marital_status_privacy": 1,
"marriage_anniversary": "",
"marriage_anniversary_privacy": 1,
"family_members": [
{
"name": "Bharat Shah",
"relation": "Father",
"image_url": ""
},
{
"name": "Jay Shah",
"relation": "Brother",
"image_url": ""
}
],
"company_details": [
{
"id": 1,
"user_id": "2",
"company_name": "ViitorCloud Technologies",
"company_name_privacy": 1,
"profession": "IT",
"profession_privacy": 1,
"designation": "Software Engineer",
"designation_privacy": 1,
"website": "www.viitorcloud.com",
"website_privacy": 1,
"start_date": "2020-01-02",
"end_date": ""
}
],
"profession": "Sr. Head",
"profession_privacy": 1,
"qualificaion_details": [
{
"id": 5,
"user_id": 2,
"qualification": "MCA",
"qualification_privacy": 1,
"university": "Marwadi University",
"start_date": "2018-07-09",
"end_date": "2020-03-18",
"created_at": "2022-02-08T07:18:40.000000Z",
"updated_at": "2022-02-08T07:18:40.000000Z"
}
],
"karma_dhan": 120,
"friend_count": 426,
"sangh_member_count": 50,
"share_content": "https://globaljain.focalat.com/"
},
"status": 200
}
{danger} Unauthenticated Response
####Code 403
####Content
{
"message": "Something went wrong!"
"status": 403
}
View Profile
Details for view profile api
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| GET | user/user-detail | Bearer {token} |
URL Params
None
Data Params
None
{success} Success Response
####Code 200
####Content
{
"data": {
"id": 1,
"uuid": "71046d49-2f89-4068-a725-518ad99527e8",
"name": "Admin",
"email": "admin@globaljain.com",
"email_privacy": 1,
"username": "Admin",
"country_code": "",
"mobile": "12",
"mobile_privacy": 1,
"dharma_id": 3,
"dharma_name": "Terapanthi",
"dharma_privacy": 2,
"birth_date": "1995-02-15",
"birth_date_privacy": 1,
"gender_id": 2,
"gender": "Female",
"gender_privacy": 2,
"email_verified_at": "2022-01-20T11:12:23.000000Z",
"mobile_verified_at": "2022-01-20T11:12:23.000000Z",
"avatar": "",
"avatar_privacy": 1,
"verification_confirmed": 2,
"status": 2,
"timezone": "",
"last_login_at": "",
"last_login_ip": "",
"created_at": "2022-01-20T11:12:23.000000Z",
"updated_at": "2022-02-15T04:26:25.000000Z",
"deleted_at": "",
"jati_id": 1,
"jati_name": "Mercedes Davidson",
"jati_privacy": 1,
"blood_group_id": 1,
"blood_group": "A+",
"blood_group_privacy": 1,
"location": "Delhi",
"location_privacy": 1,
"longitude": "42.65412",
"latitude": "22.85402",
"native_place": "Ahmedabad",
"native_place_privacy": 1,
"native_longitude": "42.65412",
"native_latitude": "22.85402",
"mother_tongue": "Gujarati",
"mother_tongue_privacy": 1,
"marital_status": "Unmarried",
"marital_status_privacy": 1,
"marriage_anniversary": "",
"marriage_anniversary_privacy": 1,
"family_members": [
{
"name": "Bharat Shah",
"relation": "Father",
"image_url": ""
}
],
"company_details": [
{
"id": 24,
"user_id": 2,
"company_name": "Oneplus",
"company_name_privacy": 1,
"profession_id": null,
"profession": null,
"profession_speciality": null,
"position": null,
"city": null,
"city_privacy": 1,
"position_privacy": 1,
"profession_speciality_privacy": 1,
"profession_privacy": 1,
"website": "www.oneplus.com",
"website_privacy": 1,
"about": null,
"about_privacy": 1,
"is_working": null,
"start_date": "2020-01-02",
"end_date": null,
"created_at": "2022-02-15T10:08:36.000000Z",
"updated_at": "2022-02-15T10:10:37.000000Z"
}
],
"profession": "Sr. Head",
"profession_privacy": 1,
"qualificaion_details": {
"schools": [
{
"id": 2,
"user_id": 1,
"qualification": null,
"university": null,
"highschool": "hh",
"is_graduate": 0,
"is_pursuing": 0,
"passing_year": "2022",
"starting_year": null,
"start_date": "2018-07-09",
"end_date": "2020-03-18",
"created_at": "2022-02-16T09:24:56.000000Z",
"updated_at": "2022-02-16T09:24:56.000000Z",
"privacy": 1,
"type": 2
}
],
"colleges": [
{
"id": 1,
"user_id": 1,
"qualification": "MCA",
"university": "Marwadi University",
"highschool": null,
"is_graduate": 1,
"is_pursuing": 1,
"passing_year": "2022",
"starting_year": "2022",
"start_date": "2018-07-09",
"end_date": "2020-03-18",
"created_at": "2022-02-16T09:21:10.000000Z",
"updated_at": "2022-02-16T09:21:10.000000Z",
"privacy": 1,
"type": 1
}
]
},
"passive_user": [
{
"id": 15,
"name": "Admin passive",
"parent_id": 1,
"is_passive": 1,
"relationship": 1,
"about": "Abbb",
"school_name": "School",
"avatar": "http://global-jain.test/storage/images/users/8941644922971.png",
"birth_date": "2022-02-15"
}
],
"karma_dhan": 120,
"friend_count": 426,
"sangh_member_count": 50,
"share_content": "https://globaljain.focalat.com/"
},
"status": 200
}
{danger} Unauthenticated Response
####Code 403
####Content
{
"message": "Something went wrong!"
"status": 403
}
Update Profile
Details for update profile api
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| POST | user/update-profile | Bearer {token} |
URL Params
None
Data Params
{
"avatar": "",
"dharma": "3",
"gender": "2",
"country_code": "",
"mobile": "",
"jati": "1",
"birth_date": "1995/02/15",
"native_place": "Ahmedabad",
"native_longitude": "42.65412",
"native_latitude": "22.85402",
"location": "Delhi",
"longitude": "42.65412",
"latitude": "22.85402",
"mother_tongue": "Gujarati",
"marital_status": "Unmarried",
"blood_group": "2",
"marriage_anniversary": "",
"blood_group_privacy": "2",
"gender_privacy": "2",
"mobile_privacy": "",
"email_privacy": "",
"avatar_privacy": "",
"birth_date_privacy": "",
"dharma_privacy": "2",
"mother_tongue_privacy": "",
"jati_privacy": "",
"marital_status_privacy": "",
"marriage_anniversary_privacy": "",
"location_privacy": "",
"native_place_privacy": "",
"company_details": [{
"id": 24,
"user_id": 2,
"company_name": "Oneplus",
"company_name_privacy": 1,
"profession_id": null,
"profession": null,
"profession_speciality": null,
"position": null,
"city": null,
"city_privacy": 1,
"position_privacy": 1,
"profession_speciality_privacy": 1,
"profession_privacy": 1,
"website": "www.oneplus.com",
"website_privacy": 1,
"about": null,
"about_privacy": 1,
"is_working": null,
"start_date": "2020-01-02",
"end_date": null,
"created_at": "2022-02-15T10:08:36.000000Z",
"updated_at": "2022-02-15T10:10:37.000000Z"
},
{
"id": 25,
"user_id": 2,
"company_name": "Windows",
"company_name_privacy": 1,
"profession_id": null,
"profession": null,
"profession_speciality": null,
"position": null,
"city": null,
"city_privacy": 1,
"position_privacy": 1,
"profession_speciality_privacy": 1,
"profession_privacy": 1,
"website": "www.microsoft.com",
"website_privacy": 1,
"about": null,
"about_privacy": 1,
"is_working": null,
"start_date": "2020-01-02",
"end_date": null,
"created_at": "2022-02-15T10:08:36.000000Z",
"updated_at": "2022-02-15T10:10:38.000000Z"
}],
"qualification_details": [{
"qualification_id": "1",
"qualification": "MCA",
"university": "Marwadi University",
"is_graduate" : "1",
"is_pursuing" : "1",
"passing_year" : "2022",
"starting_year" : "2022",
"start_date": "2018-07-09",
"end_date": "2020-03-18",
"privacy": "1",
"type": "1"
},
{
"qualification_id": "",
"highschool" : "hh",
"passing_year" : "2022",
"start_date": "2018-07-09",
"end_date": "2020-03-18",
"privacy": "1",
"type": "2"
}],
"family_members": [{
"to_id": 1,
"relation_id": 3,
"relation_privacy": 2
}]
}
{success} Success Response
####Code 200
####Content
{
"message": "Profile updated succefully!",
"status": 200
}
User Following
Details of user is following which sant
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| POST | user/following | Bearer {token} |
URL Params
None
Data Params
None
{success} Success Response
####Code 200
####Content
{
"status": 200,
"success": true,
"data": {
"current_page": 1,
"data": [
{
"id": 2,
"user_id": 1,
"name": "Chase Nash",
"father_name": "Gemma Odom",
"mother_name": "Renee Floyd",
"guru_name": null,
"gender": 1,
"avatar": "http://global-jain.test/images/misc/placeholder.png",
"honor": [
"Aute magna sint",
"in .a",
"in .aa",
"in ."
],
"qualification": "Autem at non dolorem",
"dharma_id": 1,
"sampraday_id": 1,
"guru_id": 3,
"birth_date": "2000-01-21",
"diksha_date": "2000-01-21",
"diksha_place": "Deserunt pariatur U",
"about": "Qui animi ad pariat",
"status": 2,
"profile_verified_at": null,
"created_by": 1,
"updated_by": null,
"created_at": "2022-01-20T11:15:12.000000Z",
"updated_at": "2022-01-20T11:15:12.000000Z",
"deleted_at": null,
"age": 22,
"diksha_year": 22,
"is_user_following": true,
"pivot": {
"sant_id": 1,
"user_id": 2,
"created_at": "2022-02-11T05:33:54.000000Z",
"updated_at": "2022-02-11T05:33:54.000000Z"
}
}
],
"first_page_url": "http://global-jain.test/api/v1/user/following?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://global-jain.test/api/v1/user/following?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://global-jain.test/api/v1/user/following?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "http://global-jain.test/api/v1/user/following",
"per_page": 10,
"prev_page_url": null,
"to": 4,
"total": 4
},
"message": "Get sant follow list successfully!",
"status": 200
}
Add Passive User
Details of add child user
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| POST | /child | Bearer {token} |
URL Params
None
Data Params
name:Admin passive
relationship:1
birth_date:2007-02-15
gender:1
school_name:School
about:Abbb
avatar:(binary)
{success} Success Response
####Code 200
####Content
{
"status": 200,
"success": true,
"data": {
"dharma_id": 3,
"name": "Admin passive",
"relationship": "1",
"birth_date": "2008-02-15",
"gender": "1",
"school_name": "School",
"about": "Abbb",
"is_passive": 1,
"parent_id": 1,
"username": "adpa24",
"avatar": "http://global-jain.test/storage/images/users/1621644929487.png",
"uuid": "573f96d8-664b-4d1f-b4e6-6a30dc0c7bb8",
"updated_at": "2022-02-15T12:51:27.000000Z",
"created_at": "2022-02-15T12:51:27.000000Z",
"id": 31
},
"message": "Child added successfully!"
}
Update Child User
Details of update child user
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| POST | child/{id} | Bearer {token} |
URL Params
None
Data Params
name:Admin passive u
relationship:1
birth_date:2022-02-14
gender:1
school_name:School u
about:Abbb u
{success} Success Response
####Code 200
####Content
{
"status": 200,
"success": true,
"data": {
"id": 13,
"uuid": "8e35fcb4-fbfa-4084-8ad0-d8736439b2f6",
"name": "Admin passive u",
"email": "",
"email_hash": null,
"username": "adpa96",
"country_code": null,
"mobile": null,
"dharma_id": 3,
"birth_date": "2022-02-14",
"gender": 1,
"email_verified_at": null,
"mobile_verified_at": null,
"avatar": "",
"school_name": "School u",
"about": "Abbb u",
"relationship": 1,
"is_passive": 1,
"parent_id": 1,
"verification_confirmed": 1,
"status": 1,
"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-15T10:07:25.000000Z",
"updated_at": "2022-02-15T10:29:47.000000Z",
"deleted_at": null
},
"message": "Child updated successfully!"
}
Remove Child User
Details of remove child user
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| DELETE | child/{id} | Bearer {token} |
URL Params
None
Data Params
None
{success} Success Response
####Code 200
####Content
{
"status": 200,
"success": true,
"message": "Child deleted successfully!"
}
SHow Child User
Details of show child user
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| GET | child/{id} | Bearer {token} |
URL Params
None
Data Params
None
{success} Success Response
####Code 200
####Content
{
"status": 200,
"success": true,
"message": "Child show successfully!"
}
{danger} Unauthenticated Response
####Code 403
####Content
{
"message": "Something went wrong!",
"status": 403
}
Delete work details
Details of delete work details
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| POST | user/delete-work | Bearer {token} |
URL Params
None
Data Params
{
"work_id": 26
}
{success} Success Response
####Code 200
####Content
{
"message": "Work details deleted successfully!",
"status": 200
}
{danger} Unauthenticated Response
####Code 403
####Content
{
"message": "Something went wrong!",
"status": 403
}
Delete qualification details
Details of delete qualification details
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| POST | user/delete-qualification | Bearer {token} |
URL Params
None
Data Params
{
"qualification_id": 2
}
{success} Success Response
####Code 200
####Content
{
"message": "Qualification details deleted successfully!",
"status": 200
}
{danger} Unauthenticated Response
####Code 403
####Content
{
"message": "Something went wrong!",
"status": 403
}
Blocked profile list details
Details of Blocked profile list
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| GET | user/blocked-profile | Bearer {token} |
URL Params
None
Data Params
None
{success} Success Response
####Code 200
####Content
{
"data": {
"current_page": 1,
"data": [
{
"id": 4,
"user_id": 12,
"blocked_by": 11,
"created_at": "2022-10-31T11:20:00.000000Z",
"updated_at": "2022-10-31T11:20:00.000000Z",
"user": {
"id": 12,
"name": "jal",
"avatar": "http://console.globaljain.test/images/misc/shravak.png",
"is_working": false,
"is_friends": 0,
"hide_mobile": null,
"is_user_friends": 0
}
}
],
"first_page_url": "http://console.globaljain.test/api/v1/user/blocked-profile?page=1",
"from": 1,
"last_page": 1,
"last_page_url": "http://console.globaljain.test/api/v1/user/blocked-profile?page=1",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
},
{
"url": "http://console.globaljain.test/api/v1/user/blocked-profile?page=1",
"label": "1",
"active": true
},
{
"url": null,
"label": "Next »",
"active": false
}
],
"next_page_url": null,
"path": "http://console.globaljain.test/api/v1/user/blocked-profile",
"per_page": 10,
"prev_page_url": null,
"to": 1,
"total": 1
},
"status": 200
}
{danger} Unauthenticated Response
####Code 403
####Content
{
"message": "Something went wrong!",
"status": 403
}
Block profile details
Details of block profile
####Endpoint
{warning} Please note that the URI for this endpoint should include api/{$version} before
| Method | URI | Headers |
| : | :- | : |
| POST | user/block | Bearer {token} |
URL Params
None
Data Params
{
"id": 12,
"status": 1 // 0: Unblock, 1: Block
}
{success} Success Response
####Code 200
####Content
{
"message": "User profile blocked successfully!",
"status": 200
}
{danger} Unauthenticated Response
####Code 403
####Content
{
"message": "Something went wrong!",
"status": 403
}