Files
Global-Jain/resources/docs/1.0/sant.md
2025-11-05 10:37:10 +05:30

28 KiB

API Docs

List

Details for sant list api

####Endpoint

{warning} Please note that the URI for this endpoint should include api/{$version} before

| Method | URI | Headers | | : | :- | : | | GET | user/sant-list | Bearer {token} |

URL Params

none

Data Params

{
    "name": "Global",
    "dharma_id": "1",
    "sampraday_id": "1"
}

{success} Success Response

####Code 200 ####Content

{
    "data": [
        {
            "id": 2,
            "user_id": 1,
            "name": "Global",
            "father_name": "dhoraa",
            "mother_name": "Sudhaben",
            "guru_name": "Connor Mcguire",
            "gender": 1,
            "avatar": "http://global-jain.test/storage/images/sants/1642581309.png",
            "honor": [
                "honorqw",
                "shree"
            ],
            "qualification": "12",
            "dharma_id": 1,
            "sampraday_id": 2,
            "guru_id": 1,
            "birth_date": "2022-01-17",
            "diksha_date": "2022-01-14",
            "diksha_place": "palitana",
            "about": "About global jain",
            "status": 2,
            "profile_verified_at": null,
            "created_by": 1,
            "updated_by": null,
            "created_at": "2022-01-19T08:35:10.000000Z",
            "updated_at": "2022-01-19T08:35:10.000000Z",
            "deleted_at": null
        }
    ],
    "message": "Sant List getting successfully!",
    "status": 200
}

{danger} Unauthenticated Response

####Code 403 ####Content

{
    "message": "Something went wrong!"
    "status": 403
}

List

Details for father-list api

####Endpoint

{warning} Please note that the URI for this endpoint should include api/{$version} before

| Method | URI | Headers | | : | :- | : | | GET | user/father-list | Bearer {token} |

URL Params

none

Data Params

{
    "name": "Global"
}

{success} Success Response

####Code 200 ####Content

{
    {
    "data": [
        {
            "id": 2,
            "name": "Chase Nash",
            "avatar": null,
            "type": "sant"
        },
        {
            "id": 3,
            "name": "shreedhar",
            "avatar": null,
            "type": "sant"
        },
        {
            "id": 4,
            "name": "shreedhar",
            "avatar": null,
            "type": "sant"
        },
        {
            "id": 5,
            "name": "shreedhar",
            "avatar": null,
            "type": "sant"
        },
    ],
    "message": "Get father list successfully!",
    "status": 200
}
}

{danger} Unauthenticated Response

####Code 403 ####Content

{
    "message": "Something went wrong!"
    "status": 403
}

List

Details for mother-list api

####Endpoint

{warning} Please note that the URI for this endpoint should include api/{$version} before

| Method | URI | Headers | | : | :- | : | | GET | user/mother-list | Bearer {token} |

URL Params

none

Data Params

{
    "name": "Global"
}

{success} Success Response

####Code 200 ####Content

{
    "data": [
        {
            "id": 1,
            "name": "Emi Brock",
            "avatar": null,
            "type": "sant"
        }
    ],
    "message": "Get mother list successfully!",
    "status": 200
}

{danger} Unauthenticated Response

####Code 403 ####Content

{
    "message": "Something went wrong!"
    "status": 403
}

Add Sant

Details for add sant api

####Endpoint

{warning} Please note that the URI for this endpoint should include api/{$version} before

| Method | URI | Headers | | : | :- | : | | POST | user/add-sant | Bearer {token} |

URL Params

None

Data Params

{
    "name" : "shreedhar",
    "father_name" : "father_nameq",
    "mother_name" : "mother_nameqw",
    "guru_name": "Connor Mcguire",
    "gender" : "1",
    "avatar" : "http://global-jain.test/storage/images/sants/1642585998.jpg",
    "honor" : "["honorqw","shree"]",
    "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",
    "father_id" : "",
    "father_type" : "",
    "mother_id" : "1",
    "mother_type" : "sant"
}

{success} Success Response

####Code 200 ####Content

