113 lines
1.5 KiB
Markdown
113 lines
1.5 KiB
Markdown
# 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
|
|
}
|
|
```
|
|
|