openapi: 3.0.1
info:
  title: IO.Common Accounts UniqueItems API
  version: '1.0'
security:
- OAuth2: []
tags:
- name: UniqueItems
paths:
  /api/v1/UniqueItems/tools:
    get:
      tags:
      - UniqueItems
      summary: Get status of all the tools in the system for defined period
      parameters:
      - name: dateFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: dateTo
        in: query
        schema:
          type: string
          format: date-time
      - name: status
        in: query
        schema:
          type: string
          default: ''
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ItemStatusRowDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.reporting
  /api/v1/UniqueItems/rent:
    get:
      tags:
      - UniqueItems
      summary: Get status of all the rent items in the system for defined period
      parameters:
      - name: dateFrom
        in: query
        schema:
          type: string
          format: date-time
      - name: dateTo
        in: query
        schema:
          type: string
          format: date-time
      - name: status
        in: query
        schema:
          type: string
          default: ''
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ItemStatusRowDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.reporting
  /api/v1/UniqueItems/statuses:
    get:
      tags:
      - UniqueItems
      summary: Get the current status snapshot for every unique item, scoped to caller's accessible locations.
      parameters:
      - name: locationId
        in: query
        schema:
          type: integer
          format: int32
      - name: statusId
        in: query
        schema:
          type: integer
          format: int32
      - name: genericStatus
        in: query
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UniqueItemCurrentStatusRowDTO'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
      security:
      - OAuth2:
        - io.reporting
components:
  schemas:
    UniqueItemCurrentStatusRowDTO:
      type: object
      properties:
        itemId:
          type: integer
          format: int32
        itemCode:
          type: string
          nullable: true
        itemName:
          type: string
          nullable: true
        itemImage:
          type: string
          nullable: true
        statusId:
          type: integer
          format: int32
          nullable: true
        statusName:
          type: string
          nullable: true
        genericStatus:
          type: integer
          format: int32
          nullable: true
        locationId:
          type: integer
          format: int32
          nullable: true
        location:
          type: string
          nullable: true
        wmsLocationId:
          type: string
          nullable: true
        lastUserId:
          type: integer
          format: int32
          nullable: true
        lastUserName:
          type: string
          nullable: true
        lastUserFirstName:
          type: string
          nullable: true
        lastUserLastName:
          type: string
          nullable: true
        lastTransDate:
          type: string
          format: date-time
          nullable: true
        scanEventId:
          type: integer
          format: int32
          nullable: true
        sessionId:
          type: integer
          format: int32
          nullable: true
        sessionGlobalId:
          type: string
          format: uuid
          nullable: true
        sessionCloseTime:
          type: string
          format: date-time
          nullable: true
        operationId:
          type: integer
          format: int32
          nullable: true
        operation:
          type: string
          nullable: true
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/MetadataDTO'
          nullable: true
        itemProperties:
          type: array
          items:
            $ref: '#/components/schemas/PropertyDTO'
          nullable: true
        itemDefaultImage:
          type: string
          nullable: true
      additionalProperties: false
    MetadataDTO:
      type: object
      properties:
        name:
          type: string
          nullable: true
        shortName:
          type: string
          nullable: true
        value:
          type: string
          nullable: true
        dimensionId:
          type: integer
          format: int32
      additionalProperties: false
    PropertyDTO:
      type: object
      properties:
        key:
          type: string
          nullable: true
        value:
          type: string
          nullable: true
      additionalProperties: false
    Error:
      type: object
      properties:
        code:
          type: string
          nullable: true
        message:
          type: string
          nullable: true
      additionalProperties: false
    ItemStatusRowDTO:
      type: object
      properties:
        itemId:
          type: integer
          format: int32
        itemCode:
          type: string
          nullable: true
        itemName:
          type: string
          nullable: true
        imageUrl:
          type: array
          items:
            type: string
          nullable: true
        locationId:
          type: integer
          format: int32
        location:
          type: string
          nullable: true
        vendor:
          type: string
          nullable: true
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/MetadataDTO'
          nullable: true
        sessionId:
          type: integer
          format: int32
        scanEventId:
          type: integer
          format: int32
        datetime:
          type: string
          format: date-time
        returnDatetime:
          type: string
          format: date-time
          nullable: true
        operationId:
          type: integer
          format: int32
        operation:
          type: string
          nullable: true
        status:
          type: string
          nullable: true
        itemType:
          type: string
          nullable: true
        currentUserId:
          type: integer
          format: int32
        currentUser:
          type: string
          nullable: true
        currentUserFirstName:
          type: string
          nullable: true
        currentUserLastName:
          type: string
          nullable: true
        currentUserFullName:
          type: string
          nullable: true
        previousUserId:
          type: integer
          format: int32
          nullable: true
        previousUser:
          type: string
          nullable: true
        previousUserFirstName:
          type: string
          nullable: true
        previousUserLastName:
          type: string
          nullable: true
        previousUserFullName:
          type: string
          nullable: true
        itemProperties:
          type: array
          items:
            $ref: '#/components/schemas/PropertyDTO'
          nullable: true
      additionalProperties: false
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://identity.scanbro.com/connect/authorize
          tokenUrl: https://identity.scanbro.com/connect/token
          scopes:
            io.common: default scope