swagger: '2.0'
info:
  version: '2.0'
  title: contract-trading-agreements
consumes:
  - application/json
produces:
  - application/json
paths:
  /contract-trading-agreements:
    get:
      tags:
        - contract-trading-agreements
      description: Get a collection of contract trading agreements.
      operationId: getContractTradingAgreements
      parameters:
        - name: id
          in: query
          description: The contract trading agreement ID.
          required: false
          type: integer
          format: int64
        - 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 contract trading agreements.
          schema:
            $ref: '#/definitions/ContractTradingAgreementCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - contract-trading-agreements
      description: ''
      operationId: createContractTradingAgreement
      parameters:
        - in: body
          name: ContractTradingAgreement
          description: The contract trading agreement.
          required: true
          schema:
            $ref: '#/definitions/ContractTradingAgreement'
      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'
  '/contract-trading-agreements/{id}':
    get:
      tags:
        - contract-trading-agreements
      description: Get a contract-trading-agreement.
      operationId: getContractTradingAgreementById
      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 contract trading agreement.
          schema:
            $ref: '#/definitions/ContractTradingAgreement'
        '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:
        - contract-trading-agreements
      description: ''
      operationId: deleteContractTradingAgreementById
      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:
        - contract-trading-agreements
      description: ''
      operationId: updateContractTradingAgreementById
      parameters:
        - in: body
          name: ContractTradingAgreement
          description: The contract trading agreement.
          required: true
          schema:
            $ref: '#/definitions/ContractTradingAgreement'
      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 contract trading agreement ID.
        required: true
        type: integer
        format: int64
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.
  ContractTradingAgreement:
    type: object
    properties:
      id:
        type: integer
        format: int64
        description: The contract trading agreement ID.
    description: The contract trading agreement.
  ContractTradingAgreementCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/ContractTradingAgreement'
    description: A collection of contract trading agreements.