{
    "data": {
        "user_id": 1,
        "name": "shreedhar",
        "father_name": "father_nameq",
        "mother_name": "mother_nameqw",
        "guru_name": "Connor Mcguire",
        "gender": "1",
        "honor": [
            "honorqw",
            "shree"
        ],
        "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",
        "created_by": 1,
        "avatar": "http://global-jain.test/storage/images/sants/1642585998.jpg",
        "updated_at": "2022-01-19T09:53:18.000000Z",
        "created_at": "2022-01-19T09:53:18.000000Z",
        "id": 5
    },
    "message": "Sant created successfully!",
    "status": 200
}

{danger} Unauthenticated Response

####Code 403 ####Content

{
    "message": "Sant is already exist!",
    "status": 403
}

Update Sant

Details for update sant api

####Endpoint

{warning} Please note that the URI for this endpoint should include api/{$version} before

| Method | URI | Headers | | : | :- | : | | POST | user/update-sant/{id} | Bearer {token} |

URL Params

1 //Sant ID

Data Params

{
    "name" : "shreedhar",
    "father_name" : "father_nameq",
    "mother_name" : "mother_nameqw",
    "guru_name": "Connor Mcguire",
    "gender" : "1",
    "avatar" : "http://global-jain.test/storage/images/sants/1642585998.jpg",
    "honor" : "["honorqw","shree"]",
    "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",
    "father_id" : "1",
    "father_type" : "user",
    "mother_id" : "1",
    "mother_type" : "user"
}

{success} Success Response

####Code 200 ####Content

{
    "data": [
        {
            "id": 1,
            "user_id": 1,
            "name": "shr",
            "father_name": "father_nameq",
            "mother_name": "mother_nameqw",
            "guru_name": "Connor Mcguire",
            "gender": 1,
            "avatar": "http://global-jain.test/storage/images/sants/1642584840.jpg",
            "honor": [
                "honorqw",
                "shree"
            ],
            "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,
            "profile_verified_at": null,
            "created_by": 1,
            "updated_by": 1,
            "created_at": "2022-01-19T08:31:27.000000Z",
            "updated_at": "2022-01-19T09:34:00.000000Z",
            "deleted_at": null
        }
    ],
    "message": "Sant updated successfully!",
    "status": 200
}

Info Sant

Details for sant api

####Endpoint

{warning} Please note that the URI for this endpoint should include api/{$version} before

| Method | URI | Headers | | : | :- | : | | GET | user/sant/{id} | Bearer {token} |

URL Params

None

Data Params

None

{success} Success Response

####Code 200 ####Content

{
    "status": 200,
    "success": true,
    "data": {
        "id": 1,
        "user_id": 1,
        "name": "Emi Brock",
        "father_name": "Dominic Gilmore",
        "mother_name": "Connor Mcguire",
        "guru_name": "Connor Mcguire",
        "gender": 2,
        "avatar": "http://global-jain.test/images/misc/placeholder.png",
        "honor": [
            "aa"
        ],
        "qualification": "Consequuntur dicta n",
        "dharma_id": 3,
        "sampraday_id": 1,
        "guru_id": null,
        "birth_date": "0000-00-00",
        "diksha_date": "0000-00-00",
        "diksha_place": "Iusto temporibus ex",
        "about": "Iusto debitis quis v",
        "status": 1,
        "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,
        "followers_count": 0,
        "age": 22,
        "diksha_year": 22,
        "is_user_following" : true,
        "followers": [],
        "shishya": [
            {
                "id": 3,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png",
                "guru_id": 1
            },
            {
                "id": 4,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png",
                "guru_id": 1
            },
            {
                "id": 5,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png",
                "guru_id": 1
            },
        ],
        "maharaj": [
            {
                "id": 3,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png",
                "guru_id": 1
            },
            {
                "id": 4,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png",
                "guru_id": 1
            },
            {
                "id": 5,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png",
                "guru_id": 1
            },
            {
                "id": 6,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png",
                "guru_id": 1
            }
        ],
        "mahasati_ji": [],
        "guru": null,
        "sampraday": {
            "id": 1,
            "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-02-09T10:02:42.000000Z",
            "gachadhipati": {
                "id": 1,
                "name": "Emi Brock",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            }
        },
        "father": [],
        "mother": []
    },
    "message": "Get sant info successfully!"
}

