batches

Watch Rows

Watch the contractors of some verified rows, in row order, until the plan's watch cap is reached.

Each new watch counts a verification as POST /monitoring/watches does, which is free for a license the batch already verified today.

Args: batch_id: The batch. body: The rows. key: Injected: the caller's paid key. batches: Injected BatchRepository. licenses: Injected LicenseRepository. keys: Injected ApiKeyRepository. monitoring: Injected MonitoringRepository.

Returns: How many started, were already watched or were skipped, and the watches left.

Raises: HTTPException: 409 when the plan's cap left room for none of them.

post/batches/{batch_id}/watch

Request

  • Base URL: https://api.licenscheck.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.licenscheck.com/batches/{batch_id}/watch
  • Auth: none declared

Path parameters

batch_idstring uuid required

Request body

rowsinteger[] required

The matched rows whose contractors to watch, by row number.

Response

Successful Response

startedinteger required

Watches started.

already_watchedinteger required

Rows whose contractor was already watched.

skippedinteger required

Rows that weren't matched and verified, so can't be watched.

watches_leftinteger nullable required

Watches left on the plan now; null for no cap.

Changes

No recorded changes to this operation across all 1 revision of this API.