Enumeration TransferMethodType

The different kinds of payload requests that can be sent and received.

Index

Enumeration Members

Delete Error Get Set Update

Enumeration Members

Delete

Delete: "DELETE"

Remarks

A request by the device server to remove data on the client.

Feature	Description
HTTP Method	Like POST/PUT
Idempotent	❌

Example

{
  "apiVersion": "1.0.0",
  "method": "DELETE",
  "payload": {
    "devices": {
      "001A2B3C4D5E": {} //Delete the reference to this device with this mac address.
    }
  }
}

Error

Error: "ERROR"

Remarks

A response sent to communicate errors.

Feature	Description
HTTP Response	Like 4xx, 5xx errors. See ErrorCodes.
Idempotent	✅

Example

{
  "apiVersion": "1.0.0",
  "method": "ERROR",
  "error": {
     "code": 400,
     "message": "Invalid data or payload is malformed."
    },
  "payload": {}
  }
}

Get

Get: "GET"

Remarks

Used to request a payload response to be sent by the receiving end.

Feature	Description
HTTP Method	Like GET
Idempotent	✅

Example

{
  "apiVersion": "1.0.0",
  "method": "GET",
  "payload": {}
}

Set

Set: "SET"

Remarks

A request by a client to set data on the device server.

Feature	Description
HTTP Method	Like POST/PUT
Idempotent	❌

Example

Update

Update: "UPDATE"

Remarks

A request by the device server to update data on the client.

Feature	Description
HTTP Method	Like POST/PUT
Idempotent	❌

Example

{
  "apiVersion": "1.0.0",
  "method": "UPDATE",
  "payload": {
    "devices": {
      "001A2B3C4D5E": {
         "model": 13,
         "auxLight": {
           "intensity": 100
         }
       }
    }
  }
}

Enumeration TransferMethodType

Index

Enumeration Members

Enumeration Members

Delete

Remarks

Example

Error

Remarks

Example

Get

Remarks

Example

Set

Remarks

Example

Update

Remarks

Example

Settings

On This Page