openapi: 3.0.1
info:
  title: TMF652 Resource Ordering
  description: "Resource Ordering API is utilized for providing resource ordering\
    \ management capabilities to resource and data-seeking services. This service\
    \ implements TMF652 standards for resource ordering operations, enabling comprehensive\
    \ resource lifecycle management including resource provisioning, activation, modification,\
    \ and deactivation workflows across various service domains."
  license:
    name: MADAPI
    url: https://developers.mtn.com/
  version: 3.0.0 - Last updated date:2026-09-16 10:23:02
servers:
- url: https://api.mtn.com/v1
  description: Production Server
security:
- OAuth2: []
tags:
- name: TMF652 Resource Ordering
paths:
  /resourceOrder:
    get:
      tags:
      - TMF652 Resource Ordering
      summary: Lists or finds ResourceOrder entities
      description: This operation method is used for enabling the capabilities of
        listing or finding ResourceOrder entities from a system.
      operationId: TMF652ResourceOrdering_get_getResource_resourceOrder
      parameters:
      - name: customerId
        in: query
        required: false
        schema:
          type: string
      - name: fields
        in: query
        required: false
        schema:
          type: string
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          format: int32
      - name: orderType
        in: query
        required: false
        schema:
          type: string
      - name: status
        in: query
        required: false
        schema:
          type: string
      - name: transactionId
        in: header
        required: false
        schema:
          type: string
      - name: x-country-code
        in: header
        required: true
        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 TMF652
            Resource Ordering flows.
          content:
            application/json:
              schema:
                title: ResourceOrderResponse
                type: object
                properties:
                  orderType:
                    type: string
                  orderDate:
                    type: string
                  orderItem:
                    type: array
                    items:
                      $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
                  state:
                    type: string
                  relatedParty:
                    type: array
                    items:
                      $ref: '#/components/schemas/com_mtn_aggregator_models_request_RelatedParty'
                  completionDate:
                    type: string
                  requestedCompletionDate:
                    type: string
                  requestedStartDate:
                    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:
      - TMF652 Resource Ordering
      summary: Creates a ResourceOrder entity.
      description: This Post operation method is utilized for enabling the capabilities
        of creating a resource order entity in a system.
      operationId: TMF652ResourceOrdering_post_createResource_resourceOrder
      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: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              title: CreateResourceRequest
              type: object
              properties:
                category:
                  type: string
                completionDate:
                  type: string
                description:
                  type: string
                expectedCompletionDate:
                  type: string
                externalId:
                  type: string
                name:
                  type: string
                orderDate:
                  type: string
                orderType:
                  type: string
                priority:
                  type: integer
                  format: int32
                requestedCompletionDate:
                  type: string
                requestedStartDate:
                  type: string
                startDate:
                  type: string
                state:
                  type: string
                externalReference:
                  type: array
                  items:
                    title: ExternalReference
                    type: object
                    properties:
                      id:
                        type: string
                      name:
                        type: string
                      entityType:
                        type: string
                      owner:
                        type: string
                      baseType:
                        type: string
                      schemaLocation:
                        type: string
                      type:
                        type: string
                note:
                  type: array
                  items:
                    title: Note
                    type: object
                    properties:
                      id:
                        type: string
                      author:
                        type: string
                      date:
                        type: string
                      text:
                        type: string
                      baseType:
                        type: string
                      schemaLocation:
                        type: string
                      type:
                        type: string
                orderItem:
                  type: array
                  items:
                    title: OrderItem
                    type: object
                    properties:
                      resource:
                        title: Resource
                        type: object
                        properties:
                          id:
                            type: string
                          resourceCharacteristic:
                            type: array
                            items:
                              title: NameValue
                              type: object
                              properties:
                                name:
                                  type: string
                                value:
                                  type: string
                                type:
                                  type: string
                          relatedParty:
                            type: array
                            items:
                              title: RelatedParty
                              type: object
                              properties:
                                id:
                                  type: string
                                href:
                                  type: string
                                name:
                                  type: string
                                role:
                                  type: string
                                baseType:
                                  type: string
                                schemaLocation:
                                  type: string
                                type:
                                  type: string
                                '@referredType':
                                  type: string
                                geographicLocation:
                                  title: GeographicLocation
                                  type: object
                                  properties:
                                    spatialRef:
                                      type: string
                                    geometry:
                                      title: Geometry
                                      type: object
                                      properties:
                                        x:
                                          type: string
                                        "y":
                                          type: string
                                        z:
                                          type: string
                                description:
                                  type: string
                                contactMedium:
                                  type: array
                                  items:
                                    title: ContactMedium
                                    type: object
                                    properties:
                                      medium:
                                        title: Medium
                                        type: object
                                        properties:
                                          type:
                                            type: string
                                          number:
                                            type: string
                                          emailAddress:
                                            type: string
                                      type:
                                        type: string
                                      role:
                                        type: string
                                      id:
                                        type: string
                                      name:
                                        type: string
                                      preferred:
                                        type: boolean
                                engagedParty:
                                  title: EngagedParty
                                  type: object
                                  properties:
                                    id:
                                      type: string
                                    href:
                                      type: string
                                    '@referredType':
                                      type: string
                                    '@schemaLocation':
                                      type: string
                                location:
                                  type: string
                                validFor:
                                  type: string
                      id:
                        type: string
                      action:
                        type: string
                      quantity:
                        type: integer
                        format: int32
                      state:
                        type: string
                      appointment:
                        title: Appointment
                        type: object
                        properties:
                          id:
                            type: string
                          href:
                            type: string
                          description:
                            type: string
                          baseType:
                            type: string
                          schemaLocation:
                            type: string
                          type:
                            type: string
                          referredType:
                            type: string
                      orderItemRelationship:
                        type: array
                        items:
                          title: OrderItemRelationship
                          type: object
                          properties:
                            relationshipType:
                              type: string
                            orderItem:
                              $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
                            baseType:
                              type: string
                            schemaLocation:
                              type: string
                            type:
                              type: string
                      resourceSpecification:
                        title: ResourceSpecification
                        type: object
                        properties:
                          id:
                            type: string
                          href:
                            type: string
                          name:
                            type: string
                          version:
                            type: string
                          baseType:
                            type: string
                          schemaLocation:
                            type: string
                          type:
                            type: string
                          referredType:
                            type: string
                      baseType:
                        type: string
                      schemaLocation:
                        type: string
                      type:
                        type: string
                      itemId:
                        type: string
                      resourceOrderHref:
                        type: string
                      resourceOrderId:
                        type: string
                      referredType:
                        type: string
                      product:
                        title: Product
                        type: object
                        properties:
                          publicIdentifier:
                            type: string
                          characteristic:
                            type: array
                            items:
                              title: Characteristic
                              type: object
                              properties:
                                name:
                                  type: string
                                value:
                                  type: string
                                '@type':
                                  type: string
                          id:
                            type: string
                          startDate:
                            type: string
                          status:
                            type: string
                          activationDate:
                            type: string
                          imsiNumber:
                            type: string
                          simNumber:
                            type: string
                          state:
                            type: string
                          modifiable:
                            type: boolean
                          href:
                            type: string
                          name:
                            type: string
                          createdDate:
                            type: string
                          modifiedDate:
                            type: string
                          businessType:
                            type: string
                          technology:
                            type: string
                          isCustomerVisible:
                            type: boolean
                          LoB:
                            type: string
                          xDir:
                            type: string
                          '@baseType':
                            type: string
                          '@type':
                            type: string
                          '@schemaLocation':
                            type: string
                          '@referredType':
                            type: string
                          customFields:
                            type: string
                          billingAccount:
                            type: string
                          genericDetailsHolder:
                            type: string
                          _internal:
                            type: string
                          externalSystem:
                            type: string
                          productRelationship:
                            type: string
                          realizingResource:
                            type: string
                          channel:
                            type: array
                            items:
                              title: Channel
                              type: object
                              properties:
                                role:
                                  type: string
                                name:
                                  type: string
                                id:
                                  type: string
                                '@referredType':
                                  type: string
                                '@type':
                                  type: string
                                href:
                                  type: string
                                '@schemaLocation':
                                  type: string
                          relatedParty:
                            type: array
                            items:
                              $ref: '#/components/schemas/com_mtn_aggregator_models_request_RelatedParty'
                          productOrder:
                            type: string
                          place:
                            type: string
                          productPrice:
                            type: string
                          productTerm:
                            type: string
                          creditLimit:
                            type: string
                          suspensions:
                            type: string
                          productSpecification:
                            type: string
                          productOffering:
                            type: string
                          path:
                            type: string
                      orderItem:
                        type: array
                        items:
                          $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
                      actionSubType:
                        type: string
                      href:
                        type: string
                      customFields:
                        title: CustomFields
                        type: object
                        properties:
                          simChangeType:
                            type: string
                          ecwProfile:
                            type: string
                          ecwStatus:
                            type: string
                      productOffering:
                        type: string
                      itemTotalPrice:
                        type: string
                      transferDeposit:
                        type: boolean
                      modifiable:
                        type: boolean
                      path:
                        type: string
                      reservationId:
                        type: string
                relatedParty:
                  type: array
                  items:
                    $ref: '#/components/schemas/com_mtn_aggregator_models_request_RelatedParty'
                baseType:
                  type: string
                schemaLocation:
                  type: string
                type:
                  type: string
                reason:
                  type: string
                status:
                  type: string
                interactionItem:
                  type: array
                  items:
                    title: InteractionItem
                    type: object
                    properties:
                      item:
                        title: Item
                        type: object
                        properties:
                          id:
                            type: string
                          '@type':
                            type: string
                          '@baseType':
                            type: string
                          '@schemaLocation':
                            type: string
                          orderItem:
                            type: array
                            items:
                              $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
                          state:
                            type: string
                          orderDate:
                            type: string
                          completionDate:
                            type: string
                          requestedStartDate:
                            type: string
                          createdDate:
                            type: string
                          modifiedDate:
                            type: string
                          reminderDate:
                            type: string
                          documentDueDate:
                            type: string
                          request:
                            title: Request
                            type: object
                            properties:
                              id:
                                type: string
                              referredType:
                                type: string
                              baseType:
                                type: string
                          href:
                            type: string
                          path:
                            type: string
                          name:
                            type: string
                          startDate:
                            type: string
                          status:
                            type: string
                          businessType:
                            type: string
                          technology:
                            type: string
                          publicIdentifier:
                            type: string
                          activationDate:
                            type: string
                          imsiNumber:
                            type: string
                          simNumber:
                            type: string
                          lifecycleState:
                            type: string
                          isCustomerVisible:
                            type: boolean
                          LoB:
                            type: string
                          xDir:
                            type: string
                          customFields:
                            type: string
                          documentSpecification:
                            type: string
                          relatedEntity:
                            type: string
                          billingAccount:
                            type: string
                          genericDetailsHolder:
                            type: string
                          _internal:
                            type: string
                          externalSystem:
                            type: string
                          productRelationship:
                            type: string
                          productSpecification:
                            type: string
                          productOffering:
                            type: string
                          characteristic:
                            type: array
                            items:
                              $ref: '#/components/schemas/com_mtn_aggregator_models_request_Characteristic'
                          productOrder:
                            type: string
                          place:
                            type: string
                          productPrice:
                            type: string
                          productTerm:
                            type: string
                          creditLimit:
                            type: string
                          suspensions:
                            type: string
                          documentCharacteristic:
                            type: string
                          orderTotalPrice:
                            type: string
                          payment:
                            type: string
                          channel:
                            type: array
                            items:
                              $ref: '#/components/schemas/com_mtn_aggregator_models_request_Channel'
                          relatedParty:
                            type: array
                            items:
                              $ref: '#/components/schemas/com_mtn_aggregator_models_request_RelatedParty'
                          modifiable:
                            type: boolean
                          cancellable:
                            type: boolean
                channel:
                  type: array
                  items:
                    $ref: '#/components/schemas/com_mtn_aggregator_models_request_Channel'
        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 TMF652
            Resource Ordering flows.
          content:
            application/json:
              schema:
                title: CreateResourceResponse
                type: object
                properties:
                  id:
                    type: string
                  href:
                    type: string
                  category:
                    type: string
                  completionDate:
                    type: string
                  description:
                    type: string
                  expectedCompletionDate:
                    type: string
                  externalId:
                    type: string
                  name:
                    type: string
                  orderDate:
                    type: string
                  orderType:
                    type: string
                  priority:
                    type: integer
                    format: int32
                  requestedCompletionDate:
                    type: string
                  requestedStartDate:
                    type: string
                  startDate:
                    type: string
                  state:
                    type: string
                  externalReference:
                    type: array
                    items:
                      $ref: '#/components/schemas/com_mtn_aggregator_models_request_ExternalReference'
                  note:
                    type: array
                    items:
                      $ref: '#/components/schemas/com_mtn_aggregator_models_request_Note'
                  orderItem:
                    type: array
                    items:
                      $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
                  relatedParty:
                    type: array
                    items:
                      $ref: '#/components/schemas/com_mtn_aggregator_models_request_RelatedParty'
                  baseType:
                    type: string
                  schemaLocation:
                    type: string
                  type:
                    type: string
                  reason:
                    type: string
                  status:
                    type: string
                  interactionItem:
                    type: array
                    items:
                      title: InteractionItem
                      type: object
                      properties:
                        id:
                          type: string
                        itemDate:
                          type: string
                        item:
                          $ref: '#/components/schemas/com_mtn_aggregator_models_request_Item'
                        status:
                          type: string
                        statusChangeDate:
                          type: string
                        interactionItemRelationship:
                          type: string
                  channel:
                    type: array
                    items:
                      $ref: '#/components/schemas/com_mtn_aggregator_models_request_Channel'
                  modifiedDate:
                    type: string
                  createdDate:
                    type: string
                  interactionDate:
                    title: InteractionDate
                    type: object
                    properties:
                      startDateTime:
                        type: string
                      endDateTime:
                        type: string
                  direction:
                    type: string
                  productId:
                    type: array
                    items:
                      type: string
                  publicIdentifier:
                    type: array
                    items:
                      type: string
                  path:
                    type: string
                  retryable:
                    type: boolean
                  customFields:
                    $ref: '#/components/schemas/com_mtn_aggregator_models_response_CustomFields'
                  _internal:
                    type: string
                  version:
                    type: integer
                    format: int32
                  retryableCount:
                    type: integer
                    format: int32
        "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
  /resourceOrder/{id}:
    get:
      tags:
      - TMF652 Resource Ordering
      summary: Retrieves resource order details
      description: This operation enables the capabilities of retrieving resource
        order details by using id(unique identifier). Attribute selection is enabled
        for all first level attributes
      operationId: TMF652ResourceOrdering_get_getResourceByID_resourceOrderid
      parameters:
      - name: fields
        in: query
        required: false
        schema:
          type: string
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: orderType
        in: query
        required: false
        schema:
          type: string
      - name: status
        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: true
        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 TMF652
            Resource Ordering flows.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com_mtn_aggregator_models_response_resourceOrder_ResourceOrderResponse'
        "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
    patch:
      tags:
      - TMF652 Resource Ordering
      summary: Updates a ResourceOrder entity.
      description: This operation method is utilized for enabling the capabilities
        of partially updating a resource order entity in a system.
      operationId: TMF652ResourceOrdering_patch_updateResource_resourceOrderid
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - name: targetSystem
        in: header
        required: false
        schema:
          type: string
      - name: transactionId
        in: header
        required: true
        schema:
          type: string
      - name: x-country-code
        in: header
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              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 TMF652
            Resource Ordering flows.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/com_mtn_aggregator_models_response_createResource_CreateResourceResponse'
        "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_request_Geometry:
      title: Geometry
      type: object
      properties:
        x:
          type: string
        "y":
          type: string
        z:
          type: string
    com_mtn_aggregator_models_request_ResourceSpecification:
      title: ResourceSpecification
      type: object
      properties:
        id:
          type: string
        href:
          type: string
        name:
          type: string
        version:
          type: string
        baseType:
          type: string
        schemaLocation:
          type: string
        type:
          type: string
        referredType:
          type: string
    com_mtn_aggregator_models_response_NameValue:
      title: NameValue
      type: object
      properties:
        name:
          type: string
        value:
          type: string
        type:
          type: string
    com_mtn_aggregator_models_request_Note:
      title: Note
      type: object
      properties:
        id:
          type: string
        author:
          type: string
        date:
          type: string
        text:
          type: string
        baseType:
          type: string
        schemaLocation:
          type: string
        type:
          type: string
    com_mtn_aggregator_models_response_OrderItem:
      title: OrderItem
      type: object
      properties:
        resource:
          title: Resource
          type: object
          properties:
            id:
              type: string
            resourceCharacteristic:
              type: array
              items:
                title: NameValue
                type: object
                properties:
                  name:
                    type: string
                  value:
                    type: string
                  type:
                    type: string
            relatedParty:
              type: array
              items:
                title: RelatedParty
                type: object
                properties:
                  id:
                    type: string
                  href:
                    type: string
                  name:
                    type: string
                  role:
                    type: string
                  baseType:
                    type: string
                  schemaLocation:
                    type: string
                  type:
                    type: string
                  '@referredType':
                    type: string
                  geographicLocation:
                    title: GeographicLocation
                    type: object
                    properties:
                      spatialRef:
                        type: string
                      geometry:
                        title: Geometry
                        type: object
                        properties:
                          x:
                            type: string
                          "y":
                            type: string
                          z:
                            type: string
                  description:
                    type: string
                  contactMedium:
                    type: array
                    items:
                      title: ContactMedium
                      type: object
                      properties:
                        medium:
                          title: Medium
                          type: object
                          properties:
                            type:
                              type: string
                            number:
                              type: string
                            emailAddress:
                              type: string
                        type:
                          type: string
                        role:
                          type: string
                        id:
                          type: string
                        name:
                          type: string
                        preferred:
                          type: boolean
                  engagedParty:
                    title: EngagedParty
                    type: object
                    properties:
                      id:
                        type: string
                      href:
                        type: string
                      '@referredType':
                        type: string
                      '@schemaLocation':
                        type: string
                  location:
                    type: string
                  validFor:
                    type: string
        id:
          type: string
        action:
          type: string
        quantity:
          type: integer
          format: int32
        state:
          type: string
        appointment:
          title: Appointment
          type: object
          properties:
            id:
              type: string
            href:
              type: string
            description:
              type: string
            baseType:
              type: string
            schemaLocation:
              type: string
            type:
              type: string
            referredType:
              type: string
        orderItemRelationship:
          type: array
          items:
            title: OrderItemRelationship
            type: object
            properties:
              relationshipType:
                type: string
              orderItem:
                $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
              baseType:
                type: string
              schemaLocation:
                type: string
              type:
                type: string
        resourceSpecification:
          title: ResourceSpecification
          type: object
          properties:
            id:
              type: string
            href:
              type: string
            name:
              type: string
            version:
              type: string
            baseType:
              type: string
            schemaLocation:
              type: string
            type:
              type: string
            referredType:
              type: string
        baseType:
          type: string
        schemaLocation:
          type: string
        type:
          type: string
        itemId:
          type: string
        resourceOrderHref:
          type: string
        resourceOrderId:
          type: string
        referredType:
          type: string
        product:
          title: Product
          type: object
          properties:
            publicIdentifier:
              type: string
            characteristic:
              type: array
              items:
                title: Characteristic
                type: object
                properties:
                  name:
                    type: string
                  value:
                    type: string
                  '@type':
                    type: string
            id:
              type: string
            startDate:
              type: string
            status:
              type: string
            activationDate:
              type: string
            imsiNumber:
              type: string
            simNumber:
              type: string
            state:
              type: string
            modifiable:
              type: boolean
            href:
              type: string
            name:
              type: string
            createdDate:
              type: string
            modifiedDate:
              type: string
            businessType:
              type: string
            technology:
              type: string
            isCustomerVisible:
              type: boolean
            LoB:
              type: string
            xDir:
              type: string
            '@baseType':
              type: string
            '@type':
              type: string
            '@schemaLocation':
              type: string
            '@referredType':
              type: string
            customFields:
              type: string
            billingAccount:
              type: string
            genericDetailsHolder:
              type: string
            _internal:
              type: string
            externalSystem:
              type: string
            productRelationship:
              type: string
            realizingResource:
              type: string
            channel:
              type: array
              items:
                title: Channel
                type: object
                properties:
                  role:
                    type: string
                  name:
                    type: string
                  id:
                    type: string
                  '@referredType':
                    type: string
                  '@type':
                    type: string
                  href:
                    type: string
                  '@schemaLocation':
                    type: string
            relatedParty:
              type: array
              items:
                $ref: '#/components/schemas/com_mtn_aggregator_models_request_RelatedParty'
            productOrder:
              type: string
            place:
              type: string
            productPrice:
              type: string
            productTerm:
              type: string
            creditLimit:
              type: string
            suspensions:
              type: string
            productSpecification:
              type: string
            productOffering:
              type: string
            path:
              type: string
        orderItem:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
        actionSubType:
          type: string
        href:
          type: string
        customFields:
          title: CustomFields
          type: object
          properties:
            simChangeType:
              type: string
            ecwProfile:
              type: string
            ecwStatus:
              type: string
        productOffering:
          type: string
        itemTotalPrice:
          type: string
        transferDeposit:
          type: boolean
        modifiable:
          type: boolean
        path:
          type: string
        reservationId:
          type: string
    com_mtn_aggregator_models_response_createResource_InteractionItem:
      title: InteractionItem
      type: object
      properties:
        id:
          type: string
        itemDate:
          type: string
        item:
          $ref: '#/components/schemas/com_mtn_aggregator_models_request_Item'
        status:
          type: string
        statusChangeDate:
          type: string
        interactionItemRelationship:
          type: string
    com_mtn_aggregator_models_request_EngagedParty:
      title: EngagedParty
      type: object
      properties:
        id:
          type: string
        href:
          type: string
        '@referredType':
          type: string
        '@schemaLocation':
          type: string
    com_mtn_aggregator_models_response_CustomFields:
      title: CustomFields
      type: object
      properties:
        simChangeType:
          type: string
        ecwProfile:
          type: string
        ecwStatus:
          type: string
    com_mtn_aggregator_models_request_ExternalReference:
      title: ExternalReference
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        entityType:
          type: string
        owner:
          type: string
        baseType:
          type: string
        schemaLocation:
          type: string
        type:
          type: string
    com_mtn_aggregator_models_request_Request:
      title: Request
      type: object
      properties:
        id:
          type: string
        referredType:
          type: string
        baseType:
          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_request_ContactMedium:
      title: ContactMedium
      type: object
      properties:
        medium:
          title: Medium
          type: object
          properties:
            type:
              type: string
            number:
              type: string
            emailAddress:
              type: string
        type:
          type: string
        role:
          type: string
        id:
          type: string
        name:
          type: string
        preferred:
          type: boolean
    com_mtn_aggregator_models_request_Medium:
      title: Medium
      type: object
      properties:
        type:
          type: string
        number:
          type: string
        emailAddress:
          type: string
    com_mtn_aggregator_models_request_Product:
      title: Product
      type: object
      properties:
        publicIdentifier:
          type: string
        characteristic:
          type: array
          items:
            title: Characteristic
            type: object
            properties:
              name:
                type: string
              value:
                type: string
              '@type':
                type: string
        id:
          type: string
        startDate:
          type: string
        status:
          type: string
        activationDate:
          type: string
        imsiNumber:
          type: string
        simNumber:
          type: string
        state:
          type: string
        modifiable:
          type: boolean
        href:
          type: string
        name:
          type: string
        createdDate:
          type: string
        modifiedDate:
          type: string
        businessType:
          type: string
        technology:
          type: string
        isCustomerVisible:
          type: boolean
        LoB:
          type: string
        xDir:
          type: string
        '@baseType':
          type: string
        '@type':
          type: string
        '@schemaLocation':
          type: string
        '@referredType':
          type: string
        customFields:
          type: string
        billingAccount:
          type: string
        genericDetailsHolder:
          type: string
        _internal:
          type: string
        externalSystem:
          type: string
        productRelationship:
          type: string
        realizingResource:
          type: string
        channel:
          type: array
          items:
            title: Channel
            type: object
            properties:
              role:
                type: string
              name:
                type: string
              id:
                type: string
              '@referredType':
                type: string
              '@type':
                type: string
              href:
                type: string
              '@schemaLocation':
                type: string
        relatedParty:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_request_RelatedParty'
        productOrder:
          type: string
        place:
          type: string
        productPrice:
          type: string
        productTerm:
          type: string
        creditLimit:
          type: string
        suspensions:
          type: string
        productSpecification:
          type: string
        productOffering:
          type: string
        path:
          type: string
    com_mtn_aggregator_models_request_Appointment:
      title: Appointment
      type: object
      properties:
        id:
          type: string
        href:
          type: string
        description:
          type: string
        baseType:
          type: string
        schemaLocation:
          type: string
        type:
          type: string
        referredType:
          type: string
    com_mtn_aggregator_models_request_InteractionItem:
      title: InteractionItem
      type: object
      properties:
        item:
          title: Item
          type: object
          properties:
            id:
              type: string
            '@type':
              type: string
            '@baseType':
              type: string
            '@schemaLocation':
              type: string
            orderItem:
              type: array
              items:
                $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
            state:
              type: string
            orderDate:
              type: string
            completionDate:
              type: string
            requestedStartDate:
              type: string
            createdDate:
              type: string
            modifiedDate:
              type: string
            reminderDate:
              type: string
            documentDueDate:
              type: string
            request:
              title: Request
              type: object
              properties:
                id:
                  type: string
                referredType:
                  type: string
                baseType:
                  type: string
            href:
              type: string
            path:
              type: string
            name:
              type: string
            startDate:
              type: string
            status:
              type: string
            businessType:
              type: string
            technology:
              type: string
            publicIdentifier:
              type: string
            activationDate:
              type: string
            imsiNumber:
              type: string
            simNumber:
              type: string
            lifecycleState:
              type: string
            isCustomerVisible:
              type: boolean
            LoB:
              type: string
            xDir:
              type: string
            customFields:
              type: string
            documentSpecification:
              type: string
            relatedEntity:
              type: string
            billingAccount:
              type: string
            genericDetailsHolder:
              type: string
            _internal:
              type: string
            externalSystem:
              type: string
            productRelationship:
              type: string
            productSpecification:
              type: string
            productOffering:
              type: string
            characteristic:
              type: array
              items:
                $ref: '#/components/schemas/com_mtn_aggregator_models_request_Characteristic'
            productOrder:
              type: string
            place:
              type: string
            productPrice:
              type: string
            productTerm:
              type: string
            creditLimit:
              type: string
            suspensions:
              type: string
            documentCharacteristic:
              type: string
            orderTotalPrice:
              type: string
            payment:
              type: string
            channel:
              type: array
              items:
                $ref: '#/components/schemas/com_mtn_aggregator_models_request_Channel'
            relatedParty:
              type: array
              items:
                $ref: '#/components/schemas/com_mtn_aggregator_models_request_RelatedParty'
            modifiable:
              type: boolean
            cancellable:
              type: boolean
    com_mtn_aggregator_models_request_Characteristic:
      title: Characteristic
      type: object
      properties:
        name:
          type: string
        value:
          type: string
        '@type':
          type: string
    com_mtn_aggregator_models_response_resourceOrder_ResourceOrderResponse:
      title: ResourceOrderResponse
      type: object
      properties:
        orderType:
          type: string
        orderDate:
          type: string
        orderItem:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
        state:
          type: string
        relatedParty:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_request_RelatedParty'
        completionDate:
          type: string
        requestedCompletionDate:
          type: string
        requestedStartDate:
          type: string
    com_mtn_aggregator_models_response_Resource:
      title: Resource
      type: object
      properties:
        id:
          type: string
        resourceCharacteristic:
          type: array
          items:
            title: NameValue
            type: object
            properties:
              name:
                type: string
              value:
                type: string
              type:
                type: string
        relatedParty:
          type: array
          items:
            title: RelatedParty
            type: object
            properties:
              id:
                type: string
              href:
                type: string
              name:
                type: string
              role:
                type: string
              baseType:
                type: string
              schemaLocation:
                type: string
              type:
                type: string
              '@referredType':
                type: string
              geographicLocation:
                title: GeographicLocation
                type: object
                properties:
                  spatialRef:
                    type: string
                  geometry:
                    title: Geometry
                    type: object
                    properties:
                      x:
                        type: string
                      "y":
                        type: string
                      z:
                        type: string
              description:
                type: string
              contactMedium:
                type: array
                items:
                  title: ContactMedium
                  type: object
                  properties:
                    medium:
                      title: Medium
                      type: object
                      properties:
                        type:
                          type: string
                        number:
                          type: string
                        emailAddress:
                          type: string
                    type:
                      type: string
                    role:
                      type: string
                    id:
                      type: string
                    name:
                      type: string
                    preferred:
                      type: boolean
              engagedParty:
                title: EngagedParty
                type: object
                properties:
                  id:
                    type: string
                  href:
                    type: string
                  '@referredType':
                    type: string
                  '@schemaLocation':
                    type: string
              location:
                type: string
              validFor:
                type: string
    com_mtn_aggregator_models_response_createResource_CreateResourceResponse:
      title: CreateResourceResponse
      type: object
      properties:
        id:
          type: string
        href:
          type: string
        category:
          type: string
        completionDate:
          type: string
        description:
          type: string
        expectedCompletionDate:
          type: string
        externalId:
          type: string
        name:
          type: string
        orderDate:
          type: string
        orderType:
          type: string
        priority:
          type: integer
          format: int32
        requestedCompletionDate:
          type: string
        requestedStartDate:
          type: string
        startDate:
          type: string
        state:
          type: string
        externalReference:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_request_ExternalReference'
        note:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_request_Note'
        orderItem:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
        relatedParty:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_request_RelatedParty'
        baseType:
          type: string
        schemaLocation:
          type: string
        type:
          type: string
        reason:
          type: string
        status:
          type: string
        interactionItem:
          type: array
          items:
            title: InteractionItem
            type: object
            properties:
              id:
                type: string
              itemDate:
                type: string
              item:
                $ref: '#/components/schemas/com_mtn_aggregator_models_request_Item'
              status:
                type: string
              statusChangeDate:
                type: string
              interactionItemRelationship:
                type: string
        channel:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_request_Channel'
        modifiedDate:
          type: string
        createdDate:
          type: string
        interactionDate:
          title: InteractionDate
          type: object
          properties:
            startDateTime:
              type: string
            endDateTime:
              type: string
        direction:
          type: string
        productId:
          type: array
          items:
            type: string
        publicIdentifier:
          type: array
          items:
            type: string
        path:
          type: string
        retryable:
          type: boolean
        customFields:
          $ref: '#/components/schemas/com_mtn_aggregator_models_response_CustomFields'
        _internal:
          type: string
        version:
          type: integer
          format: int32
        retryableCount:
          type: integer
          format: int32
    com_mtn_aggregator_models_request_OrderItemRelationship:
      title: OrderItemRelationship
      type: object
      properties:
        relationshipType:
          type: string
        orderItem:
          $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
        baseType:
          type: string
        schemaLocation:
          type: string
        type:
          type: string
    com_mtn_aggregator_models_request_Channel:
      title: Channel
      type: object
      properties:
        role:
          type: string
        name:
          type: string
        id:
          type: string
        '@referredType':
          type: string
        '@type':
          type: string
        href:
          type: string
        '@schemaLocation':
          type: string
    com_mtn_aggregator_models_request_RelatedParty:
      title: RelatedParty
      type: object
      properties:
        id:
          type: string
        href:
          type: string
        name:
          type: string
        role:
          type: string
        baseType:
          type: string
        schemaLocation:
          type: string
        type:
          type: string
        '@referredType':
          type: string
        geographicLocation:
          title: GeographicLocation
          type: object
          properties:
            spatialRef:
              type: string
            geometry:
              title: Geometry
              type: object
              properties:
                x:
                  type: string
                "y":
                  type: string
                z:
                  type: string
        description:
          type: string
        contactMedium:
          type: array
          items:
            title: ContactMedium
            type: object
            properties:
              medium:
                title: Medium
                type: object
                properties:
                  type:
                    type: string
                  number:
                    type: string
                  emailAddress:
                    type: string
              type:
                type: string
              role:
                type: string
              id:
                type: string
              name:
                type: string
              preferred:
                type: boolean
        engagedParty:
          title: EngagedParty
          type: object
          properties:
            id:
              type: string
            href:
              type: string
            '@referredType':
              type: string
            '@schemaLocation':
              type: string
        location:
          type: string
        validFor:
          type: string
    com_mtn_aggregator_models_request_CreateResourceRequest:
      title: CreateResourceRequest
      type: object
      properties:
        category:
          type: string
        completionDate:
          type: string
        description:
          type: string
        expectedCompletionDate:
          type: string
        externalId:
          type: string
        name:
          type: string
        orderDate:
          type: string
        orderType:
          type: string
        priority:
          type: integer
          format: int32
        requestedCompletionDate:
          type: string
        requestedStartDate:
          type: string
        startDate:
          type: string
        state:
          type: string
        externalReference:
          type: array
          items:
            title: ExternalReference
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              entityType:
                type: string
              owner:
                type: string
              baseType:
                type: string
              schemaLocation:
                type: string
              type:
                type: string
        note:
          type: array
          items:
            title: Note
            type: object
            properties:
              id:
                type: string
              author:
                type: string
              date:
                type: string
              text:
                type: string
              baseType:
                type: string
              schemaLocation:
                type: string
              type:
                type: string
        orderItem:
          type: array
          items:
            title: OrderItem
            type: object
            properties:
              resource:
                title: Resource
                type: object
                properties:
                  id:
                    type: string
                  resourceCharacteristic:
                    type: array
                    items:
                      title: NameValue
                      type: object
                      properties:
                        name:
                          type: string
                        value:
                          type: string
                        type:
                          type: string
                  relatedParty:
                    type: array
                    items:
                      title: RelatedParty
                      type: object
                      properties:
                        id:
                          type: string
                        href:
                          type: string
                        name:
                          type: string
                        role:
                          type: string
                        baseType:
                          type: string
                        schemaLocation:
                          type: string
                        type:
                          type: string
                        '@referredType':
                          type: string
                        geographicLocation:
                          title: GeographicLocation
                          type: object
                          properties:
                            spatialRef:
                              type: string
                            geometry:
                              title: Geometry
                              type: object
                              properties:
                                x:
                                  type: string
                                "y":
                                  type: string
                                z:
                                  type: string
                        description:
                          type: string
                        contactMedium:
                          type: array
                          items:
                            title: ContactMedium
                            type: object
                            properties:
                              medium:
                                title: Medium
                                type: object
                                properties:
                                  type:
                                    type: string
                                  number:
                                    type: string
                                  emailAddress:
                                    type: string
                              type:
                                type: string
                              role:
                                type: string
                              id:
                                type: string
                              name:
                                type: string
                              preferred:
                                type: boolean
                        engagedParty:
                          title: EngagedParty
                          type: object
                          properties:
                            id:
                              type: string
                            href:
                              type: string
                            '@referredType':
                              type: string
                            '@schemaLocation':
                              type: string
                        location:
                          type: string
                        validFor:
                          type: string
              id:
                type: string
              action:
                type: string
              quantity:
                type: integer
                format: int32
              state:
                type: string
              appointment:
                title: Appointment
                type: object
                properties:
                  id:
                    type: string
                  href:
                    type: string
                  description:
                    type: string
                  baseType:
                    type: string
                  schemaLocation:
                    type: string
                  type:
                    type: string
                  referredType:
                    type: string
              orderItemRelationship:
                type: array
                items:
                  title: OrderItemRelationship
                  type: object
                  properties:
                    relationshipType:
                      type: string
                    orderItem:
                      $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
                    baseType:
                      type: string
                    schemaLocation:
                      type: string
                    type:
                      type: string
              resourceSpecification:
                title: ResourceSpecification
                type: object
                properties:
                  id:
                    type: string
                  href:
                    type: string
                  name:
                    type: string
                  version:
                    type: string
                  baseType:
                    type: string
                  schemaLocation:
                    type: string
                  type:
                    type: string
                  referredType:
                    type: string
              baseType:
                type: string
              schemaLocation:
                type: string
              type:
                type: string
              itemId:
                type: string
              resourceOrderHref:
                type: string
              resourceOrderId:
                type: string
              referredType:
                type: string
              product:
                title: Product
                type: object
                properties:
                  publicIdentifier:
                    type: string
                  characteristic:
                    type: array
                    items:
                      title: Characteristic
                      type: object
                      properties:
                        name:
                          type: string
                        value:
                          type: string
                        '@type':
                          type: string
                  id:
                    type: string
                  startDate:
                    type: string
                  status:
                    type: string
                  activationDate:
                    type: string
                  imsiNumber:
                    type: string
                  simNumber:
                    type: string
                  state:
                    type: string
                  modifiable:
                    type: boolean
                  href:
                    type: string
                  name:
                    type: string
                  createdDate:
                    type: string
                  modifiedDate:
                    type: string
                  businessType:
                    type: string
                  technology:
                    type: string
                  isCustomerVisible:
                    type: boolean
                  LoB:
                    type: string
                  xDir:
                    type: string
                  '@baseType':
                    type: string
                  '@type':
                    type: string
                  '@schemaLocation':
                    type: string
                  '@referredType':
                    type: string
                  customFields:
                    type: string
                  billingAccount:
                    type: string
                  genericDetailsHolder:
                    type: string
                  _internal:
                    type: string
                  externalSystem:
                    type: string
                  productRelationship:
                    type: string
                  realizingResource:
                    type: string
                  channel:
                    type: array
                    items:
                      title: Channel
                      type: object
                      properties:
                        role:
                          type: string
                        name:
                          type: string
                        id:
                          type: string
                        '@referredType':
                          type: string
                        '@type':
                          type: string
                        href:
                          type: string
                        '@schemaLocation':
                          type: string
                  relatedParty:
                    type: array
                    items:
                      $ref: '#/components/schemas/com_mtn_aggregator_models_request_RelatedParty'
                  productOrder:
                    type: string
                  place:
                    type: string
                  productPrice:
                    type: string
                  productTerm:
                    type: string
                  creditLimit:
                    type: string
                  suspensions:
                    type: string
                  productSpecification:
                    type: string
                  productOffering:
                    type: string
                  path:
                    type: string
              orderItem:
                type: array
                items:
                  $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
              actionSubType:
                type: string
              href:
                type: string
              customFields:
                title: CustomFields
                type: object
                properties:
                  simChangeType:
                    type: string
                  ecwProfile:
                    type: string
                  ecwStatus:
                    type: string
              productOffering:
                type: string
              itemTotalPrice:
                type: string
              transferDeposit:
                type: boolean
              modifiable:
                type: boolean
              path:
                type: string
              reservationId:
                type: string
        relatedParty:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_request_RelatedParty'
        baseType:
          type: string
        schemaLocation:
          type: string
        type:
          type: string
        reason:
          type: string
        status:
          type: string
        interactionItem:
          type: array
          items:
            title: InteractionItem
            type: object
            properties:
              item:
                title: Item
                type: object
                properties:
                  id:
                    type: string
                  '@type':
                    type: string
                  '@baseType':
                    type: string
                  '@schemaLocation':
                    type: string
                  orderItem:
                    type: array
                    items:
                      $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
                  state:
                    type: string
                  orderDate:
                    type: string
                  completionDate:
                    type: string
                  requestedStartDate:
                    type: string
                  createdDate:
                    type: string
                  modifiedDate:
                    type: string
                  reminderDate:
                    type: string
                  documentDueDate:
                    type: string
                  request:
                    title: Request
                    type: object
                    properties:
                      id:
                        type: string
                      referredType:
                        type: string
                      baseType:
                        type: string
                  href:
                    type: string
                  path:
                    type: string
                  name:
                    type: string
                  startDate:
                    type: string
                  status:
                    type: string
                  businessType:
                    type: string
                  technology:
                    type: string
                  publicIdentifier:
                    type: string
                  activationDate:
                    type: string
                  imsiNumber:
                    type: string
                  simNumber:
                    type: string
                  lifecycleState:
                    type: string
                  isCustomerVisible:
                    type: boolean
                  LoB:
                    type: string
                  xDir:
                    type: string
                  customFields:
                    type: string
                  documentSpecification:
                    type: string
                  relatedEntity:
                    type: string
                  billingAccount:
                    type: string
                  genericDetailsHolder:
                    type: string
                  _internal:
                    type: string
                  externalSystem:
                    type: string
                  productRelationship:
                    type: string
                  productSpecification:
                    type: string
                  productOffering:
                    type: string
                  characteristic:
                    type: array
                    items:
                      $ref: '#/components/schemas/com_mtn_aggregator_models_request_Characteristic'
                  productOrder:
                    type: string
                  place:
                    type: string
                  productPrice:
                    type: string
                  productTerm:
                    type: string
                  creditLimit:
                    type: string
                  suspensions:
                    type: string
                  documentCharacteristic:
                    type: string
                  orderTotalPrice:
                    type: string
                  payment:
                    type: string
                  channel:
                    type: array
                    items:
                      $ref: '#/components/schemas/com_mtn_aggregator_models_request_Channel'
                  relatedParty:
                    type: array
                    items:
                      $ref: '#/components/schemas/com_mtn_aggregator_models_request_RelatedParty'
                  modifiable:
                    type: boolean
                  cancellable:
                    type: boolean
        channel:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_request_Channel'
    com_mtn_aggregator_models_request_Item:
      title: Item
      type: object
      properties:
        id:
          type: string
        '@type':
          type: string
        '@baseType':
          type: string
        '@schemaLocation':
          type: string
        orderItem:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_response_OrderItem'
        state:
          type: string
        orderDate:
          type: string
        completionDate:
          type: string
        requestedStartDate:
          type: string
        createdDate:
          type: string
        modifiedDate:
          type: string
        reminderDate:
          type: string
        documentDueDate:
          type: string
        request:
          title: Request
          type: object
          properties:
            id:
              type: string
            referredType:
              type: string
            baseType:
              type: string
        href:
          type: string
        path:
          type: string
        name:
          type: string
        startDate:
          type: string
        status:
          type: string
        businessType:
          type: string
        technology:
          type: string
        publicIdentifier:
          type: string
        activationDate:
          type: string
        imsiNumber:
          type: string
        simNumber:
          type: string
        lifecycleState:
          type: string
        isCustomerVisible:
          type: boolean
        LoB:
          type: string
        xDir:
          type: string
        customFields:
          type: string
        documentSpecification:
          type: string
        relatedEntity:
          type: string
        billingAccount:
          type: string
        genericDetailsHolder:
          type: string
        _internal:
          type: string
        externalSystem:
          type: string
        productRelationship:
          type: string
        productSpecification:
          type: string
        productOffering:
          type: string
        characteristic:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_request_Characteristic'
        productOrder:
          type: string
        place:
          type: string
        productPrice:
          type: string
        productTerm:
          type: string
        creditLimit:
          type: string
        suspensions:
          type: string
        documentCharacteristic:
          type: string
        orderTotalPrice:
          type: string
        payment:
          type: string
        channel:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_request_Channel'
        relatedParty:
          type: array
          items:
            $ref: '#/components/schemas/com_mtn_aggregator_models_request_RelatedParty'
        modifiable:
          type: boolean
        cancellable:
          type: boolean
    com_mtn_aggregator_models_request_GeographicLocation:
      title: GeographicLocation
      type: object
      properties:
        spatialRef:
          type: string
        geometry:
          title: Geometry
          type: object
          properties:
            x:
              type: string
            "y":
              type: string
            z:
              type: string
    com_mtn_aggregator_models_response_createResource_InteractionDate:
      title: InteractionDate
      type: object
      properties:
        startDateTime:
          type: string
        endDateTime:
          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