MOmoxionpower
Fleet Fault Snapshot

AEMP Extended Fleet Faults Snapshot

Get the extended AEMP 2.0 Fleet Fault Snapshot. This endpoint extends AEMP 2.0 outside of its specification as faults are not typically included as a fleet snapshot. The API format follows that of the AEMP Snapshot. See https://developer.moxionpower.com for additional included data and example responses. Note that equipment is paged and returned in order of creation time. Snapshot timestamp is consistent within a single page but is not guaranteed across pages. Response type is JSON. This endpoint returns an array of Equipment and their associated Faults. Faults are only reported if they are currently considered ACTIVE. If a zero-length array of Faults is returned, this suggests no Faults are currently known. Faults are considered ACTIVE when the Equipment reports them as such. Like all telemetry, environmental conditions such as cellular network connectivity can affect the reporting of Fault status. The LastUpdate field indicates the last time the Equipment reported the current instance of the given Fault, which can help discern between no connectivity and long lived faults.

get/v1/api/aemp-extended/faults/fleet/{page_number}

Request

  • Base URL
    https://api-production.infra.moxionpower.com
  • URL
    https://api-production.infra.moxionpower.com/v1/api/aemp-extended/faults/fleet/{page_number}
  • Auth
    API key in header authorization

Path parameters

page_numberinteger required

Page number of Fleet Snapshot to fetch. Note that the number of available pages is determined by the requested page size.

Query parameters

page_sizeinteger

Optional. Number of Equipment records to return per request. Defaults to 100.

Response

OK

Example response

{
  "Fleet": {
    "Links": [
      {
        "rel": "self",
        "href": "/aemp-extended/faults/fleet/1"
      },
      {
        "rel": "next",
        "href": "/aemp-extended/faults/fleet/2"
      },
      {
        "rel": "last",
        "href": "/aemp-extended/faults/fleet/11"
      }
    ],
    "Equipment": [
      {
        "EquipmentHeader": {
          "datetime": "2023-05-11T18:34:30.068Z",
          "Make": "Moxion",
          "Model": "MP-75",
          "EquipmentID": "fbadf8ad-182f-47f0-9dd1-472a0094b231",
          "ExternalID": "abc1234",
          "SerialNumber": "00001"
        },
        "Faults": [
          {
            "FaultCode": "PCS_CURRENT_LIMIT",
            "datetime": "2023-07-07T07:00:00.000Z",
            "LastUpdate": "2023-07-07T07:00:30.000Z"
          }
        ]
      },
      {
        "EquipmentHeader": {
          "datetime": "2023-05-11T18:34:30.068Z",
          "Make": "Moxion",
          "Model": "MP-75",
          "EquipmentID": "865c6cbf-996a-46c0-9772-4c57f5ee019a",
          "ExternalID": "def4567",
          "SerialNumber": "00002"
        },
        "Faults": []
      }
    ],
    "version": "20190501",
    "snapshotTime": "2023-05-04T18:34:30.068Z"
  }
}

Changes

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