Skip to main content

Resolve how ingest routes device serials

MethodPath
POST/v1/slim/device/routing

Authentication · Access policies

For each serial you send, returns the manufacturer and model that ingest files it under, and whether ingest accepts the serial at all. Use it to check serials before you create devices or send data.

Auth: bearer token. The caller must be a practitioner, an admin or a System Owner, and needs Device:read.

Behaviour​

  • Send 1 to 500 serials, each at most 64 characters.
  • Rows come back in the order you sent them.
  • routable: false means ingest rejects the serial with 400. manufacturer and model are then null.
  • The serial alone decides the result. A manufacturer that ingest only accepts when named explicitly, such as Masimo, is never inferred from a serial.
  • Nothing is read or written. The result is computed from the serial only.

Example​

curl -X POST 'https://api.sandbox.ovok.com/v1/slim/device/routing' \
-H "Authorization: Bearer ${OVOK_TOKEN}" \
-H 'Content-Type: application/json' \
-d '{"serials": ["3001000", "12,34"]}'
FieldTypeMeaning
resourcesarrayOne result for each submitted serial, in the same order.
resources[].serialstringSubmitted serial.
resources[].manufacturerstring or nullManufacturer inferred for ingest routing.
resources[].modelstring or nullModel inferred for ingest routing.
resources[].routablebooleanWhether ingest accepts the serial.

Successful response​

200 — Manufacturer, model and routability per serial.

Errors​

StatusMeaning
401Bearer token is missing, invalid or expired.
403You are not a practitioner, admin or System Owner, you lack Device:read, or your session has no project.
422The body fails validation.