-- YAML module extracted from ITU-T M.3164.3 (10/2025)

openapi: 3.0.0
info:
  title: Interface Operations provided by TSMS
  description: This is the formal Definitions of the REST-based interface operations provided by TSMS
  termsOfService: https://www.itu.int/en/ITU-T/about/Pages/default.aspx
  contact:
   email: zhangzmx8848@gmail.com
  license:
   name: Apache 2.0
   url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
tags:
  - name: PatrolTask-TSMS
  - name: OnsiteOverhaul-TSMS
  - name: OnsiteTroubleShooting-TSMS
  - name: ServiceActivation-TSMS

paths:
  /OnsitePatrolInfo_C={patrolInfoID}/OnsitePatrolTask_C={taskID}/findSmartIDData:
    parameters: 
    - $ref: ''#/components/parameters/patrolInfoID''
    - $ref: ''#/components/parameters/taskID''
    - $ref: ''#/components/parameters/SMAT_ID''
    
    get:
      tags:
        - PatrolTask-TSMS
      summary: get smart identification data of the patrol information from the TSMS
      operationId: findSmartIDData
      responses:
        200:
          description: "The smart identification data is successfully returned from the TSMS"
          content:
            application/json:
              schema:
                type: object
                properties:
                  opStatus:
                    $ref: ''#/components/schemas/OpStatusType''
                  smartIdentificationData:
                    type: array
                    items:
                      $ref: ''#/components/schemas/ObjectImageListType''         
        400:
          description: "Input parameters invalid"
          content: {}
        404:
          description: "Patrol info ID or SMAT ID cannot be found in the TSMS"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/InfoNotExist''
        500:
          description: "Internal Server Error"
          content: {}
          
  /OnsitePatrolInfo_C={patrolInfoID}/OnsitePatrolTask_C={taskID}/OnsitePatrolRecord_C:
    parameters: 
    - $ref: ''#/components/parameters/patrolInfoID''
    - $ref: ''#/components/parameters/taskID''
    
    post:
      tags:
        - PatrolTask-TSMS
      summary: upload a patrol record to the TSMS
      operationId: uploadPatrolRecord
      requestBody:
        description: the content of patrol record needs to be uploaded to the TSMS   
        content:
          application/json:
            schema:
              type: object  
              properties:
                SMAT_ID:
                  type: string
                patrolRecord:
                  type: array
                  items:
                    $ref: ''M.3164.3-Common.yaml#/components/schemas/OnsitePatrolRecord_C''
        required: true        
      responses:
        200:
          description: "The patrol record information is successfully received by the TSMS"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/OpStatusType''
        400:
          description: "Input parameters invalid"
          content: {}
        404:
          description: "patrol Info ID or SMAT ID cannot be found in the TSMS"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/InfoNotExist''
        500:
          description: "Internal Server Error"
          content: {}
          
  /OnsiteOverhaulInfo_C={overhaulInfoID}/OnsiteOverhaulTask_C={taskID}/uploadOverhaulProcessRecord:
    parameters:    
    - $ref: ''#/components/parameters/overhaulInfoID''
    - $ref: ''#/components/parameters/taskID''
    
    post:
      tags:
        - OnsiteOverhaul-TSMS
      summary: upload an overhaul process record to the TSMS
      operationId: uploadOverhaulProcessRecord
      requestBody:
        description: the content of the overhaul process record needs to be uploaded to the TSMS
        content:
          application/json:
            schema:
              type: object  
              properties:
                SMAT_ID:
                  type: string
                overhaulExecutor:
                  type: string
                status:
                  type: string
                  enum:
                    - normal
                    - abnormal
                    - notCheck
                timeInfo:
                  type: string
                orderID:  
                  type: string        
                recordInfo:  
                  type: string
        required: true            
      responses:
        200:
          description: "The overhaul process record information is successfully received by the TSMS"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/OpStatusType''
        400:
          description: "Input parameters invalid"
          content: {}
        404:
          description: "overhaul info ID or SMAT ID cannot be found in the TSMS"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/InfoNotExist''
        500:
          description: "Internal Server Error"
          content: {}

  /OnsiteOverhaulInfo_C={overhaulInfoID}/OnsiteOverhaulTask_C={taskID}/requestForRemoteAssistance:
    parameters: 
    - $ref: ''#/components/parameters/overhaulInfoID''
    - $ref: ''#/components/parameters/taskID''
    - $ref: ''#/components/parameters/SMAT_ID''
    - $ref: ''#/components/parameters/requestDes''
    
    get:
      tags:
        - OnsiteOverhaul-TSMS
      summary: request remote assistance from the TSMS for an overhaul task
      operationId: requestForOverhaulRemoteAssis
      responses:
        200:
          description: "The remote assistance information is successfully received by the TSMS"
          content:
            application/json:
              schema:
                type: object
                properties:
                  opStatus:
                    $ref: ''#/components/schemas/OpStatusType''
                  expertInfoList:
                    type: array
                    items:
                      $ref: ''M.3164.3-Common.yaml#/components/schemas/Expert_C''
                  assistanceLink:
                    type: string
        400:
          description: "Input parameters invalid"
          content: {}
        404:
          description: "overhaul info ID or SMAT ID cannot be found in the TSMS"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/InfoNotExist''
        500:
          description: "Internal Server Error"
          content: {}

  /OnsiteTroubleShootingInfo_C={troubleShootingInfoID}/OnsiteTroubleShootingTask_C={taskID}/uploadTroubleShootingResult:
    parameters: 
    - $ref: ''#/components/parameters/troubleShootingInfoID''
    - $ref: ''#/components/parameters/taskID''
    
    post:
      tags:
        - OnsiteTroubleShooting-TSMS
      summary: upload the troubleshooting result to the TSMS
      operationId: uploadTroubleShootingResult
      requestBody:
        description: the content of troubleShooting result needs to be uploaded to the TSMS          
        content:
          application/json:
            schema:
              type: object  
              properties:
                SMAT_ID:
                  type: string
                troubleShootingExecutor:
                  type: string
                status:
                  type: string
                  enum:
                    - normal
                    - abnormal
                    - notCheck
                timeInfo:
                  type: string
                orderID:  
                  type: string 
                troubleTypeID:
                  type: string 
                  format: uri
                troubleshootingResult:  
                  type: string
        required: true               
      responses:
        200:
          description: "The trouble shooting result record information is successfully received by the TSMS"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/OpStatusType''
        400:
          description: "Input parameters invalid"
          content: {}
        404:
          description: "troubleShooting Info ID or SMAT ID cannot be found in the TSMS"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/InfoNotExist''
        500:
          description: "Internal Server Error"
          content: {}

  /OnsiteTroubleShootingInfo_C={troubleShootingInfoID}/OnsiteTroubleShootingTask_C={taskID}/requestForRemoteAssistance:
    parameters: 
    - $ref: ''#/components/parameters/troubleShootingInfoID''
    - $ref: ''#/components/parameters/taskID''
    - $ref: ''#/components/parameters/SMAT_ID''
    - $ref: ''#/components/parameters/requestDes''
    
    get:
      tags:
        - OnsiteTroubleShooting-TSMS
      summary: request remote assistance from the TSMS for a troubleshooting task
      operationId: requestForTroubleShootingRemoteAssis
      responses:
        201:
          description: "The remote assistance information is successfully received by the TSMS"
          content:
            application/json:
              schema:
                type: object
                properties:
                  opStatus:
                    $ref: ''#/components/schemas/OpStatusType''
                  expertInfoList:
                    type: array
                    items:
                      $ref: ''M.3164.3-Common.yaml#/components/schemas/Expert_C''
                  assistanceLink:
                    type: string
        400:
          description: "Input parameters invalid"
          content: {}
        404:
          description: "Patrol info ID or SMAT ID cannot be found in the TSMS"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/InfoNotExist''
        500:
          description: "Internal Server Error"
          content: {}

  /ServiceActivationInfo_C={serviceActInfoID}/ServiceActivationTask_C={taskID}/ServiceActivationRecord_C:
    parameters: 
    - $ref: ''#/components/parameters/serviceActInfoID''
    - $ref: ''#/components/parameters/taskID''

    post:
      tags:
        - ServiceActivation-TSMS
      summary: upload a service activation record to the TSMS
      operationId: uploadServiceActivationRecord
      requestBody:
        description: the content of service activation record needs to be uploaded to the TSMS
        content:
          application/json:
            schema:
              type: object  
              properties:
                SMAT_ID:
                  type: string
                serviceActivationRecord:
                  type: array
                  items:
                    $ref: ''M.3164.3-Common.yaml#/components/schemas/ServiceActivationRecord_C''
        required: true                     
      responses:
        200:
          description: "The service activation record information is successfully received by the TSMS"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/OpStatusType''
        400:
          description: "Input parameters invalid"
          content: {}
        404:
          description: "Patrol info ID or SMAT ID cannot be found in the TSMS"
          content:
            application/json:
              schema:
                $ref: ''#/components/schemas/InfoNotExist''
        500:
          description: "Internal Server Error"
          content: {}
                    
