Theme

Agents ​

API endpoints for Agents management in LSP.

Get All LSP's agents ​

http
GET /v1/lsp/agents

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Get LSP's agent Information ​

http
GET /v1/lsp/agents/:id?verbose=1

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Update LSP's agent information ​

http
PATCH /v1/lsp/agents/:id

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Assign vehicle to LSP Agent ​

http
PUT /v1/lsp/agents/:id/vehicle/assign

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Request Body ​

typescript
interface Assign vehicle to LSP AgentRequest {
  vid: string;
  terms: string[];
  isOwner: boolean;
}

Example:

json
{
  "vid": "{{LSPVehicleId}}",
  "terms": [
    "No missing of any maintenance schedule",
    "Report fault on vehicle as soon as occured",
    "Do not try to fix vehicle without dedicated maintenance technicians"
  ],
  "isOwner": false
}

Unassign vehicle from LSP Agent ​

http
PATCH /v1/lsp/agents/:id/vehicle/unassign

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)

Remove agent from LSP ​

http
DELETE /v1/lsp/agents/:id

Headers ​

  • de-user-agent (required)
  • de-auth-token (required)
  • de-auth-device (required)