openapi: 3.0.0
info:
  title: VisibilityIQ Battery Level
  version: 1.0.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:
  /level:
    get:
      tags:
      - Battery Level
      summary: Retrieves average battery level of the device.
      description: Retrieves average battery level of a device during the specified
        time range for a company partner
      operationId: Retrieve Battery Level
      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: startDatetime
        in: header
        description: ISO timestamp for the start of the time period in which data
          is retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
        required: true
        schema:
          $ref: '#/components/schemas/DateTime'
      - name: endDatetime
        in: header
        description: ISO timestamp for the end of the time period in which  data is
          fetched. The endDatetime should be no more than 18 months from the startDatetime.
          Example=2020-04-13T00:00:00Z
        required: true
        style: simple
        explode: false
        schema:
          $ref: '#/components/schemas/DateTime'
      - 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 case 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\": \"serialNum\",\n        \"o\"\
          : \"desc\"\n      }\n    ]\n  } "
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatteryLevelSortCriteria'
      - name: filter
        in: header
        description: |-
          Filter based on column values.  Numeric value will be filtered by an exact match.  Strings will be filtered by partial matches as well and are case insensitive matches. The filter criteria are ANDed together. Example
           {
             "serialNum": "24713521XXXXXX",
             "model": "TCXXXX",
           }
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BatteryLevelFilterCriteria'
      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:
    ApiResponse:
      type: object
      properties:
        status:
          $ref: '#/components/schemas/ApiResponseStatus'
        meta:
          $ref: '#/components/schemas/ApiResponseMeta'
        data:
          type: array
          items:
            oneOf:
            - $ref: '#/components/schemas/BatteryLevel'
        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
    BatteryLevelSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - serialNum
                - assetName
                - deviceType
                - model
                - os
                - siteName
                - siteHierarchy
                - batteryLevelAvg
              o:
                type: string
                description: Order for attribute values
                enum:
                - asc
                - desc
    BatteryLevelFilterCriteria:
      type: object
      properties:
        serialNum:
          type: string
          description: Unique serial number of device
        assetName:
          type: string
          description: Device full name
        deviceType:
          type: string
          description: Type of the device
        model:
          type: string
          description: Model type of device
        os:
          type: string
          description: Operating system installed on device
        siteName:
          type: string
          description: Name of the site that device belongs to
        siteHierarchy:
          type: string
          description: Site Hierarchy of device
        batteryLevelAvg:
          type: string
          description: Average battery level in percentage
    BatteryLevel:
      type: object
      properties:
        serialNum:
          type: string
          description: Unique serial number of device
        assetName:
          type: string
          description: Device full name
        deviceType:
          type: string
          description: Type of the device
        model:
          type: string
          description: Model type of device
        os:
          type: string
          description: Operating system installed on device
        siteName:
          type: string
          description: Name of the site that device belongs to
        siteHierarchy:
          type: string
          description: Site Hierarchy of device
        batteryLevelAvg:
          type: string
          description: Average battery level in percentage
      example:
        serialNum: 15113XX14DXXXX
        assetName: TCXXXX_XX83DEXX84XX
        deviceType: MOBILE COMPUTER
        model: TCXXXX
        os: 4.X.X
        siteName: 677 XXXXXXC XX
        siteHierarchy: company/region/country/timezome/state/sitename
        batteryLevelAvg: 31.42%
    DateTime:
      type: string
      format: date-time
    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
    startDatetime:
      name: startDatetime
      in: header
      description: ISO timestamp for the start of the time period in which data is
        retrieved. The startDatetime should be less than endDatetime. Example=2020-04-13T00:00:00Z
      required: true
      schema:
        $ref: '#/components/schemas/DateTime'
    endDatetime:
      name: endDatetime
      in: header
      description: ISO timestamp for the end of the time period in which  data is
        fetched. The endDatetime should be no more than 18 months from the startDatetime.
        Example=2020-04-13T00:00:00Z
      required: true
      style: simple
      explode: false
      schema:
        $ref: '#/components/schemas/DateTime'
    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: {}
