Appliances

Retreive all appliances

Retreive all appliances for a company

get

/appliances

Query parameters

per_pageinteger

limit of records per page

Example: 10

pageinteger

page number

Example: 2

sort_bystring

This parameter is used to sort the records by a specific field (nickname,type,brand_name,model_number,upc,purchased_at,created_at)

Example: type

sort_dirstring

Order type(asc or desc)

Example: asc

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://app.greenplaces.com/api/appliances'

200

400

403

404

500

200

{
  "status": "Ok",
  "message": "Success",
  "data": [
    {
      "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
      "nickname": "MinnieAir",
      "type": "Air Purifie",
      "brand_name": "Mr. Rolando Hayes DDS",
      "model_number": "244727394",
      "upc": "39962491427322",
      "purchased_at": "2022-03-21",
      "manufacturer_label": "{}",
      "quantity": "1",
      "leakage": "999999.99",
      "updated_at": "2023-06-12T17:30:21.000000Z",
      "created_at": "2023-06-12T17:30:21.000000Z",
      "locations": "['9956f948-b7gd-4b47-8181-a53fa4403567']"
    }
  ],
  "meta": {
    "pagination": {
      "current": "1",
      "last_page": "1",
      "per_page": "10",
      "total": "6"
    }
  }
}

Successful operation

Store an appliance

Store an appliance for a company

post

/appliances

Body

nicknameany

Nickname for the Appliance

Example: Office A/C

typeanyrequired

Type for the Appliance

Example: Air Purifier

brand_nameanyrequired

Brand name of the Appliance

Example: Frigidaire

model_numberanyrequired

Model number for the Appliance

Example: 2726522415

upcany

UPC for the Appliance

Example: 194301242821346

room_numberany

Room number for the Appliance

Example: 1

purchased_atany

Purchased at for the Appliance

Example: 2020-01-12

quantityany

Quantity for the Appliance

Example: 1

leakageany

Leakage for the Appliance

Example: 1

locationsany[][]

Example: ['9956f948-b7gd-4b47-8181-a53fa4403567']

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://app.greenplaces.com/api/appliances' \
  --header 'Content-Type: application/json' \
  --data '{
    "nickname": "Office A/C",
    "type": "Air Purifier",
    "brand_name": "Frigidaire",
    "model_number": "2726522415",
    "upc": "194301242821346",
    "room_number": "1",
    "purchased_at": "2020-01-12",
    "quantity": "1",
    "leakage": "1",
    "locations": "['9956f948-b7gd-4b47-8181-a53fa4403567']"
  }'

200

400

403

404

500

200

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "nickname": "MinnieAir",
    "type": "Air Purifie",
    "brand_name": "Mr. Rolando Hayes DDS",
    "model_number": "244727394",
    "upc": "39962491427322",
    "purchased_at": "2022-03-21",
    "manufacturer_label": "{}",
    "quantity": "1",
    "leakage": "999999.99",
    "updated_at": "2023-06-12T17:30:21.000000Z",
    "created_at": "2023-06-12T17:30:21.000000Z",
    "locations": "['9956f948-b7gd-4b47-8181-a53fa4403567']"
  },
  "meta": {}
}

Successful operation

Retrieve an appliance

Retrieve an appliance for a company

get

/appliances/{id}

Path parameters

appliancestringrequired

ID of the Appliance

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'http://app.greenplaces.com/api/appliances/{id}'

200

400

403

404

500

200

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "nickname": "MinnieAir",
    "type": "Air Purifie",
    "brand_name": "Mr. Rolando Hayes DDS",
    "model_number": "244727394",
    "upc": "39962491427322",
    "purchased_at": "2022-03-21",
    "manufacturer_label": "{}",
    "quantity": "1",
    "leakage": "999999.99",
    "updated_at": "2023-06-12T17:30:21.000000Z",
    "created_at": "2023-06-12T17:30:21.000000Z",
    "locations": "['9956f948-b7gd-4b47-8181-a53fa4403567']"
  },
  "meta": {}
}

Successful operation

Update an appliance

Update an appliance for a company

put

/appliances/{id}

Path parameters

idstringrequired

ID of the Appliance

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Body

nicknameany

Nickname for the Appliance

Example: Office A/C

typeanyrequired

Type for the Appliance

Example: Air Purifier

brand_nameanyrequired

Brand name of the Appliance

Example: Frigidaire

model_numberanyrequired

Model number for the Appliance

Example: 2726522415

upcany

UPC for the Appliance

Example: 194301242821346

room_numberany

Room number for the Appliance

Example: 1

purchased_atany

Purchased at for the Appliance

Example: 2020-01-12

locationsany

IDs of Locations for the Appliance

Example: ['9956f948-b7gd-4b47-8181-a53fa4403567']

quantityany

Quantity for the Appliance

Example: 1

leakageany

Leakage for the Appliance

Example: 1

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'http://app.greenplaces.com/api/appliances/{id}' \
  --header 'Content-Type: application/json' \
  --data '{
    "nickname": "Office A/C",
    "type": "Air Purifier",
    "brand_name": "Frigidaire",
    "model_number": "2726522415",
    "upc": "194301242821346",
    "room_number": "1",
    "purchased_at": "2020-01-12",
    "locations": "['9956f948-b7gd-4b47-8181-a53fa4403567']",
    "quantity": "1",
    "leakage": "1"
  }'

200

400

403

404

500

200

{
  "status": "Ok",
  "message": "Success",
  "data": {
    "id": "996501df-0bfc-4f95-954d-3a5d5dc48469",
    "nickname": "MinnieAir",
    "type": "Air Purifie",
    "brand_name": "Mr. Rolando Hayes DDS",
    "model_number": "244727394",
    "upc": "39962491427322",
    "purchased_at": "2022-03-21",
    "manufacturer_label": "{}",
    "quantity": "1",
    "leakage": "999999.99",
    "updated_at": "2023-06-12T17:30:21.000000Z",
    "created_at": "2023-06-12T17:30:21.000000Z",
    "locations": "['9956f948-b7gd-4b47-8181-a53fa4403567']"
  },
  "meta": {}
}

Successful operation

Delete an appliance

Delete an appliance for a company

delete

/appliances/{id}

Path parameters

idstringrequired

ID of the Appliance

Example: 996501df-0bfc-4f95-954d-3a5d5dc48469

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'http://app.greenplaces.com/api/appliances/{id}'

200

400

403

404

500

200

{
  "status": "Ok",
  "message": "Success",
  "data": null,
  "meta": {}
}

Successful operation