swagger: '2.0'
info:
  version: '2.0'
  title: order-block-reason-codes
consumes:
  - application/json
produces:
  - application/json
paths:
  /order-block-reason-codes:
    get:
      tags:
        - order-block-reason-codes
      description: Get a collection of order block reason codes.
      operationId: getOrderBlockReasonCodes
      parameters:
        - name: id
          in: query
          description: The unique reason code Id for the block reason.
          required: false
          type: integer
          format: int32
        - name: reasonType
          in: query
          description: A broad classification for the reason code. Reason codes of similar nature are grouped together by block reason type.
          required: false
          type: string
        - name: manualBlock
          in: query
          description: Blocks that are marked manual can be applied using the Telesales rich client.
          required: false
          type: number
        - name: markForDelete
          in: query
          description: 'Indicates if this reason code is scheduled to be deleted, and hence will not be used.'
          required: false
          type: string
        - name: field1
          in: query
          description: Field for customization.
          required: false
          type: integer
          format: int32
        - name: field2
          in: query
          description: Field for customization.
          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
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: A collection of order block reason codes.
          schema:
            $ref: '#/definitions/OrderBlockReasonCodeCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    post:
      tags:
        - order-block-reason-codes
      description: Create an order block reason code.
      operationId: createOrderBlockReasonCode
      parameters:
        - in: body
          name: OrderBlockReasonCode
          description: The order block reason code.
          required: true
          schema:
            $ref: '#/definitions/OrderBlockReasonCode'
      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'
  '/order-block-reason-codes/{id}':
    get:
      tags:
        - order-block-reason-codes
      description: Get an order block reason code.
      operationId: getOrderBlockReasonCodeById
      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
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: The order block reason code.
          schema:
            $ref: '#/definitions/OrderBlockReasonCode'
        '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:
        - order-block-reason-codes
      description: Delete an order block reason code.
      operationId: deleteOrderBlockReasonCodeById
      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:
        - order-block-reason-codes
      description: Update an order block reason code.
      operationId: updateOrderBlockReasonCodeById
      parameters:
        - in: body
          name: OrderBlockReasonCode
          description: The order block reason code.
          required: true
          schema:
            $ref: '#/definitions/OrderBlockReasonCode'
      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 unique reason code Id for the block reason.
        required: true
        type: integer
        format: int32
  '/order-block-reason-codes/{id}/order-blocks':
    get:
      tags:
        - order-block-reason-codes
      description: Finds order blocks  attached to the unique reason code Id for the block reason.
      operationId: getOrderBlocksOfOrderBlockReasonCode
      parameters:
        - 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
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: A collection of order blocks.
          schema:
            $ref: '#/definitions/OrderBlockCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    parameters:
      - name: id
        in: path
        description: The unique reason code Id for the block reason.
        required: true
        type: integer
        format: int32
  '/order-block-reason-codes/{id}/order-block-reason-code-descriptions':
    get:
      tags:
        - order-block-reason-codes
      description: Finds block reason descriptions attached to the unique reason code Id.
      operationId: getOrderBlockReasonCodeDescriptionsOfOrderBlockReasonCode
      parameters:
        - 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
        - name: sort
          in: query
          description: 'The comma-separated set of properties which controls the order of the items being listed, prefixed by either (-) to sort by descending order, or optionally (+) to sort by ascending order. For example, sort=name,-d which means, order the items based on the name value in ascending order, then by the id value in descending order.'
          required: false
          type: string
      responses:
        '200':
          description: A collection of order block reason code descriptions.
          schema:
            $ref: '#/definitions/OrderBlockReasonCodeDescriptionCollection'
        '400':
          description: There was a client error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
        '500':
          description: There was a server error.
          schema:
            $ref: '#/definitions/ErrorResponseContainer'
    parameters:
      - name: id
        in: path
        description: The unique reason code Id for the block reason.
        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.
  OrderBlockReasonCode:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: The unique reason code Id for the block reason.
      reasonType:
        type: string
        description: A broad classification for the reason code. Reason codes of similar nature are grouped together by block reason type.
      manualBlock:
        type: number
        description: Blocks that are marked manual can be applied using the Telesales rich client.
      markForDelete:
        type: string
        description: 'Indicates if this reason code is scheduled to be deleted, and hence will not be used.'
      field1:
        type: integer
        format: int32
        description: Field for customization.
      field2:
        type: string
        description: Field for customization.
      links:
        type: object
        description: Links to related resources.
        properties:
          order-blocks:
            type: object
            description: The unique reason code Id for the block reason.
            properties:
              href:
                type: string
                description: The URL of the link.
          order-block-reason-code-descriptions:
            type: object
            description: The unique reason code Id for the block reason description.
            properties:
              href:
                type: string
                description: The URL of the link.
    description: The order block reason code.
  OrderBlockReasonCodeCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/OrderBlockReasonCode'
    description: A collection of order block reason codes.
  OrderBlock:
    type: object
    properties:
      id:
        type: integer
        format: int64
        description: The unique numeric ID for identifying the blocked order.
      orderId:
        type: integer
        format: int64
        description: The unique numeric order ID whose block is being recorded.
      reasonCodeId:
        type: integer
        format: int32
        description: The reason code Id associated with this block. It identifies the reason for the block
      resolved:
        type: number
        description: 'Indicates if this block has been resolved. That is, if it is no longer blocking the Order. 0 indicates it is not resolved, 1 indicates it is resolved'
      updatedDateTime:
        type: string
        format: date-time
        description: The time the block was placed or last updated.
      comment:
        type: string
        description: Comment field to record any comments pertaining to this block. The field can be updated as needed.
      field1:
        type: integer
        format: int32
        description: Field for customization.
      field2:
        type: string
        description: Field for customization.
    description: The order block.
  OrderBlockCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/OrderBlock'
    description: A collection of order blocks.
  OrderBlockReasonCodeDescription:
    type: object
    properties:
      id:
        type: integer
        format: int32
        description: The unique reason code Id for the block reason.
      languageId:
        type: integer
        format: int32
        description: The specific language in which the description is being provided.
      description:
        type: string
        description: The description of the block reason code.
    description: The order block reason code description.
  OrderBlockReasonCodeDescriptionCollection:
    type: object
    properties:
      count:
        type: integer
        format: int64
        description: The total number of items.
      items:
        type: array
        description: The items.
        items:
          $ref: '#/definitions/OrderBlockReasonCodeDescription'
    description: A collection of order block reason code descriptions.
