openapi: 3.0.0
info:
  title: VisibilityIQ Smart Battery Health
  version: 1.4.0
servers:
- url: https://api.zebra.com/v2/data/devices/batteries/analytics/visibility
  description: For US
- url: https://api.zebra.com/v2/eu/data/devices/batteries/analytics/visibility
  description: For EU
security:
- BearerAuth: []
- ApiKeyAuth: []
paths:
  /smart-battery-health:
    get:
      tags:
      - Smart Battery Health
      summary: Retrieves battery health information
      description: Retrieves battery health information for a company partner for
        today.
      operationId: Retrieve Smart Battery Health
      parameters:
      - name: companyName
        in: header
        description: Company name
        required: true
        schema:
          type: string
      - name: partnerName
        in: header
        description: Partner name
        required: true
        schema:
          type: string
      - name: offset
        in: query
        description: 'Pagination parameter indicating the starting record position
          for returning the results from the result set.  Any positive value is acceptable.
          An offset bigger than the number of available results will result in an
          error. A negative value will be replaced with 0. Normally, value should
          be 0 or a positive multiple of limit. '
        required: false
        schema:
          type: integer
          default: 0
      - name: limit
        in: query
        description: 'Pagination size indicating the maximum number of results to
          be returned in the response. Valid values are 1 to 20000. Values higher
          than 20000 will be replaced with 20000. Values less than 1 will be replaced
          with 250. '
        required: false
        schema:
          type: integer
          default: 250
      - name: sort
        in: header
        description: "Sort order for the results. Specified as a JSON object. Currently,\
          \ only one sort order is supported in the criteria even though it is an\
          \ array. Elements other than the first one will be ignored currently.\n\
          \  {\n    \"criteria\": [\n      {\n        \"a\": \"batterySerialNum\"\
          ,\n        \"o\": \"asc\"\n      }\n    ]\n  } "
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatteryInventorySortCriteria'
      - name: filter
        in: header
        description: |-
          Filter based on column values. Numeric value will be filtered by an exact match and also by using relational operators such as <,>,==,<=,>= . Strings will be filtered by partial matches and exact matches by using == relational operator and are case insensitive matches. Filter opeartor and filter values are sepearted by "|".  The filter criteria are ANDed together. Example
          {
            "batterySerialNum": "==|A5XXX1",
            "batteryPartNum": "82-XXXXXX7-01 Rev. C",
            "rul": ">|10"
            "chargeCycleCount": "<=|100"
          }
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatteryInventoryFilterCriteria'
      responses:
        "200":
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse'
        "400":
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "401":
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "403":
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        "500":
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
      deprecated: false
