swagger: '2.0' info: title: Customer Management description: >- This is Swagger UI environment generated for the TMF Customer Management specification version: '4.0' host: api.ooredoo.ps basePath: /tmf-api/customerManagement/v1/ schemes: - https consumes: - application/json produces: - application/json;charset=utf-8 security: - Oauth: [] tags: - name: customer parameters: transactionId: name: transactionId description: Transaction Id should be, an string value in: header type: string required: true applicationCode: name: applicationCode in: header type: string required: true applicationUserName: name: applicationUserName in: header type: string required: true paths: /customer/mnpMSISDNAndStockInquiry/{id}: get: operationId: MNPMSISDNAndStockInquiry summary: MNPMSISDNAndStockInquiry by ID (Extented Non TMF Done based on client need ) description: >- This operation retrieves a Customer entity. Attribute selection is enabled for all first level attributes. tags: - customer parameters: - name: id description: Identifier of the MNP MSISDN required: true type: string in: path - name: simSerial description: simSerial required: false type: string in: query - $ref: '#/parameters/transactionId' - $ref: '#/parameters/applicationCode' - $ref: '#/parameters/applicationUserName' responses: '200': description: Success schema: $ref: '#/definitions/Customer' headers: transactionId: description: Transaction Id should be, an string value type: string tranStatus: description: tranStatus type: string '400': description: Bad Request schema: $ref: '#/definitions/Error' '401': description: Unauthorized schema: $ref: '#/definitions/Error' '403': description: Forbidden schema: $ref: '#/definitions/Error' '404': description: Not Found schema: $ref: '#/definitions/Error' '405': description: Method Not allowed schema: $ref: '#/definitions/Error' '409': description: Conflict schema: $ref: '#/definitions/Error' '500': description: Internal Server Error schema: $ref: '#/definitions/Error' securityDefinitions: Oauth: type: "oauth2" tokenUrl: "https://api.ooredoo.ps/tmf-api/oauth/token" flow: "application" definitions: Any: {} Customer: type: object properties: href: type: string description: Url used to reference the customer. exists: type: string description: exists. cugName: {} Error: description: >- Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx) type: object required: - code - reason properties: code: type: string description: Application relevant detail, defined in the API or a common list. reason: type: string description: >- Explanation of the reason for the error which can be shown to a client user. message: type: string description: >- More details and corrective actions related to the error which can be shown to a client user. status: type: string description: HTTP Error code extension referenceError: type: string format: uri description: URI of documentation describing the error. '@baseType': type: string description: When sub-classing, this defines the super-class. '@schemaLocation': type: string format: uri description: >- A URI to a JSON-Schema file that defines additional attributes and relationships '@type': type: string description: When sub-classing, this defines the sub-class entity name.