Tarsheed

Create New Device

Developing

POST

device/create

DeviceUser

Cretae new Device for spesfic user in spesfic room

Request

Header Params

Authorization

string

required

Example:

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3OWU4M2Y0OGUxMThjNDA3OWIyNTFjMyIsImVtYWlsIjoiYWxpaXNtYWlsaDA4QGdtYWlsLmNvbSIsInJvbGUiOiJjdXN0b21lciIsImlhdCI6MTc0MTI0MjUwMiwiZXhwIjoxNzQzODM0NTAyfQ.ABNTRtJ6iJn1AJpPKcUrr1SOW2aYXRjRkn0Vv1YURoI

Body Params application/json

name

string

required

device name

description

string

optional

Device description and it optional

pinNumber

string

required

pin number for device in IOT System

roomId

string

required

room id that user need to create this device in

categoryId

string

required

category for device it is id that you select it from the categories

sensorId

string

required

priority

number

required

user must select number from three 1 or 2 or 3

Example

{
    "name": "string",
    "description": "string",
    "pinNumber": "string",
    "roomId": "string",
    "categoryId": "string",
    "sensorId": "string",
    "priority": 0
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'device/create' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY3OWU4M2Y0OGUxMThjNDA3OWIyNTFjMyIsImVtYWlsIjoiYWxpaXNtYWlsaDA4QGdtYWlsLmNvbSIsInJvbGUiOiJjdXN0b21lciIsImlhdCI6MTc0MTI0MjUwMiwiZXhwIjoxNzQzODM0NTAyfQ.ABNTRtJ6iJn1AJpPKcUrr1SOW2aYXRjRkn0Vv1YURoI' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string",
    "description": "string",
    "pinNumber": "string",
    "roomId": "string",
    "categoryId": "string",
    "sensorId": "string",
    "priority": 0
}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{
    "message": "Device Created Successfully",
    "deviceSaved": {
        "name": "TV",
        "description": "main TV in the house",
        "categoryId": "67cd8ab3eff1c5c8a7793c51",
        "status": "OFF",
        "pinNumber": 2,
        "roomId": "67d7ade73adb097a01018dd0",
        "_id": "67d8ef36ae78368e1f172220",
        "createdAt": "2025-03-18T03:57:42.384Z",
        "updatedAt": "2025-03-18T03:57:42.384Z",
        "__v": 0
    }
}

Get all Rooms for spesfic user

Update Device