# System Admin 1
## BASE URL: https://api.dev.core.restspaces.org/
## Status
Evert table have a status field and here have three option that is,
```
status ->
i. active
ii. inactive
iii. archived
```
**archived** means soft delete and **active** and **inactive** will facus in status field.
## 1. RS Types
**(i) Admin/moderator create space types keywords**
```json
Request Body:
POST {{BASE_URL}}/api/v1/spaces/admin/types/
{
"name": "Private",
"description": "Test Description 2",
"icon": "https://example.com/1.png"
}
Response:
Status Code: 201
{
"success": true,
"message": "Created",
"data": {
"id": 2,
"created_at": "2022-03-18T17:21:32.512723Z",
"updated_at": "2022-03-18T17:21:32.512848Z",
"created_by": {
"username": "admin",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/klnvuh_male-profile-pic-png",
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"updated_by": {},
"name": "Private",
"description": "Test Description 2",
"status": "active"
}
}
```
**(ii) Get all space type**
```json
Request Body:
GET {{BASE_URL}}/api/v1/spaces/admin/types/
Response:
Status Code: 200
{
"success": true,
"meta_data": {
"count": 2,
"page_size": 10,
"next": null,
"previous": null
},
"data": [
{
"name": "Private",
"description": "Test Description",
"status": "active"
},
{
"name": "Private",
"description": "Test Description 2",
"status": "active"
}
]
}
```
**(iii) Retrive single types keyword**
```json
Request Body:
GET {{BASE_URL}}/api/v1/spaces/admin/types/<pk>/
Response:
Status Code: 200
{
"success": true,
"message": "Status OK",
"data": {
"name": "Private",
"description": "Test Description 2",
"status": "active"
}
}
```
**(iv) Update space types keywords**
```json
Request Body:
PATCH {{BASE_URL}}/api/v1/spaces/admin/types/<pk>/
{
"status": "inactive"
}
Response:
Status Code: 200
{
"success": true,
"message": "Status OK",
"data": {
"id": 2,
"created_at": "2022-03-18T17:21:32.512723Z",
"updated_at": "2022-03-18T17:24:39.948735Z",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/klnvuh_male-profile-pic-png"
},
"updated_by": {
"username": "admin",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/klnvuh_male-profile-pic-png",
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"name": "Private",
"description": "Test Description 2",
"status": "inactive"
}
}
```
**(v) Delete space types keywords**
```json
Request Body:
PATCH {{BASE_URL}}/api/v1/spaces/admin/types/<pk>/
{
"status": "archived"
}
Response:
Status Code: 200
```
## 2. Amenities
**(i) Admin/moderator create space amenities keywords**
```json
Request Body:
POST {{BASE_URL}}/api/v1/spaces/admin/amenities/
{
"name": "Amenitiesc 3",
"icon": "http://example.com/1.png"
}
Response:
Status Code: 201
{
"success": true,
"message": "Created",
"data": {
"id": 1,
"created_by": {
"username": "admin",
"profile_pic_url": null,
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"created_at": "2021-12-17T21:07:17.981917+06:00",
"name": "Amenitiesc 3",
"icon": "http://example.com/1.png"
}
}
```
**(ii) Get all amenities keywords**
```json
Request Body:
GET {{BASE_URL}}/api/v1/spaces/admin/amenities/
Response:
Status Code: 200
{
"success": true,
"meta_data": {
"count": 3,
"page_size": 10,
"next": null,
"previous": null
},
"data": [
{
"id": 1,
"created_at": "2021-12-17T21:07:17.981917+06:00",
"updated_at": "2021-12-17T21:07:17.981942+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Amenitiesc 3",
"icon": "http://example.com/1.png",
"status": "active"
},
{
"id": 2,
"created_at": "2021-12-17T21:11:05.423133+06:00",
"updated_at": "2021-12-17T21:11:05.423232+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Amenitiesc 2",
"icon": "http://example.com/1.png",
"status": "active"
},
{
"id": 3,
"created_at": "2021-12-17T21:11:13.845865+06:00",
"updated_at": "2021-12-17T21:11:13.845915+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Amenitiesc 1",
"icon": "http://example.com/1.png",
"status": "active"
}
]
}
```
**(iii) Retrive single amenities keyword**
```json
Request Body:
GET {{BASE_URL}}/api/v1/spaces/admin/amenities/<pk>/
Response:
Status Code: 200
{
"success": true,
"message": "Status OK",
"data": {
"id": 6,
"created_at": "2021-12-05T23:14:34.346872+06:00",
"updated_at": "2021-12-05T23:14:34.346906+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Unlimited Food",
"icon": "https://cdn1.iconfinder.com/data/icons/office-spaces-line/32/break-area-rest-office-space-512.png",
"status": "active"
}
}
```
**(iv) Update space amenities keywords**
```json
Request Body:
PATCH {{BASE_URL}}/api/v1/spaces/admin/amenities/<pk>/
{
"name": "Amenitiesc 1",
"icon": "http://example.com/1.png"
}
Response:
Status Code: 200
{
"success": true,
"message": "Status OK",
"data": {
"id": 6,
"created_at": "2021-12-05T23:14:34.346872+06:00",
"updated_at": "2021-12-05T23:26:01.177438+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"username": "admin",
"profile_pic_url": null,
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"name": "Unlimited Food",
"icon": "https://cdn1.iconfinder.com/data/icons/office-spaces-line/32/break-area-rest-office-space-512.png",
"status": "inactive"
}
}
```
**(v) Delete space amenities keywords**
```json
Request Body:
PATCH {{BASE_URL}}/api/v1/spaces/admin/amenities/<pk>/
{
"status": "archived"
}
Response:
Status Code: 200
```
## 3. Type-Ameneties
**(i) Admin will create room type-amenities**
```json
Request Body:
POST {{BASE_URL}}/api/v1/spaces/admin/type-amenities/
{
"space_type": 1,
"amenities": [1,2,3]
}
Response:
Status Code: 201
{
"success": true,
"message": "Created",
"data": [
{
"id": 1,
"created_at": "2021-12-17T21:31:42.810099+06:00",
"updated_at": "2021-12-17T21:31:42.810139+06:00",
"created_by": {
"username": "admin",
"profile_pic_url": null,
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"updated_by": {},
"status": "active",
"space_type": 1,
"amenities": 1
},
{
"id": 2,
"created_at": "2021-12-17T21:31:42.817428+06:00",
"updated_at": "2021-12-17T21:31:42.817484+06:00",
"created_by": {
"username": "admin",
"profile_pic_url": null,
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"updated_by": {},
"status": "active",
"space_type": 1,
"amenities": 2
},
{
"id": 3,
"created_at": "2021-12-17T21:31:42.820705+06:00",
"updated_at": "2021-12-17T21:31:42.820748+06:00",
"created_by": {
"username": "admin",
"profile_pic_url": null,
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"updated_by": {},
"status": "active",
"space_type": 1,
"amenities": 3
}
]
}
```
**(ii) Admin will get list of type-amenities keywords**
```json
Request Body:
GET {{BASE_URL}}/api/v1/spaces/admin/type-amenities/?space_type
Response:
Status Code: 200
{
"success": true,
"meta_data": {
"count": 3,
"page_size": 10,
"next": null,
"previous": null
},
"data": [
{
"id": 1,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"amenities": {
"id": 1,
"created_at": "2021-12-17T21:07:17.981917+06:00",
"updated_at": "2021-12-17T21:07:17.981942+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Amenitiesc 3",
"icon": "http://example.com/1.png",
"status": "active"
},
"created_at": "2021-12-17T21:31:42.810099+06:00",
"updated_at": "2021-12-17T21:31:42.810139+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 2,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"amenities": {
"id": 2,
"created_at": "2021-12-17T21:11:05.423133+06:00",
"updated_at": "2021-12-17T21:11:05.423232+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Amenitiesc 2",
"icon": "http://example.com/1.png",
"status": "active"
},
"created_at": "2021-12-17T21:31:42.817428+06:00",
"updated_at": "2021-12-17T21:31:42.817484+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 3,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"amenities": {
"id": 3,
"created_at": "2021-12-17T21:11:13.845865+06:00",
"updated_at": "2021-12-17T21:11:13.845915+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Amenitiesc 1",
"icon": "http://example.com/1.png",
"status": "active"
},
"created_at": "2021-12-17T21:31:42.820705+06:00",
"updated_at": "2021-12-17T21:31:42.820748+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
}
]
}
```
**(iii) And get single type-amenities keywords**
```json
Request Body:
GET {{BASE_URL}}/api/v1/spaces/admin/type-amenities/?space_type/<pk>/
Response:
Status Code: 200
{
"success": true,
"meta_data": {
"count": 3,
"page_size": 10,
"next": null,
"previous": null
},
"data": [
{
"id": 1,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"amenities": {
"id": 1,
"created_at": "2021-12-17T21:07:17.981917+06:00",
"updated_at": "2021-12-17T21:07:17.981942+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Amenitiesc 3",
"icon": "http://example.com/1.png",
"status": "active"
},
"created_at": "2021-12-17T21:31:42.810099+06:00",
"updated_at": "2021-12-17T21:31:42.810139+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 2,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"amenities": {
"id": 2,
"created_at": "2021-12-17T21:11:05.423133+06:00",
"updated_at": "2021-12-17T21:11:05.423232+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Amenitiesc 2",
"icon": "http://example.com/1.png",
"status": "active"
},
"created_at": "2021-12-17T21:31:42.817428+06:00",
"updated_at": "2021-12-17T21:31:42.817484+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 3,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"amenities": {
"id": 3,
"created_at": "2021-12-17T21:11:13.845865+06:00",
"updated_at": "2021-12-17T21:11:13.845915+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Amenitiesc 1",
"icon": "http://example.com/1.png",
"status": "active"
},
"created_at": "2021-12-17T21:31:42.820705+06:00",
"updated_at": "2021-12-17T21:31:42.820748+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
}
]
}
```
**(iv) Admin update type-amenities keywords**
```json
Request Body:
PATCH {{BASE_URL}}/api/v1/spaces/admin/type-amenities/
Response:
Status Code: 200
```
**(v) Admin delete type-amenities**
```json
Request Body:
PATCH {{BASE_URL}}/api/v1/spaces/admin/type-amenities/?space_type/1/
{
"status": "archived"
}
Response:
Status Code: 200
```
## 4. Get Type wise Amenities list
```json
Request Body:
GET {{BASE_URL}}/api/v1/spaces/admin/type-amenities/?space_type=<space_type pk>
{
"status": "archived"
}
Response:
{
"success": true,
"meta_data": {
"count": 3,
"page_size": 10,
"next": null,
"previous": null
},
"data": [
{
"id": 1,
"space_type": {
"id": 1,
"created_at": "2022-01-10T07:59:32.509165+06:00",
"updated_at": "2022-01-10T07:59:32.509184+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"amenities": {
"id": 1,
"created_at": "2022-01-10T08:00:18.788439+06:00",
"updated_at": "2022-01-10T08:00:18.788466+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Amenitiesc 1",
"icon": "http://example.com/1.png",
"status": "active"
},
"created_at": "2022-01-10T08:01:14.725168+06:00",
"updated_at": "2022-01-10T08:01:14.725193+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 2,
"space_type": {
"id": 1,
"created_at": "2022-01-10T07:59:32.509165+06:00",
"updated_at": "2022-01-10T07:59:32.509184+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"amenities": {
"id": 2,
"created_at": "2022-01-10T08:00:29.474152+06:00",
"updated_at": "2022-01-10T08:00:29.474193+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Amenitiesc 2",
"icon": "http://example.com/1.png",
"status": "active"
},
"created_at": "2022-01-10T08:01:14.731556+06:00",
"updated_at": "2022-01-10T08:01:14.731602+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 3,
"space_type": {
"id": 1,
"created_at": "2022-01-10T07:59:32.509165+06:00",
"updated_at": "2022-01-10T07:59:32.509184+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"amenities": {
"id": 3,
"created_at": "2022-01-10T08:00:35.649193+06:00",
"updated_at": "2022-01-10T08:00:35.649325+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "Amenitiesc 3",
"icon": "http://example.com/1.png",
"status": "active"
},
"created_at": "2022-01-10T08:01:14.733535+06:00",
"updated_at": "2022-01-10T08:01:14.733558+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
}
]
}
```
## 5. Highlights
**(i) Admin/moderator create space highlights keywords**
```json
Request Body:
POST {{BASE_URL}} /api/v1/spaces/admin/highlights/
{
"name": "hightlights 1"
}
Response:
Status Code: 201
{
"success": true,
"message": "Created",
"data": {
"id": 1,
"created_by": {
"username": "admin",
"profile_pic_url": null,
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"created_at": "2021-12-17T21:24:34.900878+06:00",
"name": "hightlights 1"
}
}
```
**(ii) Get all highlights keywords**
```json
Request Body:
GET {{BASE_URL}} /api/v1/spaces/admin/highlights/
Response:
Status Code: 200
{
"success": true,
"meta_data": {
"count": 4,
"page_size": 10,
"next": null,
"previous": null
},
"data": [
{
"id": 1,
"created_at": "2021-12-17T21:24:34.900878+06:00",
"updated_at": "2021-12-17T21:24:34.900946+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "hightlights 1",
"status": "active"
},
{
"id": 2,
"created_at": "2021-12-17T21:24:55.980815+06:00",
"updated_at": "2021-12-17T21:24:55.980854+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "hightlights 2",
"status": "active"
},
{
"id": 3,
"created_at": "2021-12-17T21:25:00.991396+06:00",
"updated_at": "2021-12-17T21:25:00.991427+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "hightlights 3",
"status": "active"
},
{
"id": 4,
"created_at": "2021-12-17T21:25:06.590760+06:00",
"updated_at": "2021-12-17T21:25:06.590798+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "hightlights 4",
"status": "active"
}
]
}
```
**(iii) Retrive single highlights keyword**
```json
Request Body:
GET {{BASE_URL}} /api/v1/spaces/admin/highlights/<pk>/
Response:
Status Code: 200
{
"success": true,
"message": "Status OK",
"data": {
"id": 1,
"created_at": "2021-12-17T21:24:34.900878+06:00",
"updated_at": "2021-12-17T21:24:34.900946+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "hightlights 1",
"status": "active"
}
}
```
**(iv) Update space highlights keywords**
```json
Request Body:
PATCH {{BASE_URL}} /api/v1/spaces/admin/highlights/<pk>/
{
"status": "inactive"
}
Response:
Status Code: 200
{
"success": true,
"message": "Status OK",
"data": {
"id": 1,
"created_at": "2021-12-17T21:24:34.900878+06:00",
"updated_at": "2021-12-17T21:49:19.321166+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"username": "admin",
"profile_pic_url": null,
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"name": "hightlights 1",
"status": "inactive"
}
}
```
**(v) Delete space highlights keywords**
```json
Request Body:
PATCH {{BASE_URL}} /api/v1/spaces/admin/highlights/<pk>/
{
"status": "archived"
}
Response:
Status Code: 200
```
## 6. Type-Highlights
**(i) Admin create type-highlights**
```json
Request Body:
POST {{BASE_URL}} /api/v1/spaces/admin/type-highlights/
{
"space_type": 1,
"highlights": [1,2,3,4]
}
Response:
Status Code:
{
"success": true,
"message": "Created",
"data": [
{
"id": 1,
"created_at": "2021-12-17T21:56:15.868672+06:00",
"updated_at": "2021-12-17T21:56:15.868715+06:00",
"created_by": {
"username": "admin",
"profile_pic_url": null,
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"updated_by": {},
"status": "active",
"space_type": 1,
"highlights": 1
},
{
"id": 2,
"created_at": "2021-12-17T21:56:15.876128+06:00",
"updated_at": "2021-12-17T21:56:15.876178+06:00",
"created_by": {
"username": "admin",
"profile_pic_url": null,
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"updated_by": {},
"status": "active",
"space_type": 1,
"highlights": 2
},
{
"id": 3,
"created_at": "2021-12-17T21:56:15.878765+06:00",
"updated_at": "2021-12-17T21:56:15.878799+06:00",
"created_by": {
"username": "admin",
"profile_pic_url": null,
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"updated_by": {},
"status": "active",
"space_type": 1,
"highlights": 3
},
{
"id": 4,
"created_at": "2021-12-17T21:56:15.881358+06:00",
"updated_at": "2021-12-17T21:56:15.881397+06:00",
"created_by": {
"username": "admin",
"profile_pic_url": null,
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"updated_by": {},
"status": "active",
"space_type": 1,
"highlights": 4
}
]
}
```
**(ii) Admin get list of type-amenities**
```json
Request Body:
GET {{BASE_URL}} /api/v1/spaces/admin/type-highlights/?space_type=<space_type pk>
Response:
Status Code: 200
{
"success": true,
"meta_data": {
"count": 4,
"page_size": 10,
"next": null,
"previous": null
},
"data": [
{
"id": 1,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"highlights": {
"id": 1,
"created_at": "2021-12-17T21:24:34.900878+06:00",
"updated_at": "2021-12-17T21:50:11.784498+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "hightlights 1",
"status": "active"
},
"created_at": "2021-12-17T21:56:15.868672+06:00",
"updated_at": "2021-12-17T21:56:15.868715+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 2,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"highlights": {
"id": 2,
"created_at": "2021-12-17T21:24:55.980815+06:00",
"updated_at": "2021-12-17T21:24:55.980854+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "hightlights 2",
"status": "active"
},
"created_at": "2021-12-17T21:56:15.876128+06:00",
"updated_at": "2021-12-17T21:56:15.876178+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 3,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"highlights": {
"id": 3,
"created_at": "2021-12-17T21:25:00.991396+06:00",
"updated_at": "2021-12-17T21:25:00.991427+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "hightlights 3",
"status": "active"
},
"created_at": "2021-12-17T21:56:15.878765+06:00",
"updated_at": "2021-12-17T21:56:15.878799+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 4,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"highlights": {
"id": 4,
"created_at": "2021-12-17T21:25:06.590760+06:00",
"updated_at": "2021-12-17T21:25:06.590798+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "hightlights 4",
"status": "active"
},
"created_at": "2021-12-17T21:56:15.881358+06:00",
"updated_at": "2021-12-17T21:56:15.881397+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
}
]
}
```
**(iii) admin get single keywords of type-amenities**
```json
Request Body:
GET {{BASE_URL}} /api/v1/spaces/admin/type-highlights/?space_type=<space_type pk>
Response:
Status Code: 200
{
"success": true,
"meta_data": {
"count": 4,
"page_size": 10,
"next": null,
"previous": null
},
"data": [
{
"id": 1,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"highlights": {
"id": 1,
"created_at": "2021-12-17T21:24:34.900878+06:00",
"updated_at": "2021-12-17T21:50:11.784498+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "hightlights 1",
"status": "active"
},
"created_at": "2021-12-17T21:56:15.868672+06:00",
"updated_at": "2021-12-17T21:56:15.868715+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 2,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"highlights": {
"id": 2,
"created_at": "2021-12-17T21:24:55.980815+06:00",
"updated_at": "2021-12-17T21:24:55.980854+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "hightlights 2",
"status": "active"
},
"created_at": "2021-12-17T21:56:15.876128+06:00",
"updated_at": "2021-12-17T21:56:15.876178+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 3,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"highlights": {
"id": 3,
"created_at": "2021-12-17T21:25:00.991396+06:00",
"updated_at": "2021-12-17T21:25:00.991427+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "hightlights 3",
"status": "active"
},
"created_at": "2021-12-17T21:56:15.878765+06:00",
"updated_at": "2021-12-17T21:56:15.878799+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 4,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"highlights": {
"id": 4,
"created_at": "2021-12-17T21:25:06.590760+06:00",
"updated_at": "2021-12-17T21:25:06.590798+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "hightlights 4",
"status": "active"
},
"created_at": "2021-12-17T21:56:15.881358+06:00",
"updated_at": "2021-12-17T21:56:15.881397+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
}
]
}
```
**(iv) Admin can update type-highlights**
```json
Request Body:
PATCH {{BASE_URL}} /api/v1/spaces/admin/highlights/<pk>/
Response:
Status Code: 200
```
**(v) admin delete type-highlights**
```json
Request Body:
PATCH {{BASE_URL}} /api/v1/spaces/admin/highlights/<pk>/
{
"status": "archived"
}
Response:
Status Code: 200
```
## 7. Get Type wise Highlights list
```json
Request Body:
PATCH {{BASE_URL}} /api/v1/spaces/admin/type-highlights/?space_type=<space_type pk>
Response:
Status Code: 200
{
"success": true,
"meta_data": {
"count": 4,
"page_size": 10,
"next": null,
"previous": null
},
"data": [
{
"id": 1,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"highlights": {
"id": 1,
"created_at": "2021-12-17T21:24:34.900878+06:00",
"updated_at": "2021-12-17T21:50:11.784498+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "hightlights 1",
"status": "active"
},
"created_at": "2021-12-17T21:56:15.868672+06:00",
"updated_at": "2021-12-17T21:56:15.868715+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 2,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"highlights": {
"id": 2,
"created_at": "2021-12-17T21:24:55.980815+06:00",
"updated_at": "2021-12-17T21:24:55.980854+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "hightlights 2",
"status": "active"
},
"created_at": "2021-12-17T21:56:15.876128+06:00",
"updated_at": "2021-12-17T21:56:15.876178+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 3,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"highlights": {
"id": 3,
"created_at": "2021-12-17T21:25:00.991396+06:00",
"updated_at": "2021-12-17T21:25:00.991427+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "hightlights 3",
"status": "active"
},
"created_at": "2021-12-17T21:56:15.878765+06:00",
"updated_at": "2021-12-17T21:56:15.878799+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
},
{
"id": 4,
"space_type": {
"id": 1,
"created_at": "2021-12-17T21:12:35.353195+06:00",
"updated_at": "2021-12-17T21:19:41.374424+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"name": "Private",
"description": "Test Description",
"status": "active"
},
"highlights": {
"id": 4,
"created_at": "2021-12-17T21:25:06.590760+06:00",
"updated_at": "2021-12-17T21:25:06.590798+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"name": "hightlights 4",
"status": "active"
},
"created_at": "2021-12-17T21:56:15.881358+06:00",
"updated_at": "2021-12-17T21:56:15.881397+06:00",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": null
},
"updated_by": {},
"status": "active"
}
]
}
```
## 8. Far Booking Day
**(i) Admin create a list of day table**
```json
Request Body:
POST {{BASE_URL}}/api/v1/spaces/admin/far-booking-day/
{
"value": 1,
"name": "day"
}
Response:
Status Code: 201
{
"success": true,
"message": "Created",
"data": {
"id": 1,
"created_at": "2022-03-18T17:12:15.180840Z",
"updated_at": "2022-03-18T17:12:15.180967Z",
"created_by": {
"username": "admin",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/klnvuh_male-profile-pic-png",
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"updated_by": {},
"uid": "d1727d44-2a99-4d58-a702-2239183b6537",
"name": "day",
"value": 1,
"status": "active"
}
}
```
**(ii) Get app booking day**
```json
Request Body:
GET {{BASE_URL}}/api/v1/spaces/admin/far-booking-day/
Response:
Status Code: 200
{
"success": true,
"meta_data": {
"count": 3,
"page_size": 10,
"next": null,
"previous": null
},
"data": [
{
"id": 1,
"uid": "d1727d44-2a99-4d58-a702-2239183b6537",
"name": "day",
"value": 1,
"status": "active"
},
{
"id": 2,
"uid": "80c1e46b-0886-46c5-86cc-5b1d045ca272",
"name": "day",
"value": 2,
"status": "active"
},
{
"id": 3,
"uid": "1322758d-c0ed-4bfb-89cd-921ffcaafe8a",
"name": "day",
"value": 3,
"status": "active"
}
]
}
```
**(iii) retrive single data**
```json
Request Body:
GET {{BASE_URL}}/api/v1/spaces/admin/far-booking-day/<pk>/
Response:
Status Code: 200
{
"success": true,
"message": "Status OK",
"data": {
"id": 1,
"uid": "d1727d44-2a99-4d58-a702-2239183b6537",
"name": "day",
"value": 1,
"status": "active"
}
}
```
**(iv) update single data**
```json
Request Body:
PATCH {{BASE_URL}}/api/v1/spaces/admin/far-booking-day/<pk>/
{
"status": "inactive"
}
Response:
Status Code: 200
{
"success": true,
"message": "Status OK",
"data": {
"id": 1,
"created_at": "2022-03-18T17:12:15.180840Z",
"updated_at": "2022-03-18T17:15:49.368068Z",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/klnvuh_male-profile-pic-png"
},
"updated_by": {
"username": "admin",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/klnvuh_male-profile-pic-png",
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"uid": "d1727d44-2a99-4d58-a702-2239183b6537",
"name": "day",
"value": 1,
"status": "inactive"
}
}
```
**(v) delete single data**
```json
Request Body:
PATCH {{BASE_URL}} /api/v1/spaces/admin/far-booking-day/<pk>/
{
"status": "archived"
}
Response:
Status Code: 200
```
## 9. Admin Time Slot
**(i) Admin create Time Slot**
```json
POST /api/v1/spaces/admin/time-slots/ HTTP/1.1
Authorization: jwt <token>
Requst Body:
{
"duration": 15,
"unit": "minutes"
}
Response:
status code: 201
{
"success": true,
"message": "Created",
"data": {
"id": 1,
"created_at": "2022-01-25T01:42:42.041978Z",
"updated_at": "2022-01-25T01:42:42.042026Z",
"created_by": {
"username": "+8801740999768",
"profile_pic_url": null,
"first_name": "MSI",
"last_name": "Shafik",
"email": "shafik.te@gmail.com"
},
"updated_by": {},
"uid": "2dd2cd41-7499-41e6-90b1-17845fe05a96",
"duration": 15,
"unit": "minutes",
"status": "active"
}
}
```
**(ii) Get Time Slot list**
```json
Request Body:
GET {{BASE_URL}}/api/v1/spaces/admin/time-slots/
```
**(iv) update time slot**
```json
Request Body:
PATCH {{BASE_URL}}/api/v1/spaces/admin/time-slots/<pk>/
{
"value": 20
}
Response:
```
## 10. Guest Requirements
**(i) Create Guest Requirments data**
```json
Request Body:
POST {{BASE_URL}} /api/v1/spaces/admin/guest-requirements/
{
"name": "lorem ipsum"
}
Response:
Status Code: 200
{
"success": true,
"message": "Created",
"data": {
"id": 1,
"created_at": "2022-03-18T17:05:06.292807Z",
"updated_at": "2022-03-18T17:05:06.292929Z",
"created_by": {
"username": "admin",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/klnvuh_male-profile-pic-png",
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"updated_by": {},
"name": "lorem ipsum",
"status": "active"
}
}
```
**(ii) Get list of Guest Requirments data**
```json
Request Body:
GET {{BASE_URL}} /api/v1/spaces/admin/guest-requirements/
Response:
Status Code: 200
{
"success": true,
"meta_data": {
"count": 1,
"page_size": 10,
"next": null,
"previous": null
},
"data": [
{
"id": 1,
"name": "lorem ipsum",
"status": "active"
}
]
}
```
**(iii) Get Guest Requirments single data**
```json
Request Body:
GET {{BASE_URL}} /api/v1/spaces/admin/guest-requirements/<pk>/
Response:
Status Code: 200
{
"success": true,
"message": "Status OK",
"data": {
"id": 1,
"name": "lorem ipsum",
"status": "active"
}
}
```
**(iv) Update Guest Requirments data**
```json
Request Body:
PATCH {{BASE_URL}} /api/v1/spaces/admin/guest-requirements/<pk>/
{
"status": "inactive"
}
Response:
Status Code: 200
{
"success": true,
"message": "Status OK",
"data": {
"id": 1,
"created_at": "2022-03-18T17:05:06.292807Z",
"updated_at": "2022-03-18T17:09:16.905821Z",
"created_by": {
"email": null,
"username": "admin",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/klnvuh_male-profile-pic-png"
},
"updated_by": {
"username": "admin",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/klnvuh_male-profile-pic-png",
"first_name": "MSI",
"last_name": "Shafik",
"email": null
},
"name": "lorem ipsum",
"status": "inactive"
}
}
```
**(v) Delete Guest Requirments single data**
```json
Request Body:
PATCH {{BASE_URL}} /api/v1/spaces/admin/guest-requirements/
{
"status": "archived"
}
Response:
Status Code: 200
```
## 11. Admin Hints
**(i) Create Admin Hints data**
```json
POST {{BASE_URL}} /api/v1/spaces/admin/admin-hints/
Request Body:
{
"title": "Guest find your listing",
"text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.",
"icon": "https://exampl.com/1.png",
"instruction_type": "finding" (or "control", "notification", "protect")
}
Response:
Status Code: 201
{
"success": true,
"message": "Created",
"data": {
"id": 1,
"created_at": "2022-03-31T17:52:04.200124Z",
"updated_at": "2022-03-31T17:52:04.200148Z",
"created_by": {
"username": "+8801740999768",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/klnvuh_male-profile-pic-png",
"first_name": "MSI",
"last_name": "Shafik",
"email": "shafik.te@gmail.com"
},
"updated_by": {},
"title": "Guest find your listing",
"text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.",
"icon": "https://exampl.com/1.png",
"instruction_type": "finding",
"status": "active"
}
}
```
**(ii) Get list of Admin Hints data**
```json
GET {{BASE_URL}} /api/v1/spaces/admin/admin-hints/
Response:
Status Code: 200
{
"success": true,
"meta_data": {
"count": 1,
"page_size": 10,
"next": null,
"previous": null
},
"data": [
{
"id": 1,
"title": "Guest find your listing",
"text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna.",
"icon": "https://exampl.com/1.png",
"instruction_type": "finding"
}
]
}
```
**(iii) Update Admin hints data**
```json
PATCH {{BASE_URL}} /api/v1/spaces/admin/admin-hints/<pk>/
{
"text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna kosole."
}
Response:
Status Code: 200
{
"success": true,
"message": "Status OK",
"data": {
"id": 1,
"created_at": "2022-03-31T17:52:04.200124Z",
"updated_at": "2022-03-31T17:53:22.231403Z",
"created_by": {
"email": "shafik.te@gmail.com",
"username": "+8801740999768",
"last_name": "Shafik",
"first_name": "MSI",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/klnvuh_male-profile-pic-png"
},
"updated_by": {
"username": "+8801740999768",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/klnvuh_male-profile-pic-png",
"first_name": "MSI",
"last_name": "Shafik",
"email": "shafik.te@gmail.com"
},
"title": "Guest find your listing",
"text": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna kosole.",
"icon": "https://exampl.com/1.png",
"instruction_type": "finding",
"status": "active"
}
}
```
**(v) Delete Guest Requirments single data**
```json
Request Body:
PATCH {{BASE_URL}} /api/v1/spaces/admin/admin-hints/<pk>/
{
"status": "archived"
}
Response:
Status Code: 200
```
## 12. Admin Business List API
By this API admin will see the all business list
```
GET /api/v1/business/admin/business/ HTTP/1.1
Authorization: jwt <token>
Response:
{
"success": true,
"meta_data": {
"count": 1,
"page_size": 10,
"next": null,
"previous": null
},
"data": [
{
"uid": "e5924564-808d-4241-9fb2-36a56fa0ef68",
"name": "My Business",
"address": "Dhaka, Bangladesh",
"images": [
"http://example.com/p.png",
"http://s3.aws.com/alkdf/"
],
"phone": "+8801740999768",
"fax": null,
"email": "shafik.te@gmail.com",
"status": "active"
}
]
}
```
## 13. Admin Business Update API
```json
PATCH /api/v1/business/admin/business/e5924564-808d-4241-9fb2-36a56fa0ef68/ HTTP/1.1
Authorization: jwt <token>
Request Body:
{
"name": "My Business",
"address": "Dhaka, Bangladesh",
"phone": "+8801740999768",
"email": "shafik.te@gmail.com",
"images": ["http://example.com/p.png", "http://s3.aws.com/alkdf/"]
}
Response:
{
"success": true,
"message": "Status OK",
"data": {
"uid": "e5924564-808d-4241-9fb2-36a56fa0ef68",
"name": "My Business",
"address": "Dhaka, Bangladesh",
"images": [
"http://example.com/p.png",
"http://s3.aws.com/alkdf/"
],
"phone": "+8801740999768",
"fax": null,
"email": "shafik.te@gmail.com",
"created_by": {
"email": "mrhasantests@gmail.com",
"username": "+8801303140128",
"last_name": "Hasan",
"first_name": "Rakibul",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/mjllbg_image-jpg"
},
"updated_by": {
"username": "shafik.te@gmail.com",
"profile_pic_url": null,
"first_name": "MSI",
"last_name": "Shafik",
"email": "shafik.te@gmail.com"
}
}
}
```
## 14. Business
### 14.1 List
```json
GET /api/v1/business/admin/business/ HTTP/1.1
Authorization: jwt <token>
Response:
{
"uid": "41e6e3cf-4126-4715-85e1-bcaf065cf415",
"name": "Asif Ahmed",
"address": "56/c,c block ,jamtola,main road,aftabnagar",
"images": [
"https://s3-us-west-1.amazonaws.com/development-restspace/core/mqhhlb_4aa8bcc4e516cde163218cccf02ac703-naruto-madara-anime-naruto-jpg",
"https://s3-us-west-1.amazonaws.com/development-restspace/core/ccabdr_4aa8bcc4e516cde163218cccf02ac703-naruto-madara-anime-naruto-jpg"
],
"phone": "01789339847",
"fax": null,
"email": "aumi.asif@gmail.com",
"status": "active"
}
```
### 14.2 UPDATE
```json
PATCH /api/v1/business/admin/business/< business uid >/ HTTP/1.1
Authorization: jwt <token>
Request:
{
"name": "Asif Ahmed",
"address": "56/c,c block ,jamtola,main road,aftabnagar",
"images": [
"https://s3-us-west-1.amazonaws.com/development-restspace/core/mqhhlb_4aa8bcc4e516cde163218cccf02ac703-naruto-madara-anime-naruto-jpg",
"https://s3-us-west-1.amazonaws.com/development-restspace/core/ccabdr_4aa8bcc4e516cde163218cccf02ac703-naruto-madara-anime-naruto-jpg"
],
"phone": "01789339847",
"fax": null,
"email": "aumi.asif@gmail.com",
"status": "active"
}
Response:
{
"success": true,
"message": "Status OK",
"data": {
"uid": "41e6e3cf-4126-4715-85e1-bcaf065cf415",
"name": "Asif Ahmed",
"address": "56/c,c block ,jamtola,main road,aftabnagar",
"images": [
"https://s3-us-west-1.amazonaws.com/development-restspace/core/mqhhlb_4aa8bcc4e516cde163218cccf02ac703-naruto-madara-anime-naruto-jpg",
"https://s3-us-west-1.amazonaws.com/development-restspace/core/ccabdr_4aa8bcc4e516cde163218cccf02ac703-naruto-madara-anime-naruto-jpg"
],
"phone": "01789339847",
"fax": null,
"email": "aumi.asif@gmail.com",
"created_by": {
"email": "mrhasantests@gmail.com",
"username": "+8801303140128",
"last_name": "Hasan",
"first_name": "Rakibul",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/pmrjon_image-jpg"
},
"updated_by": {
"username": "+8801305231418",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/dmoqfu_image-jpg",
"first_name": "Buyer",
"last_name": "Hasan",
"email": "codermrhasan@gmail.com"
}
}
}
```
## 15 Business User
### 15.1 List
```json
GET /api/v1/business/admin/user/?business=<business uid> HTTP/1.1
Authorization: jwt <token>
Request:
Response:
{
"success": true,
"meta_data": {
"count": 1,
"page_size": 10,
"next": null,
"previous": null
},
"data": [
{
"uid": "cf694d82-be1b-4153-9f82-9fbbcc243b2e",
"user": {
"username": "+8801303140128",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/rfsoog_image-jpg",
"first_name": "Tester",
"last_name": "Hasan",
"email": "mrhasantests@gmail.com"
},
"business": {
"uid": "41e6e3cf-4126-4715-85e1-bcaf065cf415",
"name": "Asif Ahmed",
"address": "56/c,c block ,jamtola,main road,aftabnagar",
"images": [
"https://s3-us-west-1.amazonaws.com/development-restspace/core/mqhhlb_4aa8bcc4e516cde163218cccf02ac703-naruto-madara-anime-naruto-jpg",
"https://s3-us-west-1.amazonaws.com/development-restspace/core/ccabdr_4aa8bcc4e516cde163218cccf02ac703-naruto-madara-anime-naruto-jpg"
],
"phone": "01789339847",
"fax": null,
"email": "aumi.asif@gmail.com",
"status": "active"
},
"relation_status": "admin",
"status": "active"
}
]
}
```
### 15.1 UPDATE
```json
PATCH /api/v1/business/admin/user/< business_user uid >/ HTTP/1.1
Authorization: jwt <token>
Request:
{
"phone": "+8801303140128",
"business": "41e6e3cf-4126-4715-85e1-bcaf065cf415"
}
Response:
{
"success": true,
"message": "Status OK",
"data": {
"updated_by": {
"username": "+8801305231418",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/dmoqfu_image-jpg",
"first_name": "Buyer",
"last_name": "Hasan",
"email": "codermrhasan@gmail.com"
},
"status": "active"
}
}
```
## 16 Business Balance
### 16.1 Details
```json
GET /api/v1/business/admin/balance/?<business=business_uid> HTTP/1.1
Authorization: jwt <token>
Request:
Response:
{
"success": true,
"message": "Status OK",
"data": {
"available": {
"amount": 0,
"currency": "usd"
},
"instant_available": {
"amount": 0,
"currency": "usd"
},
"pending": {
"amount": 0,
"currency": "usd"
}
}
}
```
## 17 Space
### 17.1 Create
```json
GET /api/v1/spaces/admin/space/ HTTP/1.1
Authorization: jwt <token>
Request:
{
"business": "41e6e3cf-4126-4715-85e1-bcaf065cf415",
"name": "hasan testing 13th may 2023",
"space_type": 1,
"amenities": [1,2],
"highlights": [3,4],
"lat": 23.837649578549726,
"lon": 90.36988193880231,
"guest_capacity": 3,
"slot_price": 5,
"description": "Test descriptions",
"images": [
"http://dev-s.s3.aws.com/lkajldkf",
"http://dev-s.s3.aws.com/lkajldkf/"
],
"address": {
"address_line": "House 30, Near Panir Tank",
"street": "test street",
"city": "Dhaka",
"state": "Dhaka",
"zip_code": "300",
"country": "BD"
}
}
Response:
{
"success": true,
"message": "Created",
"data": {
"id": 36,
"created_at": "2023-05-13T12:21:42.366858Z",
"updated_at": "2023-05-13T12:21:42.366888Z",
"created_by": {
"username": "+8801305231418",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/dmoqfu_image-jpg",
"first_name": "Buyer",
"last_name": "Hasan",
"email": "codermrhasan@gmail.com"
},
"updated_by": {},
"uid": "ab98951c-7743-4ec1-a8d7-56d047c018d2",
"name": "hasan testing 13th may 2023",
"location": "SRID=4326;POINT (23.837649578549726 90.36988193880231)",
"lon": 90.36988193880231,
"lat": 23.837649578549726,
"city": null,
"guest_capacity": 3,
"slot_price": 5.0,
"available_for": 0,
"available_for_unit": "minute",
"description": "Test descriptions",
"available_from": null,
"available_to": null,
"is_available": false,
"is_real": true,
"space_status": "draft",
"images": [
"http://dev-s.s3.aws.com/lkajldkf",
"http://dev-s.s3.aws.com/lkajldkf/"
],
"status": "active",
"business": 1,
"space_type": 1
}
}
```
### 17.2 List
```json
GET /api/v1/spaces/admin/space/?business=<business uid> HTTP/1.1
Authorization: jwt <token>
Request:
Response:
{
"success": true,
"meta_data": {
"count": 36,
"page_size": 10,
"next": 2,
"previous": null
},
"data": [
{
"uid": "ab98951c-7743-4ec1-a8d7-56d047c018d2",
"name": "hasan testing 13th may 2023",
"is_real": true,
"images": [
"http://dev-s.s3.aws.com/lkajldkf",
"http://dev-s.s3.aws.com/lkajldkf/"
],
"status": "active",
"space_status": "draft",
"slot_price": 5.0,
"space_type": {
"id": 1,
"name": "Private Restroom",
"description": "Test Description lorem ipsum.",
"icon": "Test Description lorem ipsum."
},
"guest_capacity": 3,
"description": "Test descriptions",
"lat": 23.837649578549726,
"lon": 90.36988193880231,
"address": {
"street": "test street",
"address_line": "House 30, Near Panir Tank",
"city": "Dhaka",
"state": "Dhaka",
"zip_code": "300",
"country": "BD"
},
"amenities": [
{
"id": 1,
"name": "Changing Table",
"icon": "https://s3-us-west-1.amazonaws.com/development-restspace/core/hkcmxj_changingtable-png"
},
{
"id": 2,
"name": "Toilet",
"icon": "https://s3-us-west-1.amazonaws.com/development-restspace/core/qakfwq_toilet-png"
}
],
"highlights": [
{
"id": 3,
"name": "Modern"
},
{
"id": 4,
"name": "Resting Space"
}
],
"space_settings": null
},
{
"uid": "f077135c-0e10-42bf-9d7d-50f5a2d3e1d5",
"name": "manual approval space",
"is_real": true,
"images": [
"https://s3-us-west-1.amazonaws.com/development-restspace/core/eswrlo_image-jpg",
"https://s3-us-west-1.amazonaws.com/development-restspace/core/xpvmta_image-jpg"
],
"status": "active",
"space_status": "published",
"slot_price": 2.0,
"space_type": {
"id": 1,
"name": "Private Restroom",
"description": "Test Description lorem ipsum.",
"icon": "Test Description lorem ipsum."
},
"guest_capacity": 1,
"description": "Expereience a Spacious restroom with clean and comfortable k jdlaksdjflkjasdf environment",
"lat": 24.858825000000017,
"lon": 89.37361099999994,
"address": {
"street": "Shibbati Road",
"address_line": "Shibbati Road",
"city": "Bogura",
"state": "Rajshahi",
"zip_code": "5800",
"country": "Bangladesh"
},
"amenities": [
{
"id": 3,
"name": "Shower",
"icon": "https://s3-us-west-1.amazonaws.com/development-restspace/core/cgmpjx_shower-png"
},
{
"id": 2,
"name": "Toilet",
"icon": "https://s3-us-west-1.amazonaws.com/development-restspace/core/qakfwq_toilet-png"
},
{
"id": 4,
"name": "Mirror",
"icon": "https://s3-us-west-1.amazonaws.com/development-restspace/core/fupglu_mirror-png"
},
{
"id": 1,
"name": "Changing Table",
"icon": "https://s3-us-west-1.amazonaws.com/development-restspace/core/hkcmxj_changingtable-png"
}
],
"highlights": [
{
"id": 4,
"name": "Resting Space"
},
{
"id": 1,
"name": "Clean"
},
{
"id": 2,
"name": "Moody"
},
{
"id": 3,
"name": "Modern"
}
],
"space_settings": {
"find_instruction": "Jkdfjlkjlf. Lakeside l Hal’s l a ldkf",
"protected_throughout": "Text for protection system",
"available_type": "as_often",
"approval_type": "manual",
"custom_days": [],
"start_time": "00:00:00",
"end_time": "23:59:59",
"timezone": "UTC+06:00",
"far_booking_day": {
"name": "days",
"value": 7
}
}
}
]
}
```
### 17.3 Details
```json
GET /api/v1/spaces/admin/space/< space uid >/ HTTP/1.1
Authorization: jwt <token>
Request:
Response:
{
"success": true,
"message": "Status OK",
"data": {
"id": 36,
"business": {
"uid": "41e6e3cf-4126-4715-85e1-bcaf065cf415",
"name": "Asif Ahmed",
"address": "56/c,c block ,jamtola,main road,aftabnagar",
"images": [
"https://s3-us-west-1.amazonaws.com/development-restspace/core/mqhhlb_4aa8bcc4e516cde163218cccf02ac703-naruto-madara-anime-naruto-jpg",
"https://s3-us-west-1.amazonaws.com/development-restspace/core/ccabdr_4aa8bcc4e516cde163218cccf02ac703-naruto-madara-anime-naruto-jpg"
],
"phone": "01789339847",
"fax": null,
"email": "aumi.asif@gmail.com",
"status": "active"
},
"space_type": {
"id": 1,
"name": "Private Restroom",
"description": "Test Description lorem ipsum.",
"icon": "https://s3-us-west-1.amazonaws.com/development-restspace/core/wpizqh_privaterestroom-png"
},
"address": {
"street": "test street",
"address_line": "House 30, Near Panir Tank",
"city": "Dhaka",
"state": "Dhaka",
"zip_code": "300",
"country": "BD"
},
"amenities": [
{
"id": 1,
"name": "Changing Table",
"icon": "https://s3-us-west-1.amazonaws.com/development-restspace/core/hkcmxj_changingtable-png"
},
{
"id": 2,
"name": "Toilet",
"icon": "https://s3-us-west-1.amazonaws.com/development-restspace/core/qakfwq_toilet-png"
}
],
"highlights": [
{
"id": 3,
"name": "Modern"
},
{
"id": 4,
"name": "Resting Space"
}
],
"created_at": "2023-05-13T12:21:42.366858Z",
"updated_at": "2023-05-13T12:31:09.906737Z",
"created_by": {
"email": "codermrhasan@gmail.com",
"username": "+8801305231418",
"last_name": "Hasan",
"first_name": "Buyer",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/dmoqfu_image-jpg"
},
"updated_by": {
"email": "codermrhasan@gmail.com",
"username": "+8801305231418",
"last_name": "Hasan",
"first_name": "Buyer",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/dmoqfu_image-jpg"
},
"uid": "ab98951c-7743-4ec1-a8d7-56d047c018d2",
"name": "hasan testing 12th may 2023",
"location": "SRID=4326;POINT (23.837649578549726 90.36988193880231)",
"lon": 90.36988193880231,
"lat": 23.837649578549726,
"city": null,
"guest_capacity": 3,
"slot_price": 5.0,
"available_for": 0,
"available_for_unit": "minute",
"description": "Test descriptions",
"is_real": true,
"space_status": "draft",
"images": [
"http://dev-s.s3.aws.com/lkajldkf",
"http://dev-s.s3.aws.com/lkajldkf/"
],
"status": "active"
}
}
```
### 17.4 Update
```json
GET /api/v1/spaces/admin/space/< space uid >/ HTTP/1.1
Authorization: jwt <token>
Request:
{
"name": "Test name 2",
"space_type": 1,
"amenities": [2],
"highlights": [1,2],
"lat": 23.837649578549726,
"lon": 90.36988193880231,
"guest_capacity": 3,
"hourly_price": 5,
"available_for": 1,
"available_for_unit": "hour",
"description": "Test descriptions",
"images": [
"http://dev-s.s3.aws.com/lkajldkf",
"http://dev-s.s3.aws.com/lkajldkf/"
],
"address": {
"address_line": "House 30, Near Panir Tank",
"street": "test street",
"city": "Newyork",
"state": "Washington",
"zip_code": "300",
"country": "USA"
}
}
Response:
{
"success": true,
"message": "Space Updated"
}
```
## 18. Space Settings
### 18.1 Create
```json
GET /api/v1/spaces/host/space-settings/ HTTP/1.1
Authorization: jwt <token>
Request:
{
"space": "5672a212-02ca-4d6e-878c-4a10520f30b3",
"find_instruction": "Text instructions for getting the space location",
"approval_type": "auto", # manual, auto
"protected_throughout": "Text for protection system",
"available_type": "custom", #weekdays, weekends, as_often, custom
"custom_days": ["7", "1"], ## 1 - Monday, 7-Sunday
"start_time": "00:00:00",
"end_time": "23:59:00",
"far_booking_day": 1,
"time_slot": 1
}
Response:
{
"success": true,
"message": "Created",
"data": {
"id": 32,
"created_at": "2023-05-13T12:43:30.863253Z",
"updated_at": "2023-05-13T12:43:30.863281Z",
"created_by": {
"username": "+8801305231418",
"profile_pic_url": "https://s3-us-west-1.amazonaws.com/development-restspace/auth/dmoqfu_image-jpg",
"first_name": "Buyer",
"last_name": "Hasan",
"email": "codermrhasan@gmail.com"
},
"updated_by": {},
"uid": "fbca4f95-35eb-42e2-86b5-3939f799941e",
"find_instruction": "Text instructions for getting the space location",
"approval_type": "auto",
"protected_throughout": "Text for protection system",
"available_type": "custom",
"custom_days": [
"7",
"1"
],
"start_time": "00:00:00",
"end_time": "23:59:00",
"timezone": null,
"status": "active",
"space": 36,
"far_booking_day": 1,
"time_slot": 1
}
}
```
### 18.2 Details
```json
GET /api/v1/spaces/host/space-settings/< space uid >/ HTTP/1.1
Authorization: jwt <token>
Request:
Response:
{
"success": true,
"message": "Status OK",
"data": {
"find_instruction": "Text instructions for getting the space location",
"approval_type": "auto",
"protected_throughout": "Text for protection system",
"available_type": "custom",
"custom_days": [
"7",
"1"
],
"start_time": "00:00:00",
"end_time": "23:59:00",
"far_booking_day": {
"id": 1,
"name": "day",
"value": 1
},
"time_slot": {
"id": 1,
"duration": 15,
"unit": "minutes",
"status": "active"
},
"status": "active"
}
}
```
### 18.3 Update
```json
PATCH /api/v1/spaces/host/space-settings/< space uid >/ HTTP/1.1
Authorization: jwt <token>
Request:
{
ANY FIELD
}
Response:
{
"success": true,
"message": "Status OK",
"data": {
"find_instruction": "Text instructions for getting the space location",
"approval_type": "auto",
"protected_throughout": "Text for protection system",
"available_type": "custom",
"custom_days": [
"7",
"1"
],
"start_time": "00:00:00",
"end_time": "23:59:00",
"far_booking_day": {
"id": 1,
"name": "day",
"value": 1
},
"time_slot": {
"id": 1,
"duration": 15,
"unit": "minutes",
"status": "active"
},
"status": "active"
}
}
```
## More APIs >> [Sys Admin 2](https://hackmd.io/@FYVuTzsyQT6DjJa6hWO5_w/BkdHvNaV2)
Sign in with Wallet
Connect another wallet