openapi: 3.0.1
info:
  title: TMF685 Resource Pool Management
  description: "This API enables MSISDN reservation for registration and validates\
    \ starter pack pairing, supporting efficient resource pool management."
  license:
    name: MADAPI
    url: https://developers.mtn.com/
  version: 3.0.0 - Last updated date:2026-08-19 19:46:59
servers:
- url: https://api.mtn.com/v1
  description: Production Server
security:
- OAuth2: []
tags:
- name: Tmf685ResourcePoolManagement
paths:
  /availabilityCheck:
    post:
      tags:
      - Tmf685ResourcePoolManagement
      summary: availability Check
      description: This posts an availability check request to verify if a resource
        is available for reservation or assignment in the pool.
      operationId: ResourcePoolManagementService_post_availabilityCheck
      parameters:
      - name: transactionId
        in: header
        required: false
        schema:
          type: string
      - name: x-authorization
        in: header
        required: false
        schema:
          type: string
      - name: x-country-code
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              title: AvailabilityCheck
              type: object
              properties:
                resourceCapacityDemand:
                  title: AvailabilityResourceCapacityDemand
                  type: object
                  properties:
                    resourceCapacityDemandAmount:
                      type: string
                    pattern:
                      type: string
                    isMNP:
                      type: string
                    category:
                      title: Category
                      type: object
                      properties:
                        id:
                          type: string
                        description:
                          type: string
                        name:
                          type: array
                          items:
                            type: string
                        code:
                          type: array
                          items:
                            type: string
                    resourceCharacteristic:
                      type: array
                      items:
                        title: ResourceCharacteristic
                        type: object
                        properties:
                          code:
                            type: string
                          value:
                            type: array
                            items:
                              type: string
                    '@type':
                      title: ResourceType
                      type: object
                      properties:
                        value:
                          type: string
                    resourcePool:
                      title: ResourcePool
                      type: object
                      properties:
                        id:
                          type: array
                          items:
                            type: string
                        name:
                          type: array
                          items:
                            type: string
                    place:
                      title: Place
                      type: object
                      properties:
                        id:
                          type: array
                          items:
                            type: string
                        name:
                          type: array
                          items:
                            type: string
                    productOffering:
                      title: ProductOffering
                      type: object
                      properties:
                        id:
                          type: array
                          items:
                            type: string
                        name:
                          type: array
                          items:
                            type: string
                    businessType:
                      title: DRMBusinessType
                      type: object
                      properties:
                        type:
                          type: string
        required: true
      responses:
        "200":
          description: HTTP 200 indicating the request succeeded; the response body
            follows the documented schema for this operation and includes correlation
            identifiers where applicable for traceability across MTN MADAPI tmf685
            resource pool management flows.
          content:
            application/json:
              schema:
                title: AvailabilityResponse
                type: object
                properties:
                  appliedResourceCapacity:
                    title: AppliedResourceCapacity
                    type: object
                    properties:
                      appliedCapacityAmount:
                        type: string
                      resource:
                        type: array
                        items:
                          title: Resource
                          type: object
                          properties:
                            id:
                              type: string
                            '@referredType':
                              $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
                            '@baseType':
                              type: string
                            value:
                              type: string
        "400":
          description: "Bad request. Invalid request parameters, missing required\
            \ fields, or validation errors."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "400"
                statusMessage: "Bad request. Invalid request parameters, missing required\
                  \ fields, or validation errors."
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "401":
          description: "Unauthorized. Invalid or missing authorization credentials,\
            \ insufficient permissions, or authentication failure."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "401"
                statusMessage: "Unauthorized. Invalid or missing authorization credentials,\
                  \ insufficient permissions, or authentication failure."
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "403":
          description: Forbidden. Access denied. The request is valid but the server
            refuses to perform it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "403"
                statusMessage: Forbidden. Access denied. The request is valid but
                  the server refuses to perform it.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "404":
          description: Not found. The requested resource was not found or does not
            exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "404"
                statusMessage: Not found. The requested resource was not found or
                  does not exist.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "500":
          description: "Internal server error. Unexpected system failure, database\
            \ connectivity issues, or external service integration problems."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "500"
                statusMessage: "Internal server error. Unexpected system failure,\
                  \ database connectivity issues, or external service integration\
                  \ problems."
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "502":
          description: Bad gateway. The server acting as a gateway received an invalid
            response from an upstream server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "502"
                statusMessage: Bad gateway. The server acting as a gateway received
                  an invalid response from an upstream server.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "503":
          description: Service unavailable. The server is temporarily unable to handle
            the request due to maintenance or overload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "503"
                statusMessage: Service unavailable. The server is temporarily unable
                  to handle the request due to maintenance or overload.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
      deprecated: false
  /reservation:
    get:
      tags:
      - Tmf685ResourcePoolManagement
      summary: reservation
      description: This performs a Get reservation request to retrieve existing resource
        reservations using optional filtering to narrow down results.
      operationId: ResourcePoolManagementService_get_getReservation_reservation
      parameters:
      - name: '@type'
        in: query
        required: false
        schema:
          type: string
      - name: fields
        in: query
        required: false
        schema:
          type: string
      - name: name
        in: query
        required: false
        schema:
          type: string
      - name: transactionId
        in: header
        required: false
        schema:
          type: string
      - name: x-authorization
        in: header
        required: false
        schema:
          type: string
      - name: x-country-code
        in: header
        required: false
        schema:
          type: string
      responses:
        "200":
          description: HTTP 200 indicating the request succeeded; the response body
            follows the documented schema for this operation and includes correlation
            identifiers where applicable for traceability across MTN MADAPI tmf685
            resource pool management flows.
          content:
            application/json:
              schema:
                title: GetReservationResponse
                type: object
                properties:
                  href:
                    type: string
                  '@schemaLocation':
                    type: string
                  id:
                    type: string
                  reservationState:
                    type: string
                  relatedParty:
                    type: array
                    items:
                      title: RelatedParty
                      type: object
                      properties:
                        name:
                          type: string
                        role:
                          type: string
                        '@type':
                          type: string
                        '@baseType':
                          type: string
                  version:
                    type: integer
                    format: int32
                  '@type':
                    $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
                  resourceReservationItem:
                    title: ResourceReservationItem
                    type: object
                    properties:
                      quantity:
                        type: integer
                        format: int32
                      items:
                        type: array
                        items:
                          title: ResourceItem
                          type: object
                          properties:
                            resourceCapacityDemand:
                              title: ResourceCapacityDemand
                              type: object
                              properties:
                                resourceCapacityDemandAmount:
                                  type: integer
                                  format: int32
                                '@type':
                                  type: string
                                resourcePool:
                                  type: string
                            appliedResourceCapacity:
                              title: AppliedResourceCapacity
                              type: object
                              properties:
                                appliedCapacityAmount:
                                  type: string
                                resource:
                                  type: array
                                  items:
                                    title: ResponseResource
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                      href:
                                        type: string
                                      '@referredType':
                                        $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
                                      '@baseType':
                                        type: string
                                      value:
                                        type: string
                            subReservationState:
                              type: string
                  valid_for:
                    title: ValidFor
                    type: object
                    properties:
                      startDate:
                        type: string
                      endDate:
                        type: string
        "400":
          description: "Bad request. Invalid request parameters, missing required\
            \ fields, or validation errors."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "400"
                statusMessage: "Bad request. Invalid request parameters, missing required\
                  \ fields, or validation errors."
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "401":
          description: "Unauthorized. Invalid or missing authorization credentials,\
            \ insufficient permissions, or authentication failure."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "401"
                statusMessage: "Unauthorized. Invalid or missing authorization credentials,\
                  \ insufficient permissions, or authentication failure."
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "403":
          description: Forbidden. Access denied. The request is valid but the server
            refuses to perform it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "403"
                statusMessage: Forbidden. Access denied. The request is valid but
                  the server refuses to perform it.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "404":
          description: Not found. The requested resource was not found or does not
            exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "404"
                statusMessage: Not found. The requested resource was not found or
                  does not exist.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "500":
          description: "Internal server error. Unexpected system failure, database\
            \ connectivity issues, or external service integration problems."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "500"
                statusMessage: "Internal server error. Unexpected system failure,\
                  \ database connectivity issues, or external service integration\
                  \ problems."
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "502":
          description: Bad gateway. The server acting as a gateway received an invalid
            response from an upstream server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "502"
                statusMessage: Bad gateway. The server acting as a gateway received
                  an invalid response from an upstream server.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "503":
          description: Service unavailable. The server is temporarily unable to handle
            the request due to maintenance or overload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "503"
                statusMessage: Service unavailable. The server is temporarily unable
                  to handle the request due to maintenance or overload.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
      deprecated: false
    post:
      tags:
      - Tmf685ResourcePoolManagement
      summary: reservation
      description: "This posts a reservation request to allocate a resource such as\
        \ an MSISDN, ensuring it is marked and held for future use."
      operationId: ResourcePoolManagementService_post_reservation
      parameters:
      - name: transactionId
        in: header
        required: false
        schema:
          type: string
      - name: x-authorization
        in: header
        required: false
        schema:
          type: string
      - name: x-country-code
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              title: ReservationRequest
              type: object
              properties:
                '@type':
                  $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
                resourceReservationItem:
                  $ref: '#/components/schemas/com_mtn_aggregator_models_reservation_response_ResourceReservationItem'
                valid_for:
                  $ref: '#/components/schemas/com_mtn_aggregator_models_reservation_response_ValidFor'
        required: true
      responses:
        "200":
          description: HTTP 200 indicating the request succeeded; the response body
            follows the documented schema for this operation and includes correlation
            identifiers where applicable for traceability across MTN MADAPI tmf685
            resource pool management flows.
          content:
            application/json:
              schema:
                title: ReservationResponse
                type: object
                properties:
                  id:
                    type: string
                  reservationState:
                    type: string
                  relatedParty:
                    type: array
                    items:
                      $ref: '#/components/schemas/com_mtn_aggregator_models_reservation_response_RelatedParty'
                  version:
                    type: integer
                    format: int32
                  '@type':
                    $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
                  resourceReservationItem:
                    $ref: '#/components/schemas/com_mtn_aggregator_models_reservation_response_ResourceReservationItem'
                  valid_for:
                    $ref: '#/components/schemas/com_mtn_aggregator_models_reservation_response_ValidFor'
        "400":
          description: "Bad request. Invalid request parameters, missing required\
            \ fields, or validation errors."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "400"
                statusMessage: "Bad request. Invalid request parameters, missing required\
                  \ fields, or validation errors."
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "401":
          description: "Unauthorized. Invalid or missing authorization credentials,\
            \ insufficient permissions, or authentication failure."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "401"
                statusMessage: "Unauthorized. Invalid or missing authorization credentials,\
                  \ insufficient permissions, or authentication failure."
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "403":
          description: Forbidden. Access denied. The request is valid but the server
            refuses to perform it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "403"
                statusMessage: Forbidden. Access denied. The request is valid but
                  the server refuses to perform it.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "404":
          description: Not found. The requested resource was not found or does not
            exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "404"
                statusMessage: Not found. The requested resource was not found or
                  does not exist.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "500":
          description: "Internal server error. Unexpected system failure, database\
            \ connectivity issues, or external service integration problems."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "500"
                statusMessage: "Internal server error. Unexpected system failure,\
                  \ database connectivity issues, or external service integration\
                  \ problems."
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "502":
          description: Bad gateway. The server acting as a gateway received an invalid
            response from an upstream server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "502"
                statusMessage: Bad gateway. The server acting as a gateway received
                  an invalid response from an upstream server.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "503":
          description: Service unavailable. The server is temporarily unable to handle
            the request due to maintenance or overload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "503"
                statusMessage: Service unavailable. The server is temporarily unable
                  to handle the request due to maintenance or overload.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
      deprecated: false
  /reservation/{reservationId}:
    patch:
      tags:
      - Tmf685ResourcePoolManagement
      summary: reservation
      description: This performs a Update reservation request by reservationId of
        an existing reservation in the pool to apply changes as required.
      operationId: ResourcePoolManagementService_patch_reservationPatch_reservationreservati
      parameters:
      - name: reservationId
        in: path
        required: true
        schema:
          type: string
      - name: transactionId
        in: header
        required: false
        schema:
          type: string
      - name: x-authorization
        in: header
        required: false
        schema:
          type: string
      - name: x-country-code
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              title: UnReserveRequest
              type: object
              properties:
                reservationState:
                  type: string
        required: true
      responses:
        "200":
          description: HTTP 200 indicating the request succeeded; the response body
            follows the documented schema for this operation and includes correlation
            identifiers where applicable for traceability across MTN MADAPI tmf685
            resource pool management flows.
          content:
            application/json:
              schema:
                title: UnReserveResponse
                type: object
                properties:
                  id:
                    type: string
                  href:
                    type: string
                  description:
                    type: string
                  resourceReservationItem:
                    title: UnReserveResourceReservationItem
                    type: object
                    properties:
                      quantity:
                        type: integer
                        format: int32
                      items:
                        type: array
                        items:
                          title: UnReserveItem
                          type: object
                          properties:
                            resourceCapacityDemand:
                              title: UnReserveResourceCapacityDemand
                              type: object
                              properties:
                                resourceCapacityDemandAmount:
                                  type: integer
                                  format: int32
                            appliedResourceCapacity:
                              title: UnReserveResourceCapacity
                              type: object
                              properties:
                                appliedCapacityAmount:
                                  type: string
                                resource:
                                  type: array
                                  items:
                                    title: UnReserveResource
                                    type: object
                                    properties:
                                      id:
                                        type: string
                                      href:
                                        type: string
                                      value:
                                        type: string
                            subReservationState:
                              type: string
                  requestedPeriod:
                    title: UnReserveRequestedPeriod
                    type: object
                    properties:
                      startDate:
                        type: string
                      endDate:
                        type: string
                  createdAt:
                    type: string
                  updatedAt:
                    type: string
                  __v:
                    type: integer
                    format: int32
                  reservationState:
                    type: string
        "400":
          description: "Bad request. Invalid request parameters, missing required\
            \ fields, or validation errors."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "400"
                statusMessage: "Bad request. Invalid request parameters, missing required\
                  \ fields, or validation errors."
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "401":
          description: "Unauthorized. Invalid or missing authorization credentials,\
            \ insufficient permissions, or authentication failure."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "401"
                statusMessage: "Unauthorized. Invalid or missing authorization credentials,\
                  \ insufficient permissions, or authentication failure."
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "403":
          description: Forbidden. Access denied. The request is valid but the server
            refuses to perform it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "403"
                statusMessage: Forbidden. Access denied. The request is valid but
                  the server refuses to perform it.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "404":
          description: Not found. The requested resource was not found or does not
            exist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "404"
                statusMessage: Not found. The requested resource was not found or
                  does not exist.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "500":
          description: "Internal server error. Unexpected system failure, database\
            \ connectivity issues, or external service integration problems."
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "500"
                statusMessage: "Internal server error. Unexpected system failure,\
                  \ database connectivity issues, or external service integration\
                  \ problems."
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "502":
          description: Bad gateway. The server acting as a gateway received an invalid
            response from an upstream server.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "502"
                statusMessage: Bad gateway. The server acting as a gateway received
                  an invalid response from an upstream server.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
        "503":
          description: Service unavailable. The server is temporarily unable to handle
            the request due to maintenance or overload.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIError'
              example:
                statusCode: "503"
                statusMessage: Service unavailable. The server is temporarily unable
                  to handle the request due to maintenance or overload.
                supportMessage: API_ERROR
                transactionId: "1234567890"
                sequenceNo: "20250115120000001"
                timestamp: 2025-01-15T12:00:00Z
      deprecated: false
components:
  schemas:
    com_mtn_aggregator_models_reservation_response_ValidFor:
      title: ValidFor
      type: object
      properties:
        startDate:
          type: string
        endDate:
          type: string
    com_mtn_aggregator_models_reservation_response_ReservationResponse:
      title: ReservationResponse
      type: object
      properties:
        id:
          type: string
        reservationState:
          type: string
        relatedParty:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_reservation_response_RelatedParty'
        version:
          type: integer
          format: int32
        '@type':
          $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
        resourceReservationItem:
          $ref: '#/components/schemas/com_mtn_aggregator_models_reservation_response_ResourceReservationItem'
        valid_for:
          $ref: '#/components/schemas/com_mtn_aggregator_models_reservation_response_ValidFor'
    com_mtn_aggregator_models_reservation_request_ReservationRequest:
      title: ReservationRequest
      type: object
      properties:
        '@type':
          $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
        resourceReservationItem:
          $ref: '#/components/schemas/com_mtn_aggregator_models_reservation_response_ResourceReservationItem'
        valid_for:
          $ref: '#/components/schemas/com_mtn_aggregator_models_reservation_response_ValidFor'
    com_mtn_aggregator_models_reservation_response_GetReservationResponse:
      title: GetReservationResponse
      type: object
      properties:
        href:
          type: string
        '@schemaLocation':
          type: string
        id:
          type: string
        reservationState:
          type: string
        relatedParty:
          type: array
          items:
            title: RelatedParty
            type: object
            properties:
              name:
                type: string
              role:
                type: string
              '@type':
                type: string
              '@baseType':
                type: string
        version:
          type: integer
          format: int32
        '@type':
          $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
        resourceReservationItem:
          title: ResourceReservationItem
          type: object
          properties:
            quantity:
              type: integer
              format: int32
            items:
              type: array
              items:
                title: ResourceItem
                type: object
                properties:
                  resourceCapacityDemand:
                    title: ResourceCapacityDemand
                    type: object
                    properties:
                      resourceCapacityDemandAmount:
                        type: integer
                        format: int32
                      '@type':
                        type: string
                      resourcePool:
                        type: string
                  appliedResourceCapacity:
                    title: AppliedResourceCapacity
                    type: object
                    properties:
                      appliedCapacityAmount:
                        type: string
                      resource:
                        type: array
                        items:
                          title: ResponseResource
                          type: object
                          properties:
                            id:
                              type: string
                            href:
                              type: string
                            '@referredType':
                              $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
                            '@baseType':
                              type: string
                            value:
                              type: string
                  subReservationState:
                    type: string
        valid_for:
          title: ValidFor
          type: object
          properties:
            startDate:
              type: string
            endDate:
              type: string
    com_mtn_aggregator_models_reservation_response_AppliedResourceCapacity:
      title: AppliedResourceCapacity
      type: object
      properties:
        appliedCapacityAmount:
          type: string
        resource:
          type: array
          items:
            title: ResponseResource
            type: object
            properties:
              id:
                type: string
              href:
                type: string
              '@referredType':
                $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
              '@baseType':
                type: string
              value:
                type: string
    com_mtn_aggregator_models_availability_request_AvailabilityResourceCapacityDemand:
      title: AvailabilityResourceCapacityDemand
      type: object
      properties:
        resourceCapacityDemandAmount:
          type: string
        pattern:
          type: string
        isMNP:
          type: string
        category:
          title: Category
          type: object
          properties:
            id:
              type: string
            description:
              type: string
            name:
              type: array
              items:
                type: string
            code:
              type: array
              items:
                type: string
        resourceCharacteristic:
          type: array
          items:
            title: ResourceCharacteristic
            type: object
            properties:
              code:
                type: string
              value:
                type: array
                items:
                  type: string
        '@type':
          title: ResourceType
          type: object
          properties:
            value:
              type: string
        resourcePool:
          title: ResourcePool
          type: object
          properties:
            id:
              type: array
              items:
                type: string
            name:
              type: array
              items:
                type: string
        place:
          title: Place
          type: object
          properties:
            id:
              type: array
              items:
                type: string
            name:
              type: array
              items:
                type: string
        productOffering:
          title: ProductOffering
          type: object
          properties:
            id:
              type: array
              items:
                type: string
            name:
              type: array
              items:
                type: string
        businessType:
          title: DRMBusinessType
          type: object
          properties:
            type:
              type: string
    com_mtn_aggregator_models_availability_request_Place:
      title: Place
      type: object
      properties:
        id:
          type: array
          items:
            type: string
        name:
          type: array
          items:
            type: string
    com_mtn_aggregator_models_unreserve_response_UnReserveRequestedPeriod:
      title: UnReserveRequestedPeriod
      type: object
      properties:
        startDate:
          type: string
        endDate:
          type: string
    com_mtn_aggregator_models_availability_response_AvailabilityResponse:
      title: AvailabilityResponse
      type: object
      properties:
        appliedResourceCapacity:
          title: AppliedResourceCapacity
          type: object
          properties:
            appliedCapacityAmount:
              type: string
            resource:
              type: array
              items:
                title: Resource
                type: object
                properties:
                  id:
                    type: string
                  '@referredType':
                    $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
                  '@baseType':
                    type: string
                  value:
                    type: string
    com_mtn_aggregator_models_availability_request_Category:
      title: Category
      type: object
      properties:
        id:
          type: string
        description:
          type: string
        name:
          type: array
          items:
            type: string
        code:
          type: array
          items:
            type: string
    com_mtn_aggregator_enums_ResourceType:
      title: ResourceType
      type: object
      properties:
        value:
          type: string
    com_mtn_aggregator_models_unreserve_response_UnReserveResource:
      title: UnReserveResource
      type: object
      properties:
        id:
          type: string
        href:
          type: string
        value:
          type: string
    APIError:
      title: APIError
      required:
      - statusCode
      - statusMessage
      type: object
      properties:
        statusCode:
          type: string
          description: Error status code
        statusMessage:
          type: string
          description: Human-readable error message
        supportMessage:
          type: string
          description: Technical support message or error code for troubleshooting
        transactionId:
          type: string
          description: Transaction identifier for tracking and correlation
        sequenceNo:
          type: string
          description: Sequence number for request tracking
        timestamp:
          type: string
          description: Error timestamp in ISO 8601 format
          format: date-time
        path:
          type: string
          description: API endpoint path where the error occurred
        method:
          type: string
          description: HTTP method of the request that caused the error
        downstreamStatusCode:
          type: string
          description: Downstream service error code if applicable
      description: Generic MADAPI error response structure
    com_mtn_aggregator_models_availability_request_AvailabilityCheck:
      title: AvailabilityCheck
      type: object
      properties:
        resourceCapacityDemand:
          title: AvailabilityResourceCapacityDemand
          type: object
          properties:
            resourceCapacityDemandAmount:
              type: string
            pattern:
              type: string
            isMNP:
              type: string
            category:
              title: Category
              type: object
              properties:
                id:
                  type: string
                description:
                  type: string
                name:
                  type: array
                  items:
                    type: string
                code:
                  type: array
                  items:
                    type: string
            resourceCharacteristic:
              type: array
              items:
                title: ResourceCharacteristic
                type: object
                properties:
                  code:
                    type: string
                  value:
                    type: array
                    items:
                      type: string
            '@type':
              title: ResourceType
              type: object
              properties:
                value:
                  type: string
            resourcePool:
              title: ResourcePool
              type: object
              properties:
                id:
                  type: array
                  items:
                    type: string
                name:
                  type: array
                  items:
                    type: string
            place:
              title: Place
              type: object
              properties:
                id:
                  type: array
                  items:
                    type: string
                name:
                  type: array
                  items:
                    type: string
            productOffering:
              title: ProductOffering
              type: object
              properties:
                id:
                  type: array
                  items:
                    type: string
                name:
                  type: array
                  items:
                    type: string
            businessType:
              title: DRMBusinessType
              type: object
              properties:
                type:
                  type: string
    com_mtn_aggregator_models_unreserve_response_UnReserveResponse:
      title: UnReserveResponse
      type: object
      properties:
        id:
          type: string
        href:
          type: string
        description:
          type: string
        resourceReservationItem:
          title: UnReserveResourceReservationItem
          type: object
          properties:
            quantity:
              type: integer
              format: int32
            items:
              type: array
              items:
                title: UnReserveItem
                type: object
                properties:
                  resourceCapacityDemand:
                    title: UnReserveResourceCapacityDemand
                    type: object
                    properties:
                      resourceCapacityDemandAmount:
                        type: integer
                        format: int32
                  appliedResourceCapacity:
                    title: UnReserveResourceCapacity
                    type: object
                    properties:
                      appliedCapacityAmount:
                        type: string
                      resource:
                        type: array
                        items:
                          title: UnReserveResource
                          type: object
                          properties:
                            id:
                              type: string
                            href:
                              type: string
                            value:
                              type: string
                  subReservationState:
                    type: string
        requestedPeriod:
          title: UnReserveRequestedPeriod
          type: object
          properties:
            startDate:
              type: string
            endDate:
              type: string
        createdAt:
          type: string
        updatedAt:
          type: string
        __v:
          type: integer
          format: int32
        reservationState:
          type: string
    com_mtn_aggregator_models_unreserve_response_UnReserveResourceCapacityDemand:
      title: UnReserveResourceCapacityDemand
      type: object
      properties:
        resourceCapacityDemandAmount:
          type: integer
          format: int32
    com_mtn_aggregator_models_availability_response_AppliedResourceCapacity:
      title: AppliedResourceCapacity
      type: object
      properties:
        appliedCapacityAmount:
          type: string
        resource:
          type: array
          items:
            title: Resource
            type: object
            properties:
              id:
                type: string
              '@referredType':
                $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
              '@baseType':
                type: string
              value:
                type: string
    com_mtn_aggregator_models_reservation_response_ResourceItem:
      title: ResourceItem
      type: object
      properties:
        resourceCapacityDemand:
          title: ResourceCapacityDemand
          type: object
          properties:
            resourceCapacityDemandAmount:
              type: integer
              format: int32
            '@type':
              type: string
            resourcePool:
              type: string
        appliedResourceCapacity:
          title: AppliedResourceCapacity
          type: object
          properties:
            appliedCapacityAmount:
              type: string
            resource:
              type: array
              items:
                title: ResponseResource
                type: object
                properties:
                  id:
                    type: string
                  href:
                    type: string
                  '@referredType':
                    $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
                  '@baseType':
                    type: string
                  value:
                    type: string
        subReservationState:
          type: string
    com_mtn_aggregator_models_availability_response_Resource:
      title: Resource
      type: object
      properties:
        id:
          type: string
        '@referredType':
          $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
        '@baseType':
          type: string
        value:
          type: string
    com_mtn_aggregator_models_reservation_response_RelatedParty:
      title: RelatedParty
      type: object
      properties:
        name:
          type: string
        role:
          type: string
        '@type':
          type: string
        '@baseType':
          type: string
    com_mtn_aggregator_models_reservation_response_ResourceReservationItem:
      title: ResourceReservationItem
      type: object
      properties:
        quantity:
          type: integer
          format: int32
        items:
          type: array
          items:
            title: ResourceItem
            type: object
            properties:
              resourceCapacityDemand:
                title: ResourceCapacityDemand
                type: object
                properties:
                  resourceCapacityDemandAmount:
                    type: integer
                    format: int32
                  '@type':
                    type: string
                  resourcePool:
                    type: string
              appliedResourceCapacity:
                title: AppliedResourceCapacity
                type: object
                properties:
                  appliedCapacityAmount:
                    type: string
                  resource:
                    type: array
                    items:
                      title: ResponseResource
                      type: object
                      properties:
                        id:
                          type: string
                        href:
                          type: string
                        '@referredType':
                          $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
                        '@baseType':
                          type: string
                        value:
                          type: string
              subReservationState:
                type: string
    com_mtn_aggregator_models_availability_request_ResourceCharacteristic:
      title: ResourceCharacteristic
      type: object
      properties:
        code:
          type: string
        value:
          type: array
          items:
            type: string
    com_mtn_aggregator_models_unreserve_response_UnReserveResourceReservationItem:
      title: UnReserveResourceReservationItem
      type: object
      properties:
        quantity:
          type: integer
          format: int32
        items:
          type: array
          items:
            title: UnReserveItem
            type: object
            properties:
              resourceCapacityDemand:
                title: UnReserveResourceCapacityDemand
                type: object
                properties:
                  resourceCapacityDemandAmount:
                    type: integer
                    format: int32
              appliedResourceCapacity:
                title: UnReserveResourceCapacity
                type: object
                properties:
                  appliedCapacityAmount:
                    type: string
                  resource:
                    type: array
                    items:
                      title: UnReserveResource
                      type: object
                      properties:
                        id:
                          type: string
                        href:
                          type: string
                        value:
                          type: string
              subReservationState:
                type: string
    com_mtn_aggregator_models_unreserve_response_UnReserveResourceCapacity:
      title: UnReserveResourceCapacity
      type: object
      properties:
        appliedCapacityAmount:
          type: string
        resource:
          type: array
          items:
            title: UnReserveResource
            type: object
            properties:
              id:
                type: string
              href:
                type: string
              value:
                type: string
    com_mtn_aggregator_models_availability_request_ProductOffering:
      title: ProductOffering
      type: object
      properties:
        id:
          type: array
          items:
            type: string
        name:
          type: array
          items:
            type: string
    com_mtn_aggregator_models_availability_request_ResourcePool:
      title: ResourcePool
      type: object
      properties:
        id:
          type: array
          items:
            type: string
        name:
          type: array
          items:
            type: string
    com_mtn_aggregator_models_unreserve_request_UnReserveRequest:
      title: UnReserveRequest
      type: object
      properties:
        reservationState:
          type: string
    com_mtn_aggregator_models_reservation_response_ResponseResource:
      title: ResponseResource
      type: object
      properties:
        id:
          type: string
        href:
          type: string
        '@referredType':
          $ref: '#/components/schemas/com_mtn_aggregator_enums_ResourceType'
        '@baseType':
          type: string
        value:
          type: string
    com_mtn_aggregator_models_availability_request_DRMBusinessType:
      title: DRMBusinessType
      type: object
      properties:
        type:
          type: string
    com_mtn_aggregator_models_reservation_response_ResourceCapacityDemand:
      title: ResourceCapacityDemand
      type: object
      properties:
        resourceCapacityDemandAmount:
          type: integer
          format: int32
        '@type':
          type: string
        resourcePool:
          type: string
    com_mtn_aggregator_models_unreserve_response_UnReserveItem:
      title: UnReserveItem
      type: object
      properties:
        resourceCapacityDemand:
          title: UnReserveResourceCapacityDemand
          type: object
          properties:
            resourceCapacityDemandAmount:
              type: integer
              format: int32
        appliedResourceCapacity:
          title: UnReserveResourceCapacity
          type: object
          properties:
            appliedCapacityAmount:
              type: string
            resource:
              type: array
              items:
                title: UnReserveResource
                type: object
                properties:
                  id:
                    type: string
                  href:
                    type: string
                  value:
                    type: string
        subReservationState:
          type: string
  securitySchemes:
    OAuth2:
      type: oauth2
      flows:
        clientCredentials:
          tokenUrl: https://api.mtn.com/v1/oauth/access_token
          scopes: {}
    Bearer:
      type: http
      description: Bearer token received from OAuth2.0 authentication with the MADAPI
      scheme: bearer
      bearerFormat: JWT