EAeagleeyenetworks
Contract Vault

GET /contracts/{id}

Retrieves a contract record by its ID.

Request

  • Base URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0
  • URL
    https://api.cxxx.eagleeyenetworks.com/api/v3.0/contracts/{id}
  • Auth
    HTTP bearer

Path parameters

idstring required

The ID of the contract record to retrieve.

Response

Successful retrieval of the contract record.

idstring required

Unique identifier for the recording.

extStockNumberstring

Stock number associated with the recording.

extContractNumberstring

Contract number associated with the recording.

extServiceEntitystring

The service entity associated with the recording.

videoAvailableboolean required

Indicates if the video is available.

noVideoReason'equipmentOrCommunicationFailure' | 'ownerRefusedConsent' | 'noRoomAvailable' | 'noQaAvailable' | 'noVloAvailable' | 'recording' | 'medical' | 'unspecified' | 'other'

Reason for not having a video.

cameraIdsstring[]

Unique identifiers for the cameras used in the recording.

layoutIdstring

Unique identifier for the layout used in the recording.

updateTimestampstring date-time

Date and time when the record was last updated.

Changes

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