GET api/v1/videoConfig/{MAC}/firmware

The GetFirmwareList() method is used to request the list of available firmware revisions for the given camera.

Request Information

URI Parameters

Name	Description	Type	Additional information
MAC	MAC Address (unique identifier) for the camera in question.	string	Required

Body Parameters

None.

Response Information

Resource Description

CameraFirmwareListReuslt Object: ResultCode: Numerical indication of success/failure. 0=Success, Failure otherwise ResultData: Textual information, additional to the ResultCode as necessary. FirmwareList: CameraFirmwareList object: FirmwareCount: Number of items in the list CameraFirmwares: Array of CameraFirmwareInfo objects: FirmwareVersion: String representation of the firmware version FirmwareVersionNumber: Numerical representation FirmwareVersionDescription: Verbose description of the version FirmwareVersionState: Descriptive state of the version (Current, beta, etc) FirmwareReleaseDate: MM/DD/YYYY format

CameraFirmwareListResult

Name	Type	Additional information
FirmwareList	CameraFirmwareList	None.
ResultCode	integer	None.
ResultData	string	None.

Response Formats

application/json, text/json

Sample:

{
  "FirmwareList": {
    "FirmwareCount": 1,
    "CameraFirmwares": [
      {
        "FirmwareVersion": "sample string 1",
        "FirmwareVersionNumber": 2,
        "FirmwareVersionDescription": "sample string 3",
        "FirmwareVersionState": "sample string 4",
        "FirmwareReleaseDate": "sample string 5"
      },
      {
        "FirmwareVersion": "sample string 1",
        "FirmwareVersionNumber": 2,
        "FirmwareVersionDescription": "sample string 3",
        "FirmwareVersionState": "sample string 4",
        "FirmwareReleaseDate": "sample string 5"
      }
    ]
  },
  "ResultCode": 1,
  "ResultData": "sample string 2"
}

application/xml, text/xml

Sample:

<CameraFirmwareListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TC2API.Resource.Models.ResultData">
  <ResultCode xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">1</ResultCode>
  <ResultData xmlns="http://schemas.datacontract.org/2004/07/TC2Utilities.RestApi">sample string 2</ResultData>
  <FirmwareList xmlns:d2p1="http://schemas.datacontract.org/2004/07/TC2Domain.IPVideo">
    <d2p1:CameraFirmwares>
      <d2p1:CameraFirmwareInfo>
        <d2p1:FirmwareReleaseDate>sample string 5</d2p1:FirmwareReleaseDate>
        <d2p1:FirmwareVersion>sample string 1</d2p1:FirmwareVersion>
        <d2p1:FirmwareVersionDescription>sample string 3</d2p1:FirmwareVersionDescription>
        <d2p1:FirmwareVersionNumber>2</d2p1:FirmwareVersionNumber>
        <d2p1:FirmwareVersionState>sample string 4</d2p1:FirmwareVersionState>
      </d2p1:CameraFirmwareInfo>
      <d2p1:CameraFirmwareInfo>
        <d2p1:FirmwareReleaseDate>sample string 5</d2p1:FirmwareReleaseDate>
        <d2p1:FirmwareVersion>sample string 1</d2p1:FirmwareVersion>
        <d2p1:FirmwareVersionDescription>sample string 3</d2p1:FirmwareVersionDescription>
        <d2p1:FirmwareVersionNumber>2</d2p1:FirmwareVersionNumber>
        <d2p1:FirmwareVersionState>sample string 4</d2p1:FirmwareVersionState>
      </d2p1:CameraFirmwareInfo>
    </d2p1:CameraFirmwares>
    <d2p1:FirmwareCount>1</d2p1:FirmwareCount>
  </FirmwareList>
</CameraFirmwareListResult>