components:
  schemas:                       
    OpStatusType:
      type: object
      properties:
        opStatus:
          type: string
          enum:
            - successful
            - failed
                       
    ObjectImageListType:
      type: array
      items:
        $ref: ''#/components/schemas/ObjectImageType''
      
    ObjectImageType:
      type: object
      properties:
        objectID:
          type: string
        image:
          type: string 
          format: byte
    
    InfoNotExist:
      type: object
      properties:
        code:
          type: string
          enum:
            - no_info_ID
            - no_SMAT_ID
            - no_task_ID                     
  
  parameters: 
    patrolInfoID:
      name: patrolInfoID
      in: path
      description: ID of the on-site patrol task information
      required: true
      schema:
       type: string
    
    taskID:
      name: taskID
      in: path
      description: ID of an on-site patrol task, or an on-site overhaul task, or an on-site troubleshooting task, or a service activation task
      required: true
      schema:
       type: string
    
    SMAT_ID:
      name: SMAT_ID
      in: query
      description: ID of the designated SMAT
      required: true
      schema:
       type: string    
     
    overhaulInfoID:
      name: overhaulInfoID
      in: path
      description: ID of the on-site overhaul maintenance job information
      required: true
      schema:
       type: string    

    requestDes:
      name: requestDes
      in: query
      description: text description of the request
      required: true
      schema:
       type: string   
         
    troubleShootingInfoID:
      name: troubleShootingInfoID
      in: path
      description: ID of the on-site troubleshooting task information
      required: true
      schema:
       type: string    
     
    serviceActInfoID:
      name: serviceActInfoID
      in: path
      description: ID of the service activation job information
      required: true
      schema:
       type: string