---
swagger: "2.0"
info:
  description: "The mobile info API provides network related data."
  version: "0.1"
  title: Mobile Customer Information API
host: api.host.com
schemes:
- https
consumes:
- application/json
produces:
- application/json
securityDefinitions:
  OAuth2:
    type: oauth2
    flow: application
    tokenUrl: "https://staging.api.chenosis.io/client-credentials/accesstoken?grant_type=client_credentials"
    scopes:
      GET-SIMSWAP-DATE: Grants read access for carrier sim-swap data.
security:
  - OAuth2: []
paths:
  /mobile/subscriber/{phoneNumber}/simswap-date:
    get:
      tags:
      - Customer Mobile Carrier Data
      summary: "Retrieve sim-sap date."
      description: "Retrieve last sim-sap date from network operator of subscriber as identified by phoneNumber. "
      parameters:
      - name: phoneNumber
        in: path
        description: "ID of the subscriber is the MSISDN of the subscriber represented as International  ITU-T E.164."
        required: true
        type: string
        x-example: "27123456789"

      responses:
        200:
          description: Success
          schema:
            $ref: "#/definitions/simswapResponse"
        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 No Allowed
          schema:
            $ref: "#/definitions/Error"
        406:
          description: Not acceptable
          schema:
            $ref: "#/definitions/Error"
        500:
          description: Internal Server Error
          schema:
            $ref: "#/definitions/Error"

definitions:
  simswapResponse:
    type: object
    required:
      - statusCode
      - statusMessage
      - phoneNumber
      - data
    properties:
      statusCode:
        type: string
        description: HTTP error code extension
        example: 0
      statusMessage:
        type: string
        description: Message.
        example: "Successful"
      phoneNumber:
        type: string
        example: 27123456789
        description: phoneNumber provided in the input
      data:
        $ref: "#/definitions/simswapData"
      transactionId:
        type: string
        description: transaction ID for tracing.

  simswapData:
    type: object
    properties:
      lastSimSwapDate:
        type: string
        example: "2020-04-20"
        description: "The date when the last sim swap performed on the SIM of the phoneNumber provided represented as an ISO 8601:2004 [ISO8601 2004] YYYY-MM-DD format. If the date cannot be determined, the value will be an empty string"

  Error:
    type: object
    properties:
      statusCode:
        type: integer
        description: HTTP error code extension
      statusMessage:
        type: string
        description: More details and corrective actions related to the error which can be shown to a client.
      SupportMessage:
        type: string
        description: Support Message