Appliances

Retreive all appliances

get

Retreive all appliances for a company

Authorizations
Query parameters
per_pageintegerOptional

limit of records per page

Example: 10
pageintegerOptional

page number

Example: 2
sort_bystringOptional

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_dirstringOptional

Order type(asc or desc)

Example: asc
Responses
200

Successful operation

application/json
get
/appliances

Store an appliance

post

Store an appliance for a company

Authorizations
Body

Creates appliances request body data

nicknameanyOptional

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
upcanyOptional

UPC for the Appliance

Example: 194301242821346
room_numberanyOptional

Room number for the Appliance

Example: 1
purchased_atanyOptional

Purchased at for the Appliance

Example: 2020-01-12
quantityanyOptional

Quantity for the Appliance

Example: 1
leakageanyOptional

Leakage for the Appliance

Example: 1
Responses
200

Successful operation

application/json
post
/appliances

Retrieve an appliance

get

Retrieve an appliance for a company

Authorizations
Path parameters
appliancestringRequired

ID of the Appliance

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

Successful operation

application/json
get
/appliances/{id}

Update an appliance

put

Update an appliance for a company

Authorizations
Path parameters
idstringRequired

ID of the Appliance

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

Update appliance request body data

nicknameanyOptional

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
upcanyOptional

UPC for the Appliance

Example: 194301242821346
room_numberanyOptional

Room number for the Appliance

Example: 1
purchased_atanyOptional

Purchased at for the Appliance

Example: 2020-01-12
locationsanyOptional

IDs of Locations for the Appliance

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

Quantity for the Appliance

Example: 1
leakageanyOptional

Leakage for the Appliance

Example: 1
Responses
200

Successful operation

application/json
put
/appliances/{id}

Delete an appliance

delete

Delete an appliance for a company

Authorizations
Path parameters
idstringRequired

ID of the Appliance

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

Successful operation

application/json
delete
/appliances/{id}