TransferMethodType | Deep Trekker BRIDGE API

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

Index

Delete: "DELETE"

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

Feature	Description
HTTP Method	Like POST/PUT
Idempotent	❌

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

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

Error: "ERROR"

A response sent to communicate errors.

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

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

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

Get: "GET"

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

Feature	Description
HTTP Method	Like GET
Idempotent	✅

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

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

Set: "SET"

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

Feature	Description
HTTP Method	Like POST/PUT
Idempotent	❌

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

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

Update: "UPDATE"

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

Feature	Description
HTTP Method	Like POST/PUT
Idempotent	❌

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

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