openapi: 3.0.0
info:
  title: VisibilityIQ Total Devices
  version: 1.5.0
servers:
- url: https://api.zebra.com/v2/data/devices/operation/analytics/visibility
  description: For US
- url: https://api.zebra.com/v2/eu/data/devices/operation/analytics/visibility
  description: For EU
security:
- BearerAuth: []
- ApiKeyAuth: []
tags:
- name: Total Devices
paths:
  /total-devices:
    get:
      tags:
      - Total Devices
      summary: Retrieves total devices information
      description: Retrieves devices in all states for a company partner
      operationId: Retrieve Total Devices
      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. Example=2020-04-13T00:00:00Z
        required: true
        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/TotalDevicesSortCriteria'
      - name: filter
        in: header
        description: |-
          Filter based on column values. 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
          {
            "serialNum": "=|17211XXX502429",
            "assetName": "XXX-TXXX-17211XXX502429"
          }
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TotalDevicesFilterCriteria'
      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/Device'
        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
    TotalDevicesSortCriteria:
      type: object
      properties:
        criteria:
          type: array
          items:
            type: object
            properties:
              a:
                type: string
                description: Attribute name
                enum:
                - siteHierarchy
                - assetName
                - serialNum
                - fullModel
                - siteName
                - model
                - deviceType
                - status
                - bssid
                - phoneNum
                - ipAddr
                - os
                - contractId
                - imei
                - networkConnectionType
                - lgVersion
                - macAddress
              o:
                type: string
                description: order for attribute values
                enum:
                - asc
                - desc
    TotalDevicesFilterCriteria:
      type: object
      properties:
        deviceType:
          type: string
          description: The type of the device. The possible Value can be MOBILE COMPUTER
            OR SCANNER OR PRINTER
        siteHierarchy:
          type: string
          description: The Site hierarchy  that the device belongs to.
        assetName:
          type: string
        serialNum:
          type: string
        siteName:
          type: string
        model:
          type: string
        fullModel:
          type: string
        status:
          type: string
        bssid:
          type: string
        phoneNum:
          type: string
        ipAddr:
          type: string
        os:
          type: string
        contractId:
          type: string
        imei:
          type: string
        networkConnectionType:
          type: string
        lgVersion:
          type: string
        macAddress:
          type: string
    Device:
      type: object
      properties:
        deviceType:
          type: string
        siteHierarchy:
          type: string
        assetName:
          type: string
        serialNum:
          type: string
        siteName:
          type: string
        model:
          type: string
        fullModel:
          type: string
        status:
          type: string
        bssid:
          type: string
        phoneNum:
          type: string
        ipAddr:
          type: string
        gpsCoordinates:
          type: string
        os:
          type: string
        contractId:
          type: string
        imei:
          type: string
        networkConnectionType:
          type: string
        lgVersion:
          type: string
        macAddress:
          type: string
      example:
        siteHierarchy: company/region/country/timezome/state/sitename
        assetName: XXX-TXXX-17211XXX502429
        serialNum: 17338XXX500490
        fullModel: TXXXXK-2PAZU4P-XX
        siteName: 7054 XXXXXX
        model: TXXX
        deviceType: XXXXXXX
        status: Un-Utilized
        bssid: 24:xx:xx:xx
        phoneNum: +12289675278
        ipAddr: 120.xx.xx.xx
        gpsCoordinates: 41.4033XXX,23.94XXXX
        os: x.x.x
        contractId: 551501xxx
        imei: 5624786xx
        networkConnectionType: 2x
        lgVersion: x.x.x
        macAddress: 5E:45:1C:xx:xx:xx
    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.
        Example=2020-04-13T00:00:00Z
      required: true
      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: {}
