Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration TransferMethodType

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

Index

Enumeration Members

Enumeration Members

Delete

Delete: "DELETE"

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

Feature Description
HTTP Method Like POST/PUT
Idempotent ❌

Example Payload

From ./dist/samples/json/requests/transferDeleteRequest.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "DELETE",
    "payload": {}
}

Error

Error: "ERROR"

A response sent to communicate errors.

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

Example Payload

From ./dist/samples/json/requests/transferErrorRequest.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "ERROR",
    "payload": {}
}

Get

Get: "GET"

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

Feature Description
HTTP Method Like GET
Idempotent ✅

Example Payload

From ./dist/samples/json/requests/transferGetRequest.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "GET",
    "payload": {}
}

Set

Set: "SET"

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

Feature Description
HTTP Method Like POST/PUT
Idempotent ❌

Example Payload

From ./dist/samples/json/requests/transferSetRequest.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "SET",
    "payload": {}
}

Update

Update: "UPDATE"

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

Feature Description
HTTP Method Like POST/PUT
Idempotent ❌

Example Payload

From ./dist/samples/json/requests/transferUpdateRequest.json

{
    "$schema": "https://docs.api.deeptrekker.com/dist/schemas/schema.json",
    "apiVersion": "0.58.9",
    "method": "UPDATE",
    "payload": {}
}