Spector Vision
  • Home
  • Getting started
    • Install
    • Device pairing
  • Features
    • 🔬NDT
      • Measurement mesh
      • Measurement display
    • 🗜️Laminate repair tool
    • 📐Space aware positioning
      • Origin manipulation
    • 📹Video capture
    • 🪄Detection
      • Streaming
    • Advanced use
      • Changing API Environment in Spector
  • UI elements
    • 🎛️Defect panel
    • 📍Origin handler
  • API
    • Overview
    • Startup [Admin API]
    • Device [Content API]
      • Main
      • Marker manipulations
    • Documents [Content API]
      • View documents
    • LRT [Detection API]
    • Defect dimensions [Detection API]
    • Space settings
      • Endpoints
  • Releases
    • 1.2
    • 1.1
    • 1.0
    • Pilot 1.8
      • 🥽Fixes
      • 🥽Alignment marker along z-axis
      • 🥽Nodes rotation
    • Pilot 1.7
      • 🥽Status bar and header
      • 🥽Defect description
      • 🥽Defect codes relations
      • 🥽Disposition: select number of plies
      • 🥽Disposition: all plies table
      • 📡Disposition API: get all plies
      • 📡Disposition API: get selected plies
      • 🥽Disposition: selected plies table
      • 🥽Disposition: display layup image
      • 📡Disposition API: Get image layup
      • 📡Disposition API: Update LRT data
      • 🥽Handler (Scene Origin) Rotation
      • 🖥️Portal laminate repair tool
      • 📡Detection API: Defect dimensions
    • Pilot 1.6
    • Pilot 1.5
    • Pilot 1.4
    • Pilot 1.3
    • Pilot 1.1-2
    • 🔵Pilot 1.0
    • Pilot 0.3
    • Pilot 0.2
    • Pilot 0.1
    • 🟢Demo 1.0
    • Demo 0.3
    • Demo 0.2
    • Demo 0.1
  • Identity
    • Spector logo
Powered by GitBook
On this page

Was this helpful?

  1. API
  2. Device [Content API]

Main

Last updated 9 months ago

Was this helpful?

Device login

Get device space

Create marker

Delete marker

get
Authorizations
Path parameters
spaceIndexstringRequired
Responses
get
GET /api/spaces/{spaceIndex} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
200Success
{
  "name": "text",
  "spaceIndex": "text",
  "isPublic": true,
  "deviceSN": {},
  "originLocation": {
    "x": 1,
    "y": 1,
    "z": 1
  },
  "originRotation": {
    "x": 1,
    "y": 1,
    "z": 1
  },
  "floorLocation": {
    "x": 1,
    "y": 1,
    "z": 1
  },
  "pin": "text",
  "media": [
    "text"
  ],
  "markers": [
    "text"
  ],
  "modelUrl": "text",
  "canUpload": true,
  "routine": {},
  "cameraPosition": {
    "location": {
      "x": 1,
      "y": 1,
      "z": 1
    },
    "rotation": {
      "x": 1,
      "y": 1,
      "z": 1,
      "w": 1
    }
  },
  "defaultRoutineIndex": "text",
  "lrtUrl": "text"
}
delete
Authorizations
Path parameters
markerIndexstringRequired
Responses
delete
DELETE /api/markers/{markerIndex} HTTP/1.1
Host: 
Authorization: Bearer JWT
Accept: */*
202Success
No content
  • Device login
  • POST/api/auth/device/login
  • Get device space
  • GET/api/spaces/{spaceIndex}
  • Create marker
  • POST/api/markers
  • Delete marker
  • DELETE/api/markers/{markerIndex}
post
Body
deviceIdstringRequired
Responses
post
POST /api/auth/device/login HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "deviceId": "text"
}
200Success
No content
post
Authorizations
Body
markerIndexstringRequired
spaceIndexstringRequired
routineIndexstringRequired
nodesstring[]Required
recordsstring[]Required
Responses
post
POST /api/markers HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 313

{
  "markerIndex": "text",
  "location": {
    "x": 1,
    "y": 1,
    "z": 1
  },
  "scale": {
    "x": 1,
    "y": 1,
    "z": 1
  },
  "demensions": {
    "x": 1,
    "y": 1,
    "z": 1
  },
  "color": {
    "r": 1,
    "g": 1,
    "b": 1,
    "a": 1
  },
  "spaceIndex": "text",
  "routineIndex": "text",
  "nodes": [
    "text"
  ],
  "records": [
    "text"
  ],
  "cameraPosition": {
    "location": {
      "x": 1,
      "y": 1,
      "z": 1
    },
    "rotation": {
      "x": 1,
      "y": 1,
      "z": 1,
      "w": 1
    }
  }
}
201Success
{
  "markerIndex": "text",
  "location": {
    "x": 1,
    "y": 1,
    "z": 1
  },
  "rotation": {
    "x": 1,
    "y": 1,
    "z": 1,
    "w": 1
  },
  "scale": {
    "x": 1,
    "y": 1,
    "z": 1
  },
  "demensions": {
    "x": 1,
    "y": 1,
    "z": 1
  },
  "color": {
    "r": 1,
    "g": 1,
    "b": 1,
    "a": 1
  },
  "records": [
    "text"
  ],
  "nodes": [
    "text"
  ],
  "defectDimensions": {}
}