swagger: '2.0'
info:
  version: '2.0'
  title: calculation-scale-descriptions
consumes:
  - application/json
produces:
  - application/json
paths:
  /calculation-scale-descriptions:
    get:
      tags:
        - calculation-scale-descriptions
      description: Get a collection of language-dependent Calculation Scale Description.
      operationId: getCalculationScaleDescriptions
      parameters:
        - name: calculationScaleId
          in: query
          description: The Calculation Scale ID.
          required: false
          type: integer
          format: int32
        - name: languageId
          in: query
          description: 'The Language ID, The language for which this information applies.'
          required: false
          type: integer
          format: int32
        - name: description
          in: query
          description: The description of the Calculation Scale.
          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 language-dependent Calculation Scale Description.
          schema:
            $ref: '#/definitions/CalculationScaleDescriptionCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - calculation-scale-descriptions
      description: Create a language-dependent calculation scale description.
      operationId: createCalculationScaleDescription
      parameters:
        - in: body
          name: CalculationScaleDescription
          description: A Language-dependent information for a Calculation Scale.
          required: true
          schema:
            $ref: '#/definitions/CalculationScaleDescription'
      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'
  '/calculation-scale-descriptions/calculationScaleId:{calculationScaleId},languageId:{languageId}':
    get:
      tags:
        - calculation-scale-descriptions
      description: Get a calculation scale description of a language-dependent.
      operationId: getCalculationScaleDescriptionById
      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: A Language-dependent information for a Calculation Scale.
          schema:
            $ref: '#/definitions/CalculationScaleDescription'
        '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:
        - calculation-scale-descriptions
      description: Delete a language-dependent calculation scale description.
      operationId: deleteCalculationScaleDescriptionById
      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:
        - calculation-scale-descriptions
      description: Update a language-dependent calculation scale description.
      operationId: updateCalculationScaleDescriptionById
      parameters:
        - in: body
          name: CalculationScaleDescription
          description: A Language-dependent information for a Calculation Scale.
          required: true
          schema:
            $ref: '#/definitions/CalculationScaleDescription'
      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: calculationScaleId
        in: path
        description: The Calculation Scale ID.
        required: true
        type: integer
        format: int32
      - name: languageId
        in: path
        description: 'The Language ID, The language for which this information applies.'
        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.
  CalculationScaleDescription:
    type: object
    properties:
      calculationScaleId:
        type: integer
        format: int32
        description: The Calculation Scale ID.
      languageId:
        type: integer
        format: int32
        description: 'The Language ID, The language for which this information applies.'
      description:
        type: string
        description: The description of the Calculation Scale.
    description: A Language-dependent information for a Calculation Scale.
  CalculationScaleDescriptionCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/CalculationScaleDescription'
    description: A collection of language-dependent Calculation Scale Description.