components:
  schemas:
    DateTime:
      type: string
      format: date-time
    Date:
      type: string
      format: date
    ApiResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ApiResponseStatus'
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
        data:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/BatteryInventory'
        links:
          $ref: '#/components/schemas/ApiResponseLinks'
    ApiError:
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for this particular occurrence of the problem
        links:
          type: object
          properties:
            about:
              type: string
              description: A link that leads to further details about this particular
                occurrence of the problem
          description: Links providing information related to this error
        status:
          type: integer
          description: The HTTP status code applicable to this problem
          format: int32
        code:
          type: string
          description: An application-specific error code, expressed as a string value
        title:
          type: string
          description: A short, human-readable summary of the problem that SHOULD
            NOT change from occurrence to occurrence of the problem, except for purposes
            of localization
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of
            the problem. Like title, this field’s value can be localized
        source:
          type: object
          properties:
            pointer:
              type: string
              description: A JSON Pointer [RFC6901] to the associated entity in the
                request document [e.g. "/data" for a primary data object, or "/data/attributes/title"
                for a specific attribute]
            parameter:
              type: string
              description: A string indicating which URI query parameter caused the
                error
          description: An object containing references to the source of the error
        meta:
          type: object
          description: A meta object containing non-standard meta-information about
            the error
    BatteryInventorySortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - healthPercent
                - batteryPartNum
                - model
                - lastSeenDatetime
                - rul
                - batteryType
                - batterySerialNum
                - batteryManufactureDate
                - lastSeenSiteName
                - isDecommissioned
                - healthStatus
                - reasonForStatus
                - state
                - chargeCycleCount
                - serialNum
                - status
                - deviceType
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    BatteryInventoryFilterCriteria:
      type: object
      properties:
        batteryPartNum:
          type: string
        model:
          type: string
        lastSeenDatetime:
          $ref: '#/components/schemas/DateTime'
        batteryType:
          type: string
        batterySerialNum:
          type: string
        batteryManufactureDate:
          $ref: '#/components/schemas/Date'
        lastSeenSiteName:
          type: string
        isDecommissioned:
          type: string
        healthStatus:
          type: string
        reasonForStatus:
          type: string
        state:
          type: string
        serialNum:
          type: string
        healthPercent:
          type: string
        chargeCycleCount:
          type: string
        rul:
          type: string
        deviceType:
          type: string
    BatteryInventory:
      type: object
      properties:
        healthPercent:
          type: string
        batteryPartNum:
          type: string
        model:
          type: string
        lastSeenDatetime:
          $ref: '#/components/schemas/DateTime'
        expectedDeviceSerialnum:
          type: string
        rul:
          type: string
        batteryType:
          type: string
        batterySerialNum:
          type: string
        batteryManufactureDate:
          $ref: '#/components/schemas/Date'
        lastSeenSiteName:
          type: string
        isDecommissioned:
          type: string
        healthStatus:
          type: string
        reasonForStatus:
          type: string
        state:
          type: string
        chargeCycleCount:
          type: string
        serialNum:
          type: string
        status:
          type: string
        deviceType:
          type: string
      example:
        healthPercent: 100%
        batteryPartNum: XX-XXXX-01 X.X
        model: TCXX
        lastSeenDatetime: 2020-03-24T13:14:11Z
        rul: 180 or More
        type: PP+
        batterySerialNum: T2XXXX
        batteryManufactureDate: XXXX-XX-XX
        lastSeenSiteName: 0612 XXXX XXXX XXXXXX
        isDecommissioned: "N"
        healthStatus: Normal
        reasonForStatus: REMAINING USEFUL LIFE < XX DAYS
        state: ACTIVE
        chargeCycleCount: "52"
        serialNum: "12312312312312"
        status: IN USE
        deviceType: XXXXX
    ApiResponseStatus:
      type: integer
      description: The HTTP status code
      format: int32
    ApiResponseMeta:
      type: object
      properties:
        id:
          type: string
          description: A unique identifier for this request
        total:
          type: integer
          description: The total number of results
        offset:
          type: integer
          description: The offset used in this request
        limit:
          type: integer
          description: The effective limit used in this request
    ApiResponseLinks:
      type: object
      properties:
        self:
          type: string
          description: URL to this page
        first:
          type: string
          description: URL to the first page
        last:
          type: string
          description: URL to the last page
        prev:
          type: string
          description: URL to the previous page
        next:
          type: string
          description: URL to the next page
      description: Links for navigation. Only the applicable links are required to
        be present.
  responses:
    Response200:
      description: Successful operation
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiResponse'
    Response400:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Response401:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Response403:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Response500:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  parameters:
    companyName:
      name: companyName
      in: header
      description: Company name
      required: true
      schema:
        type: string
    partnerName:
      name: partnerName
      in: header
      description: Partner name
      required: true
      schema:
        type: string
    offset:
      name: offset
      in: query
      description: 'Pagination parameter indicating the starting record position for
        returning the results from the result set.  Any positive value is acceptable.
        An offset bigger than the number of available results will result in an error.
        A negative value will be replaced with 0. Normally, value should be 0 or a
        positive multiple of limit. '
      required: false
      schema:
        type: integer
        default: 0
    limit:
      name: limit
      in: query
      description: 'Pagination size indicating the maximum number of results to be
        returned in the response. Valid values are 1 to 20000. Values higher than
        20000 will be replaced with 20000. Values less than 1 will be replaced with
        250. '
      required: false
      schema:
        type: integer
        default: 250
  requestBodies: {}
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
    ApiKeyAuth:
      type: apiKey
      name: X-APIKey
      in: header
  links: {}
  callbacks: {}