In Review Sant

In Rreview for sant list api

####Endpoint

{warning} Please note that the URI for this endpoint should include api/{$version} before

| Method | URI | Headers | | : | :- | : | | POST | user/in-review/sant | Bearer {token} |

URL Params

None

Data Params

None

{success} Success Response

####Code 200 ####Content

{
    "status": 200,
    "success": true,
    "data": {
        "current_page": 2,
        "data": [
            {
                "id": 12,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 13,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 14,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 15,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 16,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 17,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 19,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 20,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 21,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 22,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            }
        ],
        "first_page_url": "http://global-jain.test/api/v1/user/in-review/sant?page=1",
        "from": 11,
        "last_page": 3,
        "last_page_url": "http://global-jain.test/api/v1/user/in-review/sant?page=3",
        "links": [
            {
                "url": "http://global-jain.test/api/v1/user/in-review/sant?page=1",
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http://global-jain.test/api/v1/user/in-review/sant?page=1",
                "label": "1",
                "active": false
            },
            {
                "url": "http://global-jain.test/api/v1/user/in-review/sant?page=2",
                "label": "2",
                "active": true
            },
            {
                "url": "http://global-jain.test/api/v1/user/in-review/sant?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "http://global-jain.test/api/v1/user/in-review/sant?page=3",
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": "http://global-jain.test/api/v1/user/in-review/sant?page=3",
        "path": "http://global-jain.test/api/v1/user/in-review/sant",
        "per_page": 10,
        "prev_page_url": "http://global-jain.test/api/v1/user/in-review/sant?page=1",
        "to": 20,
        "total": 24
    },
    "message": "Get sant info successfully!"
}

Info Sant

Details for sant api

####Endpoint

{warning} Please note that the URI for this endpoint should include api/{$version} before

| Method | URI | Headers | | : | :- | : | | GET | user/in-review-sant-detail/{id} | Bearer {token} |

URL Params

None

Data Params

None

{success} Success Response

####Code 200 ####Content

{
    "status": 200,
    "success": true,
    "data": {
        "id": 38,
        "sant_id": 38,
        "user_id": 11,
        "name": "bhav",
        "father_name": "jay",
        "mother_name": "shreedhar9",
        "guru_name": null,
        "gender": 1,
        "avatar": "",
        "honor": [
            "chal"
        ],
        "qualification": null,
        "dharma_id": 4,
        "sampraday_id": 24,
        "guru_id": 1,
        "birth_date": "2006-09-14",
        "diksha_date": "2022-02-01",
        "diksha_place": "Ahmedabad, Gujarat, India",
        "about": "jay",
        "status": 2,
        "verification_status": 1,
        "reviewed_fields": null,
        "description": null,
        "current_thana_id": null,
        "profile_verified_at": null,
        "created_by": {
            "id": 11,
            "name": "test creator",
            "avatar": "",
            "is_friends": 1,
            "hide_mobile": null
        },
        "updated_by": 11,
        "created_at": "2022-02-23T12:50:35.000000Z",
        "updated_at": "2022-03-09T15:35:03.000000Z",
        "deleted_at": null,
        "followers_count": 0,
        "age": 15,
        "diksha_year": 0,
        "is_user_following": false,
        "followers": [],
        "shishya": [],
        "maharaj": [],
        "mahasati_ji": [],
        "guru": {
            "id": 1,
            "name": "shreedhar",
            "avatar": "http://127.0.0.1:8000/images/misc/placeholder.png",
            "age": 0,
            "diksha_year": 0,
            "is_user_following": false
        },
        "sampraday": {
            "id": 24,
            "dharma_id": 4,
            "name": "Shree Botad",
            "status": 0,
            "sant_id": 63,
            "created_by": 1,
            "updated_by": 1,
            "created_at": "2022-02-23T17:32:56.000000Z",
            "updated_at": "2022-03-03T15:16:57.000000Z",
            "gachadhipati": {
                "id": 63,
                "name": "P. Ratna Shree Amichandji M.S",
                "avatar": "http://127.0.0.1:8000/images/misc/placeholder.png",
                "age": 0,
                "diksha_year": 0,
                "is_user_following": false,
                "is_approved": 1,
                "is_in_review": 0
            }
        },
        "dharm": {
            "id": 4,
            "name": "Digambar"
        },
        "father": [
            {
                "id": 8,
                "relation_type": 2,
                "relation_id": 3,
                "sant_temp_id": 38,
                "type": "father",
                "created_at": "2022-02-23T12:50:35.000000Z",
                "updated_at": "2022-02-23T12:50:35.000000Z",
                "sant": {
                    "id": 3,
                    "name": "jay",
                    "avatar": "",
                    "age": 0,
                    "diksha_year": 0,
                    "is_user_following": false
                }
            }
        ],
        "mother": [
            {
                "id": 9,
                "relation_type": 2,
                "relation_id": 13,
                "sant_temp_id": 38,
                "type": "mother",
                "created_at": "2022-02-23T12:50:35.000000Z",
                "updated_at": "2022-02-23T12:50:35.000000Z",
                "sant": {
                    "id": 13,
                    "name": "shreedhar9",
                    "avatar": "http://127.0.0.1:8000/images/misc/placeholder.png",
                    "age": 0,
                    "diksha_year": 0,
                    "is_user_following": false
                }
            }
        ],
        "location": {
            "id": 16,
            "user_id": 11,
            "sant_id": 38,
            "thana_sant_id": null,
            "from": "Gandhinagar, Gujarat, India",
            "to": "Ahmedabad, Gujarat, India",
            "start_date": "2022-02-24",
            "end_date": "2022-02-28",
            "start_time": "12:23:00",
            "end_time": null,
            "created_by": {
                "id": 11,
                "name": "test creator",
                "avatar": "",
                "is_friends": 1,
                "hide_mobile": null
            },
            "updated_by": null,
            "created_at": "2022-02-23T12:53:38.000000Z",
            "updated_at": "2022-02-23T12:53:38.000000Z",
            "deleted_at": null,
            "created_ago": "1 month ago",
            "updated_ago": "1 month ago"
        },
        "past_location": {
            "id": 16,
            "user_id": 11,
            "sant_id": 38,
            "thana_sant_id": null,
            "from": "Gandhinagar, Gujarat, India",
            "to": "Ahmedabad, Gujarat, India",
            "start_date": "2022-02-24",
            "end_date": "2022-02-28",
            "start_time": "12:23:00",
            "end_time": null,
            "created_by": {
                "id": 11,
                "name": "test creator",
                "avatar": "",
                "is_friends": 1,
                "hide_mobile": null
            },
            "updated_by": null,
            "created_at": "2022-02-23T12:53:38.000000Z",
            "updated_at": "2022-02-23T12:53:38.000000Z",
            "deleted_at": null,
            "created_ago": "1 month ago",
            "updated_ago": "1 month ago"
        }
    },
    "message": "Get sant info successfully!"
}

In Review Sant

In Rreview for sant list api

####Endpoint

{warning} Please note that the URI for this endpoint should include api/{$version} before

| Method | URI | Headers | | : | :- | : | | POST | user/sant/list | Bearer {token} |

URL Params

None

Data Params

None

{success} Success Response

####Code 200 ####Content

{
    "status": 200,
    "success": true,
    "data": {
        "current_page": 2,
        "data": [
            {
                "id": 11,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 12,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 13,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 14,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 15,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 16,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 17,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 18,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 19,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            },
            {
                "id": 20,
                "name": "shreedhar",
                "avatar": "http://global-jain.test/images/misc/placeholder.png"
            }
        ],
        "first_page_url": "http://global-jain.test/api/v1/user/sant/list?page=1",
        "from": 11,
        "last_page": 3,
        "last_page_url": "http://global-jain.test/api/v1/user/sant/list?page=3",
        "links": [
            {
                "url": "http://global-jain.test/api/v1/user/sant/list?page=1",
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http://global-jain.test/api/v1/user/sant/list?page=1",
                "label": "1",
                "active": false
            },
            {
                "url": "http://global-jain.test/api/v1/user/sant/list?page=2",
                "label": "2",
                "active": true
            },
            {
                "url": "http://global-jain.test/api/v1/user/sant/list?page=3",
                "label": "3",
                "active": false
            },
            {
                "url": "http://global-jain.test/api/v1/user/sant/list?page=3",
                "label": "Next »",
                "active": false
            }
        ],
        "next_page_url": "http://global-jain.test/api/v1/user/sant/list?page=3",
        "path": "http://global-jain.test/api/v1/user/sant/list",
        "per_page": 10,
        "prev_page_url": "http://global-jain.test/api/v1/user/sant/list?page=1",
        "to": 20,
        "total": 27
    },
    "message": "Get sant info successfully!"
}

Sant Follow

Sant follow api

####Endpoint

{warning} Please note that the URI for this endpoint should include api/{$version} before

| Method | URI | Headers | | : | :- | : | | POST | user/sant-follow | Bearer {token} |

URL Params

None

Data Params

sant_id:3

{success} Success Response

####Code 200 ####Content

{
    "status": 200,
    "success": true,
    "message": "Sant unfollow successfully!"
}

Sant Suggestion

Sant suggestion list api

####Endpoint

{warning} Please note that the URI for this endpoint should include api/{$version} before

| Method | URI | Headers | | : | :- | : | | POST | user/sant-suggestion | Bearer {token} |

URL Params

None

Data Params

None

{success} Success Response

####Code 200 ####Content

{
    "status": 200,
    "success": true,
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 1,
                "name": "Emi Brock",
                "sampraday_id": 1,
                "dharma_id": 3,
                "guru_id": null,
                "avatar": "http://global-jain.test/images/misc/placeholder.png",
                "age": 0,
                "diksha_year": 0,
                "is_user_following" : true,
                "sampraday": {
                    "id": 1,
                    "name": "Harriet Powers"
                },
                "dharm": {
                    "id": 3,
                    "name": "Terapanthi"
                }
            },
            {
                "id": 4,
                "name": "shreedhar",
                "sampraday_id": 1,
                "dharma_id": 2,
                "guru_id": 1,
                "avatar": "http://global-jain.test/images/misc/placeholder.png",
                "age": 0,
                "diksha_year": 0,
                "is_user_following" : true,
                "sampraday": {
                    "id": 1,
                    "name": "Harriet Powers"
                },
                "dharm": {
                    "id": 2,
                    "name": "Sthanakvasi"
                }
            }
        ],
        "first_page_url": "http://global-jain.test/api/v1/user/sant-suggestion?page=1",
        "from": 1,
        "last_page": 1,
        "last_page_url": "http://global-jain.test/api/v1/user/sant-suggestion?page=1",
        "links": [
            {
                "url": null,
                "label": "« Previous",
                "active": false
            },
            {
                "url": "http://global-jain.test/api/v1/user/sant-suggestion?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-suggestion",
        "per_page": 10,
        "prev_page_url": null,
        "to": 2,
        "total": 2
    },
    "message": "Sant unfollow successfully!"
}

{danger} Unauthenticated Response

####Code 403 ####Content

{
    "message": "Something went wrong!",
    "status": 403
}

Add/Update Sant's Current Location

Details for add/update sant location api

####Endpoint

{warning} Please note that the URI for this endpoint should include api/{$version} before

| Method | URI | Headers | | : | :- | : | | POST | user/update-sant-location | Bearer {token} |

URL Params

None

Data Params

{
    "sant_id": 2,
    "location": "Rajkot",
    "latitude": "12.45533223",
    "longitude": "45.4422313"
}

{success} Success Response

####Code 200 ####Content

{
    "message": "Sant location updated successfully!",
    "status": 200
}

{danger} Unauthenticated Response

####Code 403 ####Content

{
    "message": "Something went wrong!",
    "status": 403
}