swagger: '2.0'
info:
  version: '2.0'
  title: quantity-unit-conversions
consumes:
  - application/json
produces:
  - application/json
paths:
  /quantity-unit-conversions:
    get:
      tags:
        - quantity-unit-conversions
      description: Get a collection of quantity unit conversions.
      operationId: getQuantityUnitConversions
      parameters:
        - name: id
          in: query
          description: The quantity unit conversion ID.
          required: false
          type: integer
          format: int32
        - name: conversionFactor
          in: query
          description: The conversion factor. Implicit conversion rules are derived from explicit rules by combining conversion factors.
          required: false
          type: number
        - name: multiplyOrDivide
          in: query
          description: 'A single character that is used to to convert the quantity unit by either multiplying or dividing. The different modes are  M = multiply by factor, and D = divide by factor. A reverse conversion of the quantity unit using the inverse operation is implicitly defined.'
          required: false
          type: string
        - name: updatable
          in: query
          description: 'A single character that acts as a flag intended to be used by a user interface that manages quantity unit conversion rules. The different modes are N = the conversion factor is irrevocable, It should never be changed. Y = the conversion factor can be changed.'
          required: false
          type: string
        - name: toQuantityUnit
          in: query
          description: A string to specify the quantity unit converted to.
          required: false
          type: string
        - name: fromQuantityUnit
          in: query
          description: A string to specify the quantity unit converted from.
          required: false
          type: string
        - name: offset
          in: query
          description: 'The position within the resulting dataset where the query begins returning item records. If the offset is "5", the records that returned begin with the sixth record that matches the query parameters. If the offset is "0", the records that are returned begin with the first record that matches the query parameters.'
          required: false
          type: integer
          format: int32
        - name: limit
          in: query
          description: The maximum number of records to return.
          required: false
          type: integer
          format: int32
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
      responses:
        '200':
          description: A collection of quantity unit conversions.
          schema:
            $ref: '#/definitions/QuantityUnitConversionCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - quantity-unit-conversions
      description: Create a quantity unit conversion.
      operationId: createQuantityUnitConversion
      parameters:
        - in: body
          name: QuantityUnitConversion
          description: The quantity unit conversion. Each row of this table represents a rule. It can be used to convert a quantity amount from one unit of measurement to another one.
          required: true
          schema:
            $ref: '#/definitions/QuantityUnitConversion'
      responses:
        '201':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
  '/quantity-unit-conversions/{id}':
    get:
      tags:
        - quantity-unit-conversions
      description: Get a quantity unit conversion.
      operationId: getQuantityUnitConversionById
      parameters:
        - name: fields
          in: query
          description: 'The comma-separated set of properties to be returned. If no properties are specified, all properties are returned.'
          required: false
          type: string
        - name: expand
          in: query
          description: 'The comma-separated set of related resources referenced in the links to be returned. If no related resources are specified, no related resources are returned.'
          required: false
          type: string
      responses:
        '200':
          description: The quantity unit conversion. Each row of this table represents a rule. It can be used to convert a quantity amount from one unit of measurement to another one.
          schema:
            $ref: '#/definitions/QuantityUnitConversion'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    delete:
      tags:
        - quantity-unit-conversions
      description: Delete a quantity unit conversion.
      operationId: deleteQuantityUnitConversionById
      parameters: []
      responses:
        '204':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    patch:
      tags:
        - quantity-unit-conversions
      description: Update a quantity unit conversion.
      operationId: updateQuantityUnitConversionById
      parameters:
        - in: body
          name: QuantityUnitConversion
          description: The quantity unit conversion. Each row of this table represents a rule. It can be used to convert a quantity amount from one unit of measurement to another one.
          required: true
          schema:
            $ref: '#/definitions/QuantityUnitConversion'
      responses:
        '200':
          description: The operation was successful.
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '404':
          description: The resource was not found.
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    parameters:
      - name: id
        in: path
        description: The quantity unit conversion ID.
        required: true
        type: integer
        format: int32
definitions:
  Link:
    type: object
    properties:
      href:
        type: string
        format: uri
        description: The URL of the link.
    description: Links to related resources.
  Error:
    type: object
    properties:
      code:
        type: string
        description: The error message code.
      message:
        type: string
        description: The error message.
      messageKey:
        type: string
        description: The error message key.
      messageArguments:
        type: array
        description: The arguments used to construct the error message.
        items:
          type: object
      correlationId:
        type: string
        description: The unique identifier for the request.
      locale:
        type: string
        description: The locale of the error message.
    description: The error message item model.
  ErrorResponseContainer:
    type: object
    properties:
      requestId:
        type: string
        description: The request identifier.
      errors:
        type: array
        description: The errors.
        items:
          $ref: '#/definitions/Error'
    description: The error message model.
  QuantityUnitConversion:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: The quantity unit conversion ID.
      conversionFactor:
        type: number
        description: The conversion factor. Implicit conversion rules are derived from explicit rules by combining conversion factors.
      multiplyOrDivide:
        type: string
        description: 'A single character that is used to to convert the quantity unit by either multiplying or dividing. The different modes are  M = multiply by factor, and D = divide by factor. A reverse conversion of the quantity unit using the inverse operation is implicitly defined.'
      updatable:
        type: string
        description: 'A single character that acts as a flag intended to be used by a user interface that manages quantity unit conversion rules. The different modes are N = the conversion factor is irrevocable, It should never be changed. Y = the conversion factor can be changed.'
      toQuantityUnit:
        type: string
        description: A string to specify the quantity unit converted to.
      fromQuantityUnit:
        type: string
        description: A string to specify the quantity unit converted from.
    description: The quantity unit conversion. Each row of this table represents a rule. It can be used to convert a quantity amount from one unit of measurement to another one.
  QuantityUnitConversionCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/QuantityUnitConversion'
    description: A collection of quantity unit conversions.